Merge "Revert "merged master"" into Wikidata

[lhc/web/wiklou.git] / languages / classes / LanguageHe.php

diff --git a/languages/classes/LanguageHe.php b/languages/classes/LanguageHe.php
index 59b7633..22be1de 100644 (file)
--- a/languages/classes/LanguageHe.php
+++ b/languages/classes/LanguageHe.php
@@ -1,74 +1,90 @@
 <?php
 /**
- * Hebrew (עברית)
+ * Hebrew (עברית) specific code.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
  *
- * @addtogroup Language
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author Rotem Liss
+ * @ingroup Language
  */
 
+/**
+ * Hebrew (עברית)
+ *
+ * @ingroup Language
+ */
 class LanguageHe extends Language {
+
        /**
         * Convert grammar forms of words.
         *
         * Available cases:
         * "prefixed" (or "תחילית") - when the word has a prefix
         *
-        * @param string the word to convert
-        * @param string the case
+        * @param $word String: the word to convert
+        * @param $case String: the case
+        *
+        * @return string
         */
        public function convertGrammar( $word, $case ) {
                global $wgGrammarForms;
-               if ( isset($wgGrammarForms['he'][$case][$word]) ) {
+               if ( isset( $wgGrammarForms['he'][$case][$word] ) ) {
                        return $wgGrammarForms['he'][$case][$word];
                }
-               
+
                switch ( $case ) {
                        case 'prefixed':
                        case 'תחילית':
                                # Duplicate the "Waw" if prefixed
                                if ( substr( $word, 0, 2 ) == "ו" && substr( $word, 0, 4 ) != "וו" ) {
-                                       $word = "ו".$word;
+                                       $word = "ו" . $word;
                                }
-                               
+
                                # Remove the "He" if prefixed
                                if ( substr( $word, 0, 2 ) == "ה" ) {
                                        $word = substr( $word, 2 );
                                }
-                               
-                               # Add a hyphen if non-Hebrew letters
+
+                               # Add a hyphen (maqaf) if non-Hebrew letters
                                if ( substr( $word, 0, 2 ) < "א" || substr( $word, 0, 2 ) > "ת" ) {
-                                       $word = "־".$word;
+                                       $word = "־" . $word;
                                }
                }
-               
+
                return $word;
        }
-       
+
        /**
         * Gets a number and uses the suited form of the word.
         *
-        * @param integer the number of items
-        * @param string the first form (singular)
-        * @param string the second form (plural)
-        * @param string the third form (2 items, plural is used if not applicable and not specified
-        * @param not used (for compatibility with ancestor)
-        * @param not used (for compatibility with ancestor)
-        *
-        * @return string of the suited form of word
+        * @param $count Integer: the number of items
+        * @param $forms Array with 3 items: the three plural forms
+        * @return String: the suited form of word
         */
        function convertPlural( $count, $forms ) {
-               if ( !count($forms) ) { return ''; }
+               if ( !count( $forms ) ) { return ''; }
                $forms = $this->preConvertPlural( $forms, 3 );
 
-               if ( $count == '1' ) {
-                       return $forms[0];
-               } elseif ( $count == '2' && isset($forms[2]) ) {
-                       return $forms[2];
+               if ( $count == 1 ) {
+                       return $forms[0]; // Singular
+               } elseif ( $count == 2 ) {
+                       return $forms[2]; // Dual or plural if dual is not provided (filled in preConvertPlural)
                } else {
-                       return $forms[1];
+                       return $forms[1]; // Plural
                }
        }
 }
-
-