WordPress Cross Reference

Class for working with PO files

Version:	$Id: po.php 718 2012-10-31 00:32:02Z nbachiyski $
File Size:	384 lines (11 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

PO:: (15 methods):
  export_headers()
  export_entries()
  export()
  export_to_file()
  set_comment_before_headers()
  poify()
  unpoify()
  prepend_each_line()
  comment_block()
  export_entry()
  import_from_file()
  read_entry()
  read_line()
  add_comment_to_entry()
  trim_quotes()

Class: PO - X-Ref

Routines for working with PO files

export_headers() X-Ref

Exports headers to a PO entry

return: string msgid/msgstr PO entry for this PO file headers, doesn't contain newline at the end

export_entries() X-Ref

Exports all entries to PO format

return: string sequence of mgsgid/msgstr PO strings, doesn't containt newline at the end

export($include_headers = true) X-Ref

Exports the whole PO file as a string

param: bool $include_headers whether to include the headers in the export
return: string ready for inclusion in PO file string for headers and all the enrtries

export_to_file($filename, $include_headers = true) X-Ref

Same as {@link export}, but writes the result to a file

param: string $filename where to write the PO string
param: bool $include_headers whether to include tje headers in the export
return: bool true on success, false on error

set_comment_before_headers( $text ) X-Ref

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

poify($string) X-Ref

Formats a string in PO-style

param: string $string the string to format
return: string the poified string

unpoify($string) X-Ref

Gives back the original string from a PO-formatted string

param: string $string PO-formatted string
return: string enascaped string

prepend_each_line($string, $with) X-Ref

Inserts $with in the beginning of every new line of $string and
returns the modified string

param: string $string prepend lines in this string
param: string $with prepend lines with this string

comment_block($text, $char=' ') X-Ref

Prepare a text as a comment -- wraps the lines and prepends #
and a special character to each line

param: string $text the comment text
param: string $char character to denote a special PO comment,

export_entry(&$entry) X-Ref

Builds a string from the entry for inclusion in PO file

param: object &$entry the entry to convert to po string
return: string|bool PO-style formatted string for the entry or

import_from_file($filename) X-Ref

No description

read_entry($f, $lineno = 0) X-Ref

No description

read_line($f, $action = 'read') X-Ref

No description

add_comment_to_entry(&$entry, $po_comment_line) X-Ref

No description

trim_quotes($s) X-Ref

No description

/wp-includes/pomo/ -> po.php (summary)

Defines 1 class