Helper class for string handling. More...

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper:

Public Member Functions
	__construct (string $string)
	replace (array\|string $search, array\|string $replace, bool $caseSensitivity=true)
	arg (array $args, string $char="%")
	startsWith (string $pattern)
	endsWith (string $pattern)
	findFirst (string $needle)
	findLast (string $needle)
	toLower ()
	toUpper ()
	contains (string $pattern, bool $regexp=false)
	substr (int $start, int $length=null)
	split (string $separator, int $limit=0)
	append (string $part)
	prepend (string $part)
	section (string $separator, int $first=0, int $last=0)
	resize (int $size, string $char="\0")
	trim ()
	escape ()
	unescape ()
	filterAlnum ()
	filterAlpha ()
	filterDigits ()
	isInt ()
	toInt ()
	toCrc32 ()
	toMd5 ()
	toSha1 ()
	isUtf8 ()
	toUtf8 ()
	toBase64 ()
	toHex ()
	transliterate ()
	uriSafe (string $spacer="-")
	spaceToPercent ()
	toString ()
	__call (string $function, array $args)
	__toString ()
	jsonSerialize ()
	count ()
	rewind ()
	valid ()
	key ()
	current ()
	next ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)

Static Public Member Functions
static	factory (string $string)
static	fromBase64 (string $base64)
static	fromHex (string $hex)

Protected Attributes
string	$string
int	$position = 0

Detailed Description

Helper class for string handling.

Definition at line 18 of file StringHelper.php.

Constructor & Destructor Documentation

◆ __construct()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::__construct ( string $string )

The StringHelper constructor.

Parameters

string $string

Definition at line 38 of file StringHelper.php.

Member Function Documentation

◆ __call()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::__call	(	string	$function,
		array	$args )

Magical function that allows you to call PHP's built-in string functions on the PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper object.

Parameters

string	$function
array	$args

Returns: self

Exceptions

HelperException

Definition at line 781 of file StringHelper.php.

◆ __toString()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::__toString ( )

Returns the character as a standard string.

Returns: string

Definition at line 813 of file StringHelper.php.

◆ append()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::append ( string $part )

Appends $part to the string.

Parameters

string $part

Returns: self

Definition at line 216 of file StringHelper.php.

◆ arg()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::arg	(	array	$args,
		string	$char = "%" )

This function replaces indexed or associative signs with given values.

Parameters

array	$args
string	$char

Returns: self

Definition at line 80 of file StringHelper.php.

◆ contains()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::contains	(	string	$pattern,
		bool	$regexp = false )

Returns true if the string contains $pattern.

Parameters

string	$pattern
boolean	$regexp

Returns: boolean

Definition at line 165 of file StringHelper.php.

◆ count()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::count ( )

@ignore

Definition at line 831 of file StringHelper.php.

◆ current()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::current ( )

Exceptions

HelperException @ignore

Definition at line 864 of file StringHelper.php.

◆ endsWith()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::endsWith ( string $pattern )

Returns true if the string ends with $pattern.

Parameters

string $pattern

Returns: boolean

Definition at line 111 of file StringHelper.php.

◆ escape()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::escape ( )

Escapes a string using the TeamSpeak 3 escape patterns.

Returns: self

Definition at line 305 of file StringHelper.php.

◆ factory()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::factory ( string $string )

static

Returns a StringHelper object for the given string.

Parameters

string $string

Returns: self

Definition at line 49 of file StringHelper.php.

◆ filterAlnum()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::filterAlnum ( )

Removes any non-alphanumeric characters from the string.

Returns: self

Definition at line 331 of file StringHelper.php.

◆ filterAlpha()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::filterAlpha ( )

Removes any non-alphabetic characters from the string.

Returns: self

Definition at line 343 of file StringHelper.php.

◆ filterDigits()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::filterDigits ( )

Removes any non-numeric characters from the string.

Returns: self

Definition at line 355 of file StringHelper.php.

◆ findFirst()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::findFirst ( string $needle )

Returns the position of the first occurrence of a char in a string.

Parameters

string $needle

Returns: integer

Definition at line 122 of file StringHelper.php.

◆ findLast()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::findLast ( string $needle )

Returns the position of the last occurrence of a char in a string.

Parameters

string $needle

Returns: integer

Definition at line 133 of file StringHelper.php.

◆ fromBase64()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::fromBase64 ( string $base64 )

static

Decodes the string with MIME base64 and returns the result as an PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper

Parameters

string $base64

Returns: self

Definition at line 472 of file StringHelper.php.

◆ fromHex()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::fromHex ( string $hex )

static

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper based on a given hex value.

Parameters

string $hex

Returns: self

Exceptions

HelperException

Definition at line 500 of file StringHelper.php.

◆ isInt()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::isInt ( )

Returns TRUE if the string is a numeric value.

Returns: boolean

Definition at line 367 of file StringHelper.php.

◆ isUtf8()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::isUtf8 ( )

Returns TRUE if the string is UTF-8 encoded. This method searches for non-ascii multibyte sequences in the UTF-8 range.

Returns: boolean

Definition at line 427 of file StringHelper.php.

◆ jsonSerialize()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::jsonSerialize ( )

Return UTF-8 encoded string to for serializing to JSON.

Returns: string

Definition at line 823 of file StringHelper.php.

◆ key()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::key ( )

@ignore

Definition at line 855 of file StringHelper.php.

◆ next()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::next ( )

@ignore

Definition at line 872 of file StringHelper.php.

◆ offsetExists()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::offsetExists ( $offset )

@ignore

Definition at line 880 of file StringHelper.php.

◆ offsetGet()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::offsetGet ( $offset )

Exceptions

HelperException @ignore

