enmi-conf.org: comparison wp/wp-includes/pomo/po.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 * @version $Id: po.php 1158 2015-11-20 04:31:23Z dd32 $
 * @package pomo
 * @subpackage po
 */
-require_once dirname( __FILE__ ) . '/translations.php';
+require_once __DIR__ . '/translations.php';
 if ( ! defined( 'PO_MAX_LINE_LEN' ) ) {
 	define( 'PO_MAX_LINE_LEN', 79 );
 }
 		 * Exports all entries to PO format
 		 *
 		 * @return string sequence of mgsgid/msgstr PO strings, doesn't containt newline at the end
 		 */
 		function export_entries() {
-			//TODO sorting
+			// TODO: Sorting.
 			return implode( "\n\n", array_map( array( 'PO', 'export_entry' ), $this->entries ) );
 		}
 		/**
 		 * Exports the whole PO file as a string
 		}
 		/**
 		 * Same as {@link export}, but writes the result to a file
 		 *
-		 * @param string $filename where to write the PO string
+		 * @param string $filename        Where to write the PO string.
-		 * @param bool $include_headers whether to include tje headers in the export
+		 * @param bool   $include_headers Whether to include the headers in the export.
 		 * @return bool true on success, false on error
 		 */
 		function export_to_file( $filename, $include_headers = true ) {
 			$fh = fopen( $filename, 'w' );
 			if ( false === $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
+		 *
+		 * @param string $text Text to include as a comment.
 		 */
 		function set_comment_before_headers( $text ) {
 			$this->comments_before_headers = $text;
 		}
 			);
 			$string = str_replace( array_keys( $replaces ), array_values( $replaces ), $string );
 			$po = $quote . implode( "${slash}n$quote$newline$quote", explode( $newline, $string ) ) . $quote;
-			// add empty string on first line for readbility
+			// Add empty string on first line for readbility.
 			if ( false !== strpos( $string, $newline ) &&
-				( substr_count( $string, $newline ) > 1 || ! ( $newline === substr( $string, -strlen( $newline ) ) ) ) ) {
+				( substr_count( $string, $newline ) > 1 || substr( $string, -strlen( $newline ) ) !== $newline ) ) {
 				$po = "$quote$quote$newline$po";
 			}
-			// remove empty strings
+			// Remove empty strings.
 			$po = str_replace( "$newline$quote$quote", '', $po );
 			return $po;
 		}
 		/**
 			foreach ( $lines as $line ) {
 				preg_match_all( '/./u', $line, $chars );
 				$chars = $chars[0];
 				foreach ( $chars as $char ) {
 					if ( ! $previous_is_backslash ) {
-						if ( '\\' == $char ) {
+						if ( '\\' === $char ) {
 							$previous_is_backslash = true;
 						} else {
 							$unpoified .= $char;
 						}
 					} else {
 						$unpoified            .= isset( $escapes[ $char ] ) ? $escapes[ $char ] : $char;
 					}
 				}
 			}
-			// Standardise the line endings on imported content, technically PO files shouldn't contain \r
+			// Standardise the line endings on imported content, technically PO files shouldn't contain \r.
 			$unpoified = str_replace( array( "\r\n", "\r" ), "\n", $unpoified );
 			return $unpoified;
 		}
 		 */
 		public static function prepend_each_line( $string, $with ) {
 			$lines  = explode( "\n", $string );
 			$append = '';
 			if ( "\n" === substr( $string, -1 ) && '' === end( $lines ) ) {
-				// Last line might be empty because $string was terminated
+				/*
-				// with a newline, remove it from the $lines array,
+				 * Last line might be empty because $string was terminated
-				// we'll restore state by re-terminating the string at the end
+				 * with a newline, remove it from the $lines array,
+				 * we'll restore state by re-terminating the string at the end.
+				 */
 				array_pop( $lines );
 				$append = "\n";
 			}
 			foreach ( $lines as &$line ) {
 				$line = $with . $line;
 		/**
 		 * Builds a string from the entry for inclusion in PO file
 		 *
 		 * @param Translation_Entry $entry the entry to convert to po string (passed by reference).
-		 * @return false|string PO-style formatted string for the entry or
+		 * @return string|false PO-style formatted string for the entry or
 		 *  false if the entry is empty
 		 */
 		public static function export_entry( &$entry ) {
 			if ( null === $entry->singular || '' === $entry->singular ) {
 				return false;
 			while ( true ) {
 				$res = $this->read_entry( $f, $lineno );
 				if ( ! $res ) {
 					break;
 				}
-				if ( $res['entry']->singular == '' ) {
+				if ( '' === $res['entry']->singular ) {
 					$this->set_headers( $this->make_headers( $res['entry']->translations[0] ) );
 				} else {
 					$this->add_entry( $res['entry'] );
 				}
 			}
 		 *
 		 * @param string $context
 		 * @return bool
 		 */
 		protected static function is_final( $context ) {
-			return ( $context === 'msgstr' ) || ( $context === 'msgstr_plural' );
+			return ( 'msgstr' === $context ) || ( 'msgstr_plural' === $context );
 		}
 		/**
 		 * @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
+			// Where were we in the last step.
-			// can be: comment, msgctxt, msgid, msgid_plural, msgstr, msgstr_plural
+			// Can be: comment, msgctxt, msgid, msgid_plural, msgstr, msgstr_plural.
 			$context      = '';
 			$msgstr_index = 0;
 			while ( true ) {
 				$lineno++;
 				$line = PO::read_line( $f );
 				if ( ! $line ) {
 					if ( feof( $f ) ) {
 						if ( self::is_final( $context ) ) {
 							break;
-						} elseif ( ! $context ) { // we haven't read a line and eof came
+						} elseif ( ! $context ) { // We haven't read a line and EOF came.
 							return null;
 						} else {
 							return false;
 						}
 					} else {
 						return false;
 					}
 				}
-				if ( $line == "\n" ) {
+				if ( "\n" === $line ) {
 					continue;
 				}
 				$line = trim( $line );
 				if ( preg_match( '/^#/', $line, $m ) ) {
-					// the comment is the start of a new entry
+					// The comment is the start of a new entry.
 					if ( self::is_final( $context ) ) {
 						PO::read_line( $f, 'put-back' );
 						$lineno--;
 						break;
 					}
-					// comments have to be at the beginning
+					// Comments have to be at the beginning.
-					if ( $context && $context != 'comment' ) {
+					if ( $context && 'comment' !== $context ) {
 						return false;
 					}
-					// add comment
+					// Add comment.
 					$this->add_comment_to_entry( $entry, $line );
 				} elseif ( preg_match( '/^msgctxt\s+(".*")/', $line, $m ) ) {
 					if ( self::is_final( $context ) ) {
 						PO::read_line( $f, 'put-back' );
 						$lineno--;
 						break;
 					}
-					if ( $context && $context != 'comment' ) {
+					if ( $context && 'comment' !== $context ) {
 						return false;
 					}
 					$context         = 'msgctxt';
 					$entry->context .= PO::unpoify( $m[1] );
 				} elseif ( preg_match( '/^msgid\s+(".*")/', $line, $m ) ) {
 					if ( self::is_final( $context ) ) {
 						PO::read_line( $f, 'put-back' );
 						$lineno--;
 						break;
 					}
-					if ( $context && $context != 'msgctxt' && $context != 'comment' ) {
+					if ( $context && 'msgctxt' !== $context && 'comment' !== $context ) {
 						return false;
 					}
 					$context          = 'msgid';
 					$entry->singular .= PO::unpoify( $m[1] );
 				} elseif ( preg_match( '/^msgid_plural\s+(".*")/', $line, $m ) ) {
-					if ( $context != 'msgid' ) {
+					if ( 'msgid' !== $context ) {
 						return false;
 					}
 					$context          = 'msgid_plural';
 					$entry->is_plural = true;
 					$entry->plural   .= PO::unpoify( $m[1] );
 				} elseif ( preg_match( '/^msgstr\s+(".*")/', $line, $m ) ) {
-					if ( $context != 'msgid' ) {
+					if ( 'msgid' !== $context ) {
 						return false;
 					}
 					$context             = 'msgstr';
 					$entry->translations = array( PO::unpoify( $m[1] ) );
 				} elseif ( preg_match( '/^msgstr\[(\d+)\]\s+(".*")/', $line, $m ) ) {
-					if ( $context != 'msgid_plural' && $context != 'msgstr_plural' ) {
+					if ( 'msgid_plural' !== $context && 'msgstr_plural' !== $context ) {
 						return false;
 					}
 					$context                      = 'msgstr_plural';
 					$msgstr_index                 = $m[1];
 					$entry->translations[ $m[1] ] = PO::unpoify( $m[2] );
 				'lineno' => $lineno,
 			);
 		}
 		/**
-		 * @staticvar string   $last_line
+		 * @param resource $f
-		 * @staticvar boolean  $use_last_line
+		 * @param string   $action
-		 *
-		 * @param     resource $f
-		 * @param     string   $action
 		 * @return boolean
 		 */
 		function read_line( $f, $action = 'read' ) {
 			static $last_line     = '';
 			static $use_last_line = false;
-			if ( 'clear' == $action ) {
+			if ( 'clear' === $action ) {
 				$last_line = '';
 				return true;
 			}
-			if ( 'put-back' == $action ) {
+			if ( 'put-back' === $action ) {
 				$use_last_line = true;
 				return true;
 			}
 			$line          = $use_last_line ? $last_line : fgets( $f );
-			$line          = ( "\r\n" == substr( $line, -2 ) ) ? rtrim( $line, "\r\n" ) . "\n" : $line;
+			$line          = ( "\r\n" === substr( $line, -2 ) ) ? rtrim( $line, "\r\n" ) . "\n" : $line;
 			$last_line     = $line;
 			$use_last_line = false;
 			return $line;
 		}
 		 * @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 ) );
-			if ( '#:' == $first_two ) {
+			if ( '#:' === $first_two ) {
 				$entry->references = array_merge( $entry->references, preg_split( '/\s+/', $comment ) );
-			} elseif ( '#.' == $first_two ) {
+			} elseif ( '#.' === $first_two ) {
 				$entry->extracted_comments = trim( $entry->extracted_comments . "\n" . $comment );
-			} elseif ( '#,' == $first_two ) {
+			} elseif ( '#,' === $first_two ) {
 				$entry->flags = array_merge( $entry->flags, preg_split( '/,\s*/', $comment ) );
 			} else {
 				$entry->translator_comments = trim( $entry->translator_comments . "\n" . $comment );
 			}
 		}
 		/**
 		 * @param string $s
-		 * @return sring
+		 * @return string
 		 */
 		public static function trim_quotes( $s ) {
-			if ( substr( $s, 0, 1 ) == '"' ) {
+			if ( '"' === substr( $s, 0, 1 ) ) {
 				$s = substr( $s, 1 );
 			}
-			if ( substr( $s, -1, 1 ) == '"' ) {
+			if ( '"' === substr( $s, -1, 1 ) ) {
 				$s = substr( $s, 0, -1 );
 			}
 			return $s;
 		}
 	}

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a