Helper class for string handling. More...

Inherits ArrayAccess, Iterator, and Countable.

Public Member Functions
	__construct ($string)
	The TeamSpeak3_Helper_String constructor. More...

	__call ($function, $args)
	Magical function that allows you to call PHP's built-in string functions on the TeamSpeak3_Helper_String object. More...

	__toString ()
	Returns the character as a standard string. More...

	append ($part)
	Appends $part to the string. More...

	arg (array $args, $char="%")
	This function replaces indexed or associative signs with given values. More...

	contains ($pattern, $regexp=FALSE)
	Returns true if the string contains $pattern. More...

	count ()

	current ()

	endsWith ($pattern)
	Returns true if the string ends with $pattern. More...

	escape ()
	Escapes a string using the TeamSpeak 3 escape patterns. More...

	filterAlnum ()
	Removes any non alphanumeric characters from the string. More...

	filterAlpha ()
	Removes any non alphabetic characters from the string. More...

	filterDigits ()
	Removes any non numeric characters from the string. More...

	findFirst ($needle)
	Returns the position of the first occurrence of a char in a string. More...

	findLast ($needle)
	Returns the position of the last occurrence of a char in a string. More...

	isInt ()
	Returns TRUE if the string is a numeric value. More...

	isUtf8 ()
	Returns TRUE if the string is UTF-8 encoded. More...

	key ()

	next ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	prepend ($part)
	Prepends $part to the string. More...

	replace ($search, $replace, $caseSensitivity=TRUE)
	Replaces every occurrence of the string $search with the string $replace. More...

	resize ($size, $char="\)
	Sets the size of the string to $size characters. More...

	rewind ()

	section ($separator, $first=0, $last=0)
	Returns a section of the string. More...

	spaceToPercent ()
	Replaces space characters with percent encoded strings. More...

	split ($separator, $limit=0)
	Splits the string into substrings wherever $separator occurs. More...

	startsWith ($pattern)
	Returns true if the string starts with $pattern. More...

	substr ($start, $length=null)
	Returns part of a string. More...

	toBase64 ()
	Encodes the string with MIME base64 and returns the result. More...

	toCrc32 ()
	Calculates and returns the crc32 polynomial of the string. More...

	toHex ()
	Returns the hexadecimal value of the string. More...

	toInt ()
	Returns the integer value of the string. More...

	toLower ()
	Returns the lowercased string. More...

	toMd5 ()
	Calculates and returns the md5 checksum of the string. More...

	toSha1 ()
	Calculates and returns the sha1 checksum of the string. More...

	toString ()
	Returns the string as a standard string. More...

	toUpper ()
	Returns the uppercased string. More...

	toUtf8 ()
	Converts the string to UTF-8. More...

	transliterate ()
	Returns the string transliterated from UTF-8 to Latin. More...

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

	unescape ()
	Unescapes a string using the TeamSpeak 3 escape patterns. More...

	uriSafe ($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. More...

	valid ()

Static Public Member Functions
static	factory ($string)
	Returns a TeamSpeak3_Helper_String object for thegiven string. More...

static	fromBase64 ($base64)
	Decodes the string with MIME base64 and returns the result as an TeamSpeak3_Helper_String. More...

static	fromHex ($hex)
	Returns the TeamSpeak3_Helper_String based on a given hex value. More...

Protected Attributes
	$position = 0

Detailed Description

Helper class for string handling.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $string )

The TeamSpeak3_Helper_String constructor.

Parameters

string $string

Returns: TeamSpeak3_Helper_String

   {
     $this->string = (string) $string;
   }

Member Function Documentation

◆ __call()

__call	(	$function,
		$args
	)

Magical function that allows you to call PHP's built-in string functions on the TeamSpeak3_Helper_String object.

Parameters

string	$function
array	$args

Exceptions

TeamSpeak3_Helper_Exception

Returns: TeamSpeak3_Helper_String

   {
     if(!function_exists($function))
     {
       throw new TeamSpeak3_Helper_Exception("cannot call undefined function '" . $function . "' on this object");
     }
 
     if(count($args))
     {
       if(($key = array_search($this, $args, TRUE)) !== FALSE)
       {
         $args[$key] = $this->string;
       }
       else
       {
         throw new TeamSpeak3_Helper_Exception("cannot call undefined function '" . $function . "' without the " . __CLASS__ . " object parameter");
       }
 
       $return = call_user_func_array($function, $args);
     }
     else
     {
       $return = call_user_func($function, $this->string);
     }
 
     if(is_string($return))
     {
       $this->string = $return;
     }
     else
     {
       return $return;
     }
 
     return $this;
   }

◆ __toString()

__toString ( )

Returns the character as a standard string.

Returns: string

   {
     return (string) $this->string;
   }

◆ append()

append ( $part )

Appends $part to the string.

Parameters

string $part

Returns: TeamSpeak3_Helper_String

   {
     $this->string = $this->string . strval($part);
 
     return $this;
   }

◆ arg()

arg	(	array	$args,
			$char = `"%"`
	)

This function replaces indexed or associative signs with given values.

Parameters

array	$args
string	$char

Returns: TeamSpeak3_Helper_String

   {
     $args = array_reverse($args, TRUE);
 
     foreach($args as $key => $val)
     {
       $args[$char . $key] = $val;
       unset($args[$key]);
     }
 
     $this->string = strtr($this->string, $args);
 
     return $this;
   }

◆ contains()

contains	(	$pattern,
		$regexp = `FALSE`
	)

Returns true if the string contains $pattern.

Parameters

string	$pattern
boolean	$regexp

Returns: boolean

   {
     if(empty($pattern))
     {
       return TRUE;
     }
 
     if($regexp)
     {
       return (preg_match("/" . $pattern . "/i", $this->string)) ? TRUE : FALSE;
     }
     else
     {
       return (stristr($this->string, $pattern) !== FALSE) ? TRUE : FALSE;
     }
   }

◆ endsWith()

endsWith ( $pattern )

Returns true if the string ends with $pattern.

Parameters

string $pattern

Returns: boolean

   {
     return (substr($this->string, strlen($pattern)*-1) == $pattern) ? TRUE : FALSE;
   }

◆ escape()

escape ( )

Escapes a string using the TeamSpeak 3 escape patterns.

Returns: TeamSpeak3_Helper_String

   {
     foreach(TeamSpeak3::getEscapePatterns() as $search => $replace)
     {
       $this->string = str_replace($search, $replace, $this->string);
     }
 
     return $this;
   }

◆ factory()

static factory ( $string )

static

Returns a TeamSpeak3_Helper_String object for thegiven string.

Parameters

string $string

Returns: TeamSpeak3_Helper_String

   {
     return new self($string);
   }

◆ filterAlnum()

filterAlnum ( )

Removes any non alphanumeric characters from the string.

Returns: TeamSpeak3_Helper_String

   {
     $this->string = preg_replace("/[^[:alnum:]]/", "",  $this->string);
 
     return $this;
   }

◆ filterAlpha()

filterAlpha ( )

Removes any non alphabetic characters from the string.

Returns: TeamSpeak3_Helper_String

   {
     $this->string = preg_replace("/[^[:alpha:]]/", "",  $this->string);
 
     return $this;
   }

◆ filterDigits()

filterDigits ( )

Removes any non numeric characters from the string.

Returns: TeamSpeak3_Helper_String

   {
     $this->string = preg_replace("/[^[:digit:]]/", "",  $this->string);
 
     return $this;
   }

◆ findFirst()

findFirst ( $needle )

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

Parameters

string $needle

Returns: integer

   {
     return strpos($this->string, $needle);
   }

◆ findLast()

findLast ( $needle )

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

Parameters

string $needle

Returns: integer

   {
     return strrpos($this->string, $needle);
   }

◆ fromBase64()

static fromBase64 ( $base64 )

static

Decodes the string with MIME base64 and returns the result as an TeamSpeak3_Helper_String.

Parameters

string $base64

Returns: TeamSpeak3_Helper_String

   {
     return new self(base64_decode($base64));
   }

◆ fromHex()

static fromHex ( $hex )

static

Returns the TeamSpeak3_Helper_String based on a given hex value.

Parameters

string $hex

Exceptions

TeamSpeak3_Helper_Exception

Returns: TeamSpeak3_Helper_String

   {
     $string = "";
 
     if(strlen($hex)%2 == 1)
     {
       throw new TeamSpeak3_Helper_Exception("given parameter '" . $hex . "' is not a valid hexadecimal number");
     }
 
     foreach(str_split($hex, 2) as $chunk)
     {
       $string .= chr(hexdec($chunk));
     }
 
     return new self($string);
   }

◆ isInt()

isInt ( )

Returns TRUE if the string is a numeric value.

Returns: boolean

   {
     return (is_numeric($this->string) && !$this->contains(".") && !$this->contains("x")) ? TRUE : FALSE;
   }

◆ isUtf8()

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

   {
     $pattern = array();
 
     $pattern[] = "[\xC2-\xDF][\x80-\xBF]";            // non-overlong 2-byte
     $pattern[] = "\xE0[\xA0-\xBF][\x80-\xBF]";        // excluding overlongs
     $pattern[] = "[\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}"; // straight 3-byte
     $pattern[] = "\xED[\x80-\x9F][\x80-\xBF]";        // excluding surrogates
     $pattern[] = "\xF0[\x90-\xBF][\x80-\xBF]{2}";     // planes 1-3
     $pattern[] = "[\xF1-\xF3][\x80-\xBF]{3}";         // planes 4-15
     $pattern[] = "\xF4[\x80-\x8F][\x80-\xBF]{2}";     // plane 16
 
     return preg_match("%(?:" . implode("|", $pattern) . ")+%xs", $this->string);
   }

◆ prepend()

prepend ( $part )

Prepends $part to the string.

Parameters

string $part

Returns: TeamSpeak3_Helper_String

   {
     $this->string = strval($part) . $this->string;
 
     return $this;
   }

◆ replace()

replace	(	$search,
		$replace,
		$caseSensitivity = `TRUE`
	)

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

Parameters

string	$search
string	$replace
boolean	$caseSensitivity

Returns: TeamSpeak3_Helper_String

   {
     if($caseSensitivity)
     {
       $this->string = str_replace($search, $replace, $this->string);
     }
     else
     {
       $this->string = str_ireplace($search, $replace, $this->string);
     }
 
     return $this;
   }

◆ resize()

resize	(	$size,
		$char = `"\0"`
	)

Sets the size of the string to $size characters.

Parameters

integer	$size
string	$char

Returns: TeamSpeak3_Helper_String

   {
     $chars = ($size - $this->count());
 
     if($chars < 0)
     {
       $this->string = substr($this->string, 0, $chars);
     }
     elseif($chars > 0)
     {
       $this->string = str_pad($this->string, $size, strval($char));
     }
 
     return $this;
   }

◆ section()

section	(	$separator,
		$first = `0`,
		$last = `0`
	)

Returns a section of the string.

Parameters

string	$separator
integer	$first
integer	$last

Returns: TeamSpeak3_Helper_String

   {
     $sections = explode($separator, $this->string);
 
     $total = count($sections);
     $first = intval($first);
     $last  = intval($last);
 
     if($first > $total) return null;
     if($first > $last) $last = $first;
 
     for($i = 0; $i < $total; $i++)
     {
       if($i < $first || $i > $last)
       {
         unset($sections[$i]);
       }
     }
 
     $string = implode($separator, $sections);
 
     return new self($string);
   }

◆ spaceToPercent()

spaceToPercent ( )

Replaces space characters with percent encoded strings.

Returns: string

   {
     return str_replace(" ", "%20", $this->string);
   }

◆ split()

split	(	$separator,
		$limit = `0`
	)

Splits the string into substrings wherever $separator occurs.

Parameters

string	$separator
integer	$limit

Returns: array

   {
     $parts = explode($separator, $this->string, ($limit) ? intval($limit) : $this->count());
 
     foreach($parts as $key => $val)
     {
       $parts[$key] = new self($val);
     }
 
     return $parts;
   }

◆ startsWith()

startsWith ( $pattern )

Returns true if the string starts with $pattern.

Parameters

string $pattern

Returns: boolean

   {
     return (substr($this->string, 0, strlen($pattern)) == $pattern) ? TRUE : FALSE;
   }

◆ substr()

substr	(	$start,
		$length = `null`
	)

Returns part of a string.

Parameters

integer	$start
integer	$length

Returns: TeamSpeak3_Helper_String

   {
     $string = ($length !== null) ? substr($this->string, $start, $length) : substr($this->string, $start);
 
     return new self($string);
   }

◆ toBase64()

toBase64 ( )

Encodes the string with MIME base64 and returns the result.

Returns: string

   {
     return base64_encode($this->string);
   }

◆ toCrc32()

toCrc32 ( )

Calculates and returns the crc32 polynomial of the string.

Returns: string

   {
     return crc32($this->string);
   }

◆ toHex()

toHex ( )

Returns the hexadecimal value of the string.

Returns: string

   {
     $hex = "";
 
     foreach($this as $char)
     {
       $hex .= $char->toHex();
     }
 
     return $hex;
   }

◆ toInt()

toInt ( )

Returns the integer value of the string.

Returns: float; integer

   {
     if($this->string == pow(2, 63) || $this->string == pow(2, 64))
     {
       return -1;
     }
 
     return ($this->string > pow(2, 31)) ? floatval($this->string) : intval($this->string);
   }

◆ toLower()

toLower ( )

Returns the lowercased string.

Returns: TeamSpeak3_Helper_String

   {
     return new self(strtolower($this->string));
   }

◆ toMd5()

toMd5 ( )

Calculates and returns the md5 checksum of the string.

Returns: string

   {
     return md5($this->string);
   }

◆ toSha1()

toSha1 ( )

Calculates and returns the sha1 checksum of the string.

Returns: string

   {
     return sha1($this->string);
   }

◆ toString()

toString ( )

Returns the string as a standard string.

Returns: string

   {
     return $this->string;
   }

◆ toUpper()

toUpper ( )

Returns the uppercased string.

Returns: TeamSpeak3_Helper_String

   {
     return new self(strtoupper($this->string));
   }

◆ toUtf8()

toUtf8 ( )

Converts the string to UTF-8.

Returns: TeamSpeak3_Helper_String

   {
     if(!$this->isUtf8())
     {
       $this->string = utf8_encode($this->string);
     }
 
     return $this;
   }

◆ transliterate()

transliterate ( )

Returns the string transliterated from UTF-8 to Latin.

Returns: TeamSpeak3_Helper_String

   {
     $utf8_accents = array(
       "à" => "a",
       "ô" => "o",
       "ď" => "d",
       "ḟ" => "f",
       "ë" => "e",
       "š" => "s",
       "ơ" => "o",
       "ß" => "ss",
       "ă" => "a",
       "ř" => "r",
       "ț" => "t",
       "ň" => "n",
       "ā" => "a",
       "ķ" => "k",
       "ŝ" => "s",
       "ỳ" => "y",
       "ņ" => "n",
       "ĺ" => "l",
       "ħ" => "h",
       "ṗ" => "p",
       "ó" => "o",
       "ú" => "u",
       "ě" => "e",
       "é" => "e",
       "ç" => "c",
       "ẁ" => "w",
       "ċ" => "c",
       "õ" => "o",
       "ṡ" => "s",
       "ø" => "o",
       "ģ" => "g",
       "ŧ" => "t",
       "ș" => "s",
       "ė" => "e",
       "ĉ" => "c",
       "ś" => "s",
       "î" => "i",
       "ű" => "u",
       "ć" => "c",
       "ę" => "e",
       "ŵ" => "w",
       "ṫ" => "t",
       "ū" => "u",
       "č" => "c",
       "ö" => "oe",
       "è" => "e",
       "ŷ" => "y",
       "ą" => "a",
       "ł" => "l",
       "ų" => "u",
       "ů" => "u",
       "ş" => "s",
       "ğ" => "g",
       "ļ" => "l",
       "ƒ" => "f",
       "ž" => "z",
       "ẃ" => "w",
       "ḃ" => "b",
       "å" => "a",
       "ì" => "i",
       "ï" => "i",
       "ḋ" => "d",
       "ť" => "t",
       "ŗ" => "r",
       "ä" => "ae",
       "í" => "i",
       "ŕ" => "r",
       "ê" => "e",
       "ü" => "ue",
       "ò" => "o",
       "ē" => "e",
       "ñ" => "n",
       "ń" => "n",
       "ĥ" => "h",
       "ĝ" => "g",
       "đ" => "d",
       "ĵ" => "j",
       "ÿ" => "y",
       "ũ" => "u",
       "ŭ" => "u",
       "ư" => "u",
       "ţ" => "t",
       "ý" => "y",
       "ő" => "o",
       "â" => "a",
       "ľ" => "l",
       "ẅ" => "w",
       "ż" => "z",
       "ī" => "i",
       "ã" => "a",
       "ġ" => "g",
       "ṁ" => "m",
       "ō" => "o",
       "ĩ" => "i",
       "ù" => "u",
       "į" => "i",
       "ź" => "z",
       "á" => "a",
       "û" => "u",
       "þ" => "th",
       "ð" => "dh",
       "æ" => "ae",
       "µ" => "u",
       "ĕ" => "e",
       "œ" => "oe",
       "À" => "A",
       "Ô" => "O",
       "Ď" => "D",
       "Ḟ" => "F",
       "Ë" => "E",
       "Š" => "S",
       "Ơ" => "O",
       "Ă" => "A",
       "Ř" => "R",
       "Ț" => "T",
       "Ň" => "N",
       "Ā" => "A",
       "Ķ" => "K",
       "Ŝ" => "S",
       "Ỳ" => "Y",
       "Ņ" => "N",
       "Ĺ" => "L",
       "Ħ" => "H",
       "Ṗ" => "P",
       "Ó" => "O",
       "Ú" => "U",
       "Ě" => "E",
       "É" => "E",
       "Ç" => "C",
       "Ẁ" => "W",
       "Ċ" => "C",
       "Õ" => "O",
       "Ṡ" => "S",
       "Ø" => "O",
       "Ģ" => "G",
       "Ŧ" => "T",
       "Ș" => "S",
       "Ė" => "E",
       "Ĉ" => "C",
       "Ś" => "S",
       "Î" => "I",
       "Ű" => "U",
       "Ć" => "C",
       "Ę" => "E",
       "Ŵ" => "W",
       "Ṫ" => "T",
       "Ū" => "U",
       "Č" => "C",
       "Ö" => "Oe",
       "È" => "E",
       "Ŷ" => "Y",
       "Ą" => "A",
       "Ł" => "L",
       "Ų" => "U",
       "Ů" => "U",
       "Ş" => "S",
       "Ğ" => "G",
       "Ļ" => "L",
       "Ƒ" => "F",
       "Ž" => "Z",
       "Ẃ" => "W",
       "Ḃ" => "B",
       "Å" => "A",
       "Ì" => "I",
       "Ï" => "I",
       "Ḋ" => "D",
       "Ť" => "T",
       "Ŗ" => "R",
       "Ä" => "Ae",
       "Í" => "I",
       "Ŕ" => "R",
       "Ê" => "E",
       "Ü" => "Ue",
       "Ò" => "O",
       "Ē" => "E",
       "Ñ" => "N",
       "Ń" => "N",
       "Ĥ" => "H",
       "Ĝ" => "G",
       "Đ" => "D",
       "Ĵ" => "J",
       "Ÿ" => "Y",
       "Ũ" => "U",
       "Ŭ" => "U",
       "Ư" => "U",
       "Ţ" => "T",
       "Ý" => "Y",
       "Ő" => "O",
       "Â" => "A",
       "Ľ" => "L",
       "Ẅ" => "W",
       "Ż" => "Z",
       "Ī" => "I",
       "Ã" => "A",
       "Ġ" => "G",
       "Ṁ" => "M",
       "Ō" => "O",
       "Ĩ" => "I",
       "Ù" => "U",
       "Į" => "I",
       "Ź" => "Z",
       "Á" => "A",
       "Û" => "U",
       "Þ" => "Th",
       "Ð" => "Dh",
       "Æ" => "Ae",
       "Ĕ" => "E",
       "Œ" => "Oe",
     );
 
     return new self($this->toUtf8()->replace(array_keys($utf8_accents), array_values($utf8_accents)));
   }

◆ trim()

trim ( )

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

Returns: TeamSpeak3_Helper_String

   {
     $this->string = trim($this->string);
 
     return $this;
   }

◆ unescape()

unescape ( )

Unescapes a string using the TeamSpeak 3 escape patterns.

Returns: TeamSpeak3_Helper_String

   {
     $this->string = strtr($this->string, array_flip(TeamSpeak3::getEscapePatterns()));
 
     return $this;
   }

◆ uriSafe()

uriSafe ( $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: TeamSpeak3_Helper_String

   {
     $this->string = str_replace($spacer, " ", $this->string);
     $this->string = $this->transliterate();
     $this->string = preg_replace("/(\s|[^A-Za-z0-9\-])+/", $spacer, trim(strtolower($this->string)));
     $this->string = trim($this->string, $spacer);
 
     return new self($this->string);
   }

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

/Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Helper/String.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __toString()

◆ append()

◆ arg()

◆ contains()

◆ endsWith()

◆ escape()

◆ factory()

◆ filterAlnum()

◆ filterAlpha()

◆ filterDigits()

◆ findFirst()

◆ findLast()

◆ fromBase64()

◆ fromHex()

◆ isInt()

◆ isUtf8()

◆ prepend()

◆ replace()

◆ resize()

◆ section()

◆ spaceToPercent()

◆ split()

◆ startsWith()

◆ substr()

◆ toBase64()

◆ toCrc32()

◆ toHex()

◆ toInt()

◆ toLower()

◆ toMd5()

◆ toSha1()

◆ toString()

◆ toUpper()

◆ toUtf8()

◆ transliterate()

◆ trim()

◆ unescape()

◆ uriSafe()