Definition at line 889 of file StringHelper.php.

◆ offsetSet()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::offsetSet	(		$offset,
			$value )

@ignore

Definition at line 897 of file StringHelper.php.

◆ offsetUnset()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::offsetUnset ( $offset )

@ignore

Definition at line 909 of file StringHelper.php.

◆ prepend()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::prepend ( string $part )

Prepends $part to the string.

Parameters

string $part

Returns: self

Definition at line 229 of file StringHelper.php.

◆ replace()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::replace	(	array\|string	$search,
		array\|string	$replace,
		bool	$caseSensitivity = true )

Replaces every occurrence of the string or array $search with the string or array $replace.

Parameters

array \| string	$search
array \| string	$replace
boolean	$caseSensitivity

Returns: self

Definition at line 62 of file StringHelper.php.

◆ resize()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::resize	(	int	$size,
		string	$char = "\0" )

Sets the size of the string to $size characters.

Parameters

integer	$size
string	$char

Returns: self

Definition at line 275 of file StringHelper.php.

◆ rewind()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::rewind ( )

@ignore

Definition at line 839 of file StringHelper.php.

◆ section()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::section	(	string	$separator,
		int	$first = 0,
		int	$last = 0 )

Returns a section of the string.

Parameters

string	$separator
integer	$first
integer	$last

Returns: StringHelper|null

Definition at line 244 of file StringHelper.php.

◆ spaceToPercent()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::spaceToPercent ( )

Replaces space characters with percent encoded strings.

Returns: string

Definition at line 758 of file StringHelper.php.

◆ split()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::split	(	string	$separator,
		int	$limit = 0 )

Splits the string into substrings wherever $separator occurs.

Parameters

string	$separator
integer	$limit

Returns: array

Definition at line 199 of file StringHelper.php.

◆ startsWith()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::startsWith ( string $pattern )

Returns true if the string starts with $pattern.

Parameters

string $pattern

Returns: boolean

Definition at line 100 of file StringHelper.php.

◆ substr()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::substr	(	int	$start,
		int	$length = null )

Returns part of a string.

Parameters

integer	$start
integer \| null	$length

Returns: self

Definition at line 185 of file StringHelper.php.

◆ toBase64()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toBase64 ( )

Encodes the string with MIME base64 and returns the result.

Returns: string

Definition at line 461 of file StringHelper.php.

◆ toCrc32()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toCrc32 ( )

Calculates and returns the crc32 polynomial of the string.

Returns: int

Definition at line 396 of file StringHelper.php.

◆ toHex()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toHex ( )

Returns the hexadecimal value of the string.

Returns: string

Definition at line 482 of file StringHelper.php.

◆ toInt()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toInt ( )

Returns the integer value of the string.

Returns: int

Definition at line 382 of file StringHelper.php.

◆ toLower()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toLower ( )

Returns the lowercased string.

Returns: self

Definition at line 143 of file StringHelper.php.

◆ toMd5()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toMd5 ( )

Calculates and returns the md5 checksum of the string.

Returns: string

Definition at line 406 of file StringHelper.php.

◆ toSha1()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toSha1 ( )

Calculates and returns the sha1 checksum of the string.

Returns: string

Definition at line 416 of file StringHelper.php.

◆ toString()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toString ( )

Returns the string as a standard string

Returns: string

Definition at line 768 of file StringHelper.php.

◆ toUpper()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toUpper ( )

Returns the uppercased string.

Returns: self

Definition at line 153 of file StringHelper.php.

◆ toUtf8()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::toUtf8 ( )

Converts the string to UTF-8.

Returns: self

Definition at line 447 of file StringHelper.php.

◆ transliterate()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::transliterate ( )

Returns the string transliterated from UTF-8 to Latin.

Returns: self

Definition at line 520 of file StringHelper.php.

◆ trim()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::trim ( )

Strips whitespaces (or other characters) from the beginning and end of the string.

Returns: self

Definition at line 293 of file StringHelper.php.

◆ unescape()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::unescape ( )

Unescapes a string using the TeamSpeak 3 escape patterns.

Returns: self

Definition at line 319 of file StringHelper.php.

◆ uriSafe()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::uriSafe ( string $spacer = "-" )

Processes the string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents", whitespaces are replaced by a pre-defined spacer and the string is lowercase.

Parameters

string $spacer

Returns: self

Definition at line 743 of file StringHelper.php.

◆ valid()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::valid ( )

@ignore

Definition at line 847 of file StringHelper.php.

Member Data Documentation

◆ $position

int PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::$position = 0

protected

Definition at line 31 of file StringHelper.php.

◆ $string

string PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper::$string

protected

Definition at line 25 of file StringHelper.php.

The documentation for this class was generated from the following file:

src/Helper/StringHelper.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __toString()

◆ append()

◆ arg()

◆ contains()

◆ count()

◆ current()

◆ endsWith()

◆ escape()

◆ factory()

◆ filterAlnum()

◆ filterAlpha()

◆ filterDigits()

◆ findFirst()

◆ findLast()

◆ fromBase64()

◆ fromHex()

◆ isInt()

◆ isUtf8()

◆ jsonSerialize()

◆ key()

◆ next()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ prepend()

◆ replace()

◆ resize()

◆ rewind()

◆ section()

◆ spaceToPercent()

◆ split()

◆ startsWith()

◆ substr()

◆ toBase64()

◆ toCrc32()

◆ toHex()

◆ toInt()

◆ toLower()

◆ toMd5()

◆ toSha1()

◆ toString()

◆ toUpper()

◆ toUtf8()

◆ transliterate()

◆ trim()

◆ unescape()

◆ uriSafe()

◆ valid()

Member Data Documentation

◆ $position

◆ $string