API Documentation
\

\

Interfaces

NimrodInterface Nimrod interface.
NimrodLoggerInterface NimrodLogger interface.
NimrodParserInterface NimrodParser interface.

Classes

ExtDOMDocument ExtDOMDocument class.
ExtDOMElement ExtDOMElement class.
Nimrod Nimrod class.
NimrodLogger NimrodLogger class.
NimrodParser NimrodParser class.
NimrodPOUtil NimrodPOUtil class.
WP_Nimrod WP_Nimrod class.

Functions

__t()

__t(string  $text, string  $domain)

Translation function wrapper.

Parameters

string $text

The gettext msgid.
string $domain

The gettext domain.

_gt()

_gt(string  $text, string  $domain = 'default')

Decorated gettext function for translation.

Parameters

string $text

The gettext msgid.
string $domain

The gettext domain.

_gx()

_gx(string  $text, string  $context, string  $domain = 'default')

Decorated gettext function for translation with context.

Parameters

string $text

The gettext msgid.
string $context

The gettext msgctxt.
string $domain

The gettext domain.

linkify()

linkify(string  $item, string  $baseurl) : string

Generate a URL from given text item.

Parameters

string $item

The input item.
string $baseurl

Base URL.

Returns

string

pluralize()

pluralize(integer  $count, string  $singular_form, string  $plural_form = NULL) : string

Generate a pluralized form according to the number of items involved in the text.

Parameters

integer $count

Number of items in text.
string $singular_form

Singular form for the text.
string $plural_form

Plural form for the text.

Returns

string

str_endswith()

str_endswith(string  $str, string  $suffix) : boolean

Check if string ends with a given suffix.

Parameters

string $str

The input string.
string $suffix

Matching suffix.

Returns

boolean

str_rmprefix()

str_rmprefix(string  $str, string  $prefix) : string

Remove prefix from string.

Parameters

string $str

The input string.
string $prefix

Matching prefix.

Returns

string

str_startswith()

str_startswith(string  $str, string  $prefix) : boolean

Check if string starts with a given prefix.

Parameters

string $str

The input string.
string $prefix

Matching prefix.

Returns

boolean

substring()

substring(string  $str, integer  $start, integer  $end) : string

Extract characters from a string.

Parameters

string $str

The input string.
integer $start

Starting offset.
integer $end

Ending offset.

Returns

string

tagwrap()

tagwrap(string  $item, string  $tag) : string

Generate custom markup for a given text item according to given tag.

Parameters

string $item

The input item.
string $tag

HTML tag.

Returns

string