summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2013-12-03 16:29:16 (GMT)
committerJennifer Hodgdon2013-12-04 00:43:32 (GMT)
commita70ccf5a93efe144b1bd4b9b4d3a82e7c49e1253 (patch)
tree9ef4053a6f1c6123a07b0ba459f746f5933eb134
parentdff4856ede9da1287a6788ecd2397a71992aedf5 (diff)
Issue #2035007 by speely, YesCT, penyaskito: Add docs to Language class properties
-rw-r--r--core/lib/Drupal/Core/Language/Language.php51
1 files changed, 51 insertions, 0 deletions
diff --git a/core/lib/Drupal/Core/Language/Language.php b/core/lib/Drupal/Core/Language/Language.php
index e6709b6..1836933 100644
--- a/core/lib/Drupal/Core/Language/Language.php
+++ b/core/lib/Drupal/Core/Language/Language.php
@@ -17,13 +17,64 @@ namespace Drupal\Core\Language;
* @see language_default()
*/
class Language {
+
// Properties within the Language are set up as the default language.
+
+ /**
+ * The human readable English name.
+ *
+ * @var string
+ */
public $name = '';
+
+ /**
+ * The ID, langcode.
+ *
+ * @var string
+ */
public $id = '';
+
+ /**
+ * The direction, left-to-right, or right-to-left.
+ *
+ * Defined using constants, either DIRECTION_LTR or const DIRECTION_RTL.
+ *
+ * @var int
+ */
public $direction = Language::DIRECTION_LTR;
+
+ /**
+ * The weight, used for ordering languages in lists, like selects or tables.
+ *
+ * @var int
+ */
public $weight = 0;
+
+ /**
+ * Flag indicating if this is the only site default language.
+ *
+ * @var bool
+ */
public $default = FALSE;
+
+ /**
+ * The language negotiation method used when a language was detected.
+ *
+ * @var bool
+ *
+ * @see language_types_initialize()
+ */
public $method_id = NULL;
+
+ /**
+ * Locked indicates a language used by the system, not an actual language.
+ *
+ * Examples of locked languages are, LANGCODE_NOT_SPECIFIED, und, and
+ * LANGCODE_NOT_APPLICABLE, zxx, which are usually shown in language selects
+ * but hidden in places like the Language configuration and cannot be deleted.
+ *
+ * @var bool
+ */
public $locked = FALSE;
/**