Methods

Convert a string from defined character encoding to the defined convert encoding

convert(string $str, bool $reverse) : string | false

Parameters

$str

string

$reverse

bool

Returns

stringfalse

Get the defined character encoding to convert to

getConvertEncoding() : string | null

Returns

stringnull

Get the defined character encoding to work with

getEncoding() : string

Exceptions

\Zend\Stdlib\Exception\LogicException If no encoding was defined

Returns

string

Get a list of supported character encodings

getSupportedEncodings() : string[]
Inherited

inherited_from \Zend\Stdlib\StringWrapper\StringWrapperInterface::getSupportedEncodings()

Returns

string[]

Check if the given character encoding is supported by this wrapper and the character encoding to convert to is also supported.

isSupported(string $encoding, string | null $convertEncoding) : bool

Parameters

$encoding

string

$convertEncoding

stringnull

Returns

bool

Set character encoding working with and convert to

setEncoding(string $encoding, string | null $convertEncoding) : \Zend\Stdlib\StringWrapper\StringWrapperInterface

Parameters

$encoding

string

The character encoding to work with

$convertEncoding

stringnull

The character encoding to convert to

Returns

Pad a string to a certain length with another string

strPad(string $input, int $padLength, string $padString, int $padType) : string

Parameters

$input

string

$padLength

int

$padString

string

$padType

int

Returns

string

Returns the length of the given string

strlen(string $str) : int | false
Inherited

inherited_from \Zend\Stdlib\StringWrapper\StringWrapperInterface::strlen()

Parameters

$str

string

Returns

intfalse

Find the position of the first occurrence of a substring in a string

strpos(string $haystack, string $needle, int $offset) : int | false
Inherited

inherited_from \Zend\Stdlib\StringWrapper\StringWrapperInterface::strpos()

Parameters

$haystack

string

$needle

string

$offset

int

Returns

intfalse

Returns the portion of string specified by the start and length parameters

substr(string $str, int $offset, int | null $length) : string | false
Inherited

inherited_from \Zend\Stdlib\StringWrapper\StringWrapperInterface::substr()

Parameters

$str

string

$offset

int

$length

intnull

Returns

stringfalse

Wraps a string to a given number of characters

wordWrap(string $string, int $width, string $break, bool $cut) : string | false

Parameters

$string

string

$width

int

$break

string

$cut

bool

Returns

stringfalse

 Properties

 

An optionally character encoding to convert to

$convertEncoding : string | null

 

The character encoding working on

$encoding : string | null