WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / pomo / po.php
index fb0d8e408c6fce3bc73b9fd145455b6d128f1dff..381977c5cfd7525c88f3f36505d635881dca72a3 100644 (file)
@@ -2,7 +2,7 @@
 /**
  * Class for working with PO files
  *
- * @version $Id: po.php 283 2009-09-23 16:21:51Z nbachiyski $
+ * @version $Id: po.php 718 2012-10-31 00:32:02Z nbachiyski $
  * @package pomo
  * @subpackage po
  */
@@ -18,7 +18,8 @@ ini_set('auto_detect_line_endings', 1);
  */
 if ( !class_exists( 'PO' ) ):
 class PO extends Gettext_Translations {
-       
+
+       var $comments_before_headers = '';
 
        /**
         * Exports headers to a PO entry
@@ -31,7 +32,11 @@ class PO extends Gettext_Translations {
                        $header_string.= "$header: $value\n";
                }
                $poified = PO::poify($header_string);
-               return rtrim("msgid \"\"\nmsgstr $poified");
+               if ($this->comments_before_headers)
+                       $before_headers = $this->prepend_each_line(rtrim($this->comments_before_headers)."\n", '# ');
+               else
+                       $before_headers = '';
+               return rtrim("{$before_headers}msgid \"\"\nmsgstr $poified");
        }
 
        /**
@@ -76,6 +81,15 @@ class PO extends Gettext_Translations {
                return fclose($fh);
        }
 
+       /**
+        * Text to include as a comment before the start of the PO contents
+        *
+        * Doesn't need to include # in the beginning of lines, these are added automatically
+        */
+       function set_comment_before_headers( $text ) {
+               $this->comments_before_headers = $text;
+       }
+
        /**
         * Formats a string in PO-style
         *
@@ -106,10 +120,10 @@ class PO extends Gettext_Translations {
                $po = str_replace("$newline$quote$quote", '', $po);
                return $po;
        }
-       
+
        /**
         * Gives back the original string from a PO-formatted string
-        * 
+        *
         * @static
         * @param string $string PO-formatted string
         * @return string enascaped string
@@ -139,7 +153,7 @@ class PO extends Gettext_Translations {
        }
 
        /**
-        * Inserts $with in the beginning of every new line of $string and 
+        * Inserts $with in the beginning of every new line of $string and
         * returns the modified string
         *
         * @static
@@ -175,8 +189,8 @@ class PO extends Gettext_Translations {
         * Builds a string from the entry for inclusion in PO file
         *
         * @static
-        * @param object &$entry the entry to convert to po string
-        * @return string|bool PO-style formatted string for the entry or
+        * @param Translation_Entry &$entry the entry to convert to po string
+        * @return false|string PO-style formatted string for the entry or
         *      false if the entry is empty
         */
        function export_entry(&$entry) {
@@ -201,6 +215,10 @@ class PO extends Gettext_Translations {
                return implode("\n", $po);
        }
 
+       /**
+        * @param string $filename
+        * @return boolean
+        */
        function import_from_file($filename) {
                $f = fopen($filename, 'r');
                if (!$f) return false;
@@ -215,9 +233,20 @@ class PO extends Gettext_Translations {
                        }
                }
                PO::read_line($f, 'clear');
-               return $res !== false;
+               if ( false === $res ) {
+                       return false;
+               }
+               if ( ! $this->headers && ! $this->entries ) {
+                       return false;
+               }
+               return true;
        }
-       
+
+       /**
+        * @param resource $f
+        * @param int      $lineno
+        * @return null|false|array
+        */
        function read_entry($f, $lineno = 0) {
                $entry = new Translation_Entry();
                // where were we in the last step
@@ -254,7 +283,7 @@ class PO extends Gettext_Translations {
                                        return false;
                                }
                                // add comment
-                               $this->add_comment_to_entry($entry, $line);;
+                               $this->add_comment_to_entry($entry, $line);
                        } elseif (preg_match('/^msgctxt\s+(".*")/', $line, $m)) {
                                if ($is_final($context)) {
                                        PO::read_line($f, 'put-back');
@@ -322,7 +351,15 @@ class PO extends Gettext_Translations {
                }
                return array('entry' => $entry, 'lineno' => $lineno);
        }
-       
+
+       /**
+        * @staticvar string   $last_line
+        * @staticvar boolean  $use_last_line
+        * 
+        * @param     resource $f
+        * @param     string   $action
+        * @return boolean
+        */
        function read_line($f, $action = 'read') {
                static $last_line = '';
                static $use_last_line = false;
@@ -335,11 +372,16 @@ class PO extends Gettext_Translations {
                        return true;
                }
                $line = $use_last_line? $last_line : fgets($f);
+               $line = ( "\r\n" == substr( $line, -2 ) ) ? rtrim( $line, "\r\n" ) . "\n" : $line;
                $last_line = $line;
                $use_last_line = false;
                return $line;
        }
-       
+
+       /**
+        * @param Translation_Entry $entry
+        * @param string            $po_comment_line
+        */
        function add_comment_to_entry(&$entry, $po_comment_line) {
                $first_two = substr($po_comment_line, 0, 2);
                $comment = trim(substr($po_comment_line, 2));
@@ -353,11 +395,15 @@ class PO extends Gettext_Translations {
                        $entry->translator_comments = trim($entry->translator_comments . "\n" . $comment);
                }
        }
-       
+
+       /**
+        * @param string $s
+        * @return sring
+        */
        function trim_quotes($s) {
                if ( substr($s, 0, 1) == '"') $s = substr($s, 1);
                if ( substr($s, -1, 1) == '"') $s = substr($s, 0, -1);
                return $s;
        }
 }
-endif;
\ No newline at end of file
+endif;