Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Language;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a language.
Chris@0:  */
Chris@0: interface LanguageInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Special system language code (only applicable to UI language).
Chris@0:    *
Chris@0:    * Refers to the language used in Drupal and module/theme source code. Drupal
Chris@0:    * uses the built-in text for English by default, but if configured to allow
Chris@0:    * translation/customization of English, we need to differentiate between the
Chris@0:    * built-in language and the English translation.
Chris@0:    */
Chris@0:   const LANGCODE_SYSTEM = 'system';
Chris@0: 
Chris@0:   /**
Chris@0:    * The language code used when no language is explicitly assigned (yet).
Chris@0:    *
Chris@0:    * Should be used when language information is not available or cannot be
Chris@0:    * determined. This special language code is useful when we know the data
Chris@0:    * might have linguistic information, but we don't know the language.
Chris@0:    *
Chris@0:    * See http://www.w3.org/International/questions/qa-no-language#undetermined.
Chris@0:    */
Chris@0:   const LANGCODE_NOT_SPECIFIED = 'und';
Chris@0: 
Chris@0:   /**
Chris@0:    * The language code used when the marked object has no linguistic content.
Chris@0:    *
Chris@0:    * Should be used when we explicitly know that the data referred has no
Chris@0:    * linguistic content.
Chris@0:    *
Chris@0:    * See http://www.w3.org/International/questions/qa-no-language#nonlinguistic.
Chris@0:    */
Chris@0:   const LANGCODE_NOT_APPLICABLE = 'zxx';
Chris@0: 
Chris@0:   /**
Chris@0:    * Language code referring to the default language of data, e.g. of an entity.
Chris@0:    *
Chris@0:    * See the BCP 47 syntax for defining private language tags:
Chris@0:    * http://www.rfc-editor.org/rfc/bcp/bcp47.txt
Chris@0:    */
Chris@0:   const LANGCODE_DEFAULT = 'x-default';
Chris@0: 
Chris@0:   /**
Chris@0:    * Language code referring to site's default language.
Chris@0:    */
Chris@0:   const LANGCODE_SITE_DEFAULT = 'site_default';
Chris@0: 
Chris@0:   /**
Chris@0:    * The language state when referring to configurable languages.
Chris@0:    */
Chris@0:   const STATE_CONFIGURABLE = 1;
Chris@0: 
Chris@0:   /**
Chris@0:    * The language state when referring to locked languages.
Chris@0:    */
Chris@0:   const STATE_LOCKED = 2;
Chris@0: 
Chris@0:   /**
Chris@0:    * The language state used when referring to all languages.
Chris@0:    */
Chris@0:   const STATE_ALL = 3;
Chris@0: 
Chris@0:   /**
Chris@0:    * The language state used when referring to the site's default language.
Chris@0:    */
Chris@0:   const STATE_SITE_DEFAULT = 4;
Chris@0: 
Chris@0:   /**
Chris@0:    * The type of language used to define the content language.
Chris@0:    */
Chris@0:   const TYPE_CONTENT = 'language_content';
Chris@0: 
Chris@0:   /**
Chris@0:    * The type of language used to select the user interface.
Chris@0:    */
Chris@0:   const TYPE_INTERFACE = 'language_interface';
Chris@0: 
Chris@0:   /**
Chris@0:    * The type of language used for URLs.
Chris@0:    */
Chris@0:   const TYPE_URL = 'language_url';
Chris@0: 
Chris@0:   /**
Chris@0:    * Language written left to right. Possible value of $language->direction.
Chris@0:    */
Chris@0:   const DIRECTION_LTR = 'ltr';
Chris@0: 
Chris@0:   /**
Chris@0:    * Language written right to left. Possible value of $language->direction.
Chris@0:    */
Chris@0:   const DIRECTION_RTL = 'rtl';
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the name of the language.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The human-readable name of the language (in the language that was
Chris@0:    *   used to construct this object).
Chris@0:    */
Chris@0:   public function getName();
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the ID (language code).
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The language code.
Chris@0:    */
Chris@0:   public function getId();
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the text direction (left-to-right or right-to-left).
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   Either self::DIRECTION_LTR or self::DIRECTION_RTL.
Chris@0:    */
Chris@0:   public function getDirection();
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the weight of the language.
Chris@0:    *
Chris@0:    * @return int
Chris@0:    *   The weight, used to order languages with larger positive weights sinking
Chris@0:    *   items toward the bottom of lists.
Chris@0:    */
Chris@0:   public function getWeight();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns whether this language is the default language.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   Whether the language is the default language.
Chris@0:    */
Chris@0:   public function isDefault();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns whether this language is locked.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   Whether the language is locked or not.
Chris@0:    */
Chris@0:   public function isLocked();
Chris@0: 
Chris@0: }