Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Language/LanguageInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Language\LanguageInterface.
6	*/
7
8	namespace Drupal\Core\Language;
9
10	/**
11	* Defines a language.
12	*/
13	interface LanguageInterface {
14
15	/**
16	* Special system language code (only applicable to UI language).
17	*
18	* Refers to the language used in Drupal and module/theme source code. Drupal
19	* uses the built-in text for English by default, but if configured to allow
20	* translation/customization of English, we need to differentiate between the
21	* built-in language and the English translation.
22	*/
23	const LANGCODE_SYSTEM = 'system';
24
25	/**
26	* The language code used when no language is explicitly assigned (yet).
27	*
28	* Should be used when language information is not available or cannot be
29	* determined. This special language code is useful when we know the data
30	* might have linguistic information, but we don't know the language.
31	*
32	* See http://www.w3.org/International/questions/qa-no-language#undetermined.
33	*/
34	const LANGCODE_NOT_SPECIFIED = 'und';
35
36	/**
37	* The language code used when the marked object has no linguistic content.
38	*
39	* Should be used when we explicitly know that the data referred has no
40	* linguistic content.
41	*
42	* See http://www.w3.org/International/questions/qa-no-language#nonlinguistic.
43	*/
44	const LANGCODE_NOT_APPLICABLE = 'zxx';
45
46	/**
47	* Language code referring to the default language of data, e.g. of an entity.
48	*
49	* See the BCP 47 syntax for defining private language tags:
50	* http://www.rfc-editor.org/rfc/bcp/bcp47.txt
51	*/
52	const LANGCODE_DEFAULT = 'x-default';
53
54	/**
55	* Language code referring to site's default language.
56	*/
57	const LANGCODE_SITE_DEFAULT = 'site_default';
58
59	/**
60	* The language state when referring to configurable languages.
61	*/
62	const STATE_CONFIGURABLE = 1;
63
64	/**
65	* The language state when referring to locked languages.
66	*/
67	const STATE_LOCKED = 2;
68
69	/**
70	* The language state used when referring to all languages.
71	*/
72	const STATE_ALL = 3;
73
74	/**
75	* The language state used when referring to the site's default language.
76	*/
77	const STATE_SITE_DEFAULT = 4;
78
79	/**
80	* The type of language used to define the content language.
81	*/
82	const TYPE_CONTENT = 'language_content';
83
84	/**
85	* The type of language used to select the user interface.
86	*/
87	const TYPE_INTERFACE = 'language_interface';
88
89	/**
90	* The type of language used for URLs.
91	*/
92	const TYPE_URL = 'language_url';
93
94	/**
95	* Language written left to right. Possible value of $language->direction.
96	*/
97	const DIRECTION_LTR = 'ltr';
98
99	/**
100	* Language written right to left. Possible value of $language->direction.
101	*/
102	const DIRECTION_RTL = 'rtl';
103
104	/**
105	* Gets the name of the language.
106	*
107	* @return string
108	* The human-readable name of the language (in the language that was
109	* used to construct this object).
110	*/
111	public function getName();
112
113	/**
114	* Gets the ID (language code).
115	*
116	* @return string
117	* The language code.
118	*/
119	public function getId();
120
121	/**
122	* Gets the text direction (left-to-right or right-to-left).
123	*
124	* @return string
125	* Either self::DIRECTION_LTR or self::DIRECTION_RTL.
126	*/
127	public function getDirection();
128
129	/**
130	* Gets the weight of the language.
131	*
132	* @return int
133	* The weight, used to order languages with larger positive weights sinking
134	* items toward the bottom of lists.
135	*/
136	public function getWeight();
137
138	/**
139	* Returns whether this language is the default language.
140	*
141	* @return bool
142	* Whether the language is the default language.
143	*/
144	public function isDefault();
145
146	/**
147	* Returns whether this language is locked.
148	*
149	* @return bool
150	* Whether the language is locked or not.
151	*/
152	public function isLocked();
153
154	}