PoFile - represent all entries in a GNU gettext style PO or POT file as a collection of PoHeader and PoEntry objects.
$unrecognizedInput
$var array() $unrecognizedInput
If any lines that cannot be processed are found when reading a po file, the unrecognized input will be recorded here, and an exception will be thrown. No interface is supplied, but this debug data is an array in the form: line number => input line
$header : \Geekwright\Po\PoHeader
$entries : \Geekwright\Po\PoEntry[]
$unkeyedEntries : \Geekwright\Po\PoEntry[]
__construct(\Geekwright\Po\PoHeader|null $header = null, \Geekwright\Po\PoEntry[] $entries = array(), \Geekwright\Po\PoEntry[] $unkeyedEntries = array()) : mixed
Build a PoFile, empty or with provided entries
| \Geekwright\Po\PoHeader|null | $header | header object |
| \Geekwright\Po\PoEntry[] | $entries | associative array po entries |
| \Geekwright\Po\PoEntry[] | $unkeyedEntries | indexed array of po entries. Unkeyed entries are usually comment only entries, such as for obsolete entries. |
createKey(string|null $msgid, string|null $msgctxt = null, string|null $msgid_plural = null) : string
Build the internal entries array key from id, context and plural id
| string|null | $msgid | the untranslated message of the entry |
| string|null | $msgctxt | the context of the entry, if any |
| string|null | $msgid_plural | the untranslated plural message of the entry, if any |
addEntry(\Geekwright\Po\PoEntry $entry, bool $replace = true) : bool
Add an entry to the PoFile using internal key
| \Geekwright\Po\PoEntry | $entry | the PoEntry to add |
| bool | $replace | true to replace any existing entry matching this key, false to not change the PoFile for a duplicated key |
true if added, false if not
mergeEntry(\Geekwright\Po\PoEntry $newEntry) : bool
Merge an entry with any existing entry with the same key. If the key does not exist, add the entry, otherwise merge comments, references, and flags.
This is intended for use in building a POT, where the handling of translated strings is not a factor.
| \Geekwright\Po\PoEntry | $newEntry | the PoEntry to merge |
true if merged or added, false if not
findEntry(string $msgid, string|null $msgctxt = null, string|null $msgid_plural = null) : \Geekwright\Po\PoEntry|null
Get an entry based on key values - msgid, msgctxt and msgid_plural
| string | $msgid | the untranslated message of the entry |
| string|null | $msgctxt | the context of the entry, if any |
| string|null | $msgid_plural | the untranslated plural message of the entry, if any |
matching entry, or null if not found
removeEntry(\Geekwright\Po\PoEntry $entry) : bool
Remove an entry from the PoFile
In simple cases, the entry can be found by key. There are several cases where it is not that easy to locate the PoEntry to be removed:
In any of these cases, we must loop thru the entry arrays looking for an exact object match, so the cost of the remove goes up
| \Geekwright\Po\PoEntry | $entry | the PoEntry to merge |
true if remove, false if not