Class Multibyte

Multibyte handling methods.

Package: Cake\I18n
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/I18n/Multibyte.php

Method Detail

_codepointsource protected static 

_codepoint( integer $decimal )

Return the Code points range for Unicode characters

Parameters

integer $decimal
Decimal value.

Returns

string
string

_findsource protected static 

_find( integer $char , string $type 'lower' )

Find the related code folding values for $char

Parameters

integer $char
decimal value of character
string $type optional 'lower'
Type 'lower' or 'upper'. Defaults to 'lower'.

Returns

array
array

asciisource public static 

ascii( array $array )

Converts the decimal value of a multibyte character string to a string

Parameters

array $array
Values array.

Returns

string
string

checkMultibytesource public static 

checkMultibyte( string $string )

Check the $string for multibyte characters

Parameters

string $string
Value to test.

Returns

boolean
bool

mimeEncodesource public static 

mimeEncode( string $string , string $charset null , string $newline "\r\n" )

Prepare a string for mail transport, using the provided encoding

Parameters

string $string
value to encode
string $charset optional null
charset to use for encoding. defaults to UTF-8
string $newline optional "\r\n"
Newline string.

Returns

string
string

stripossource public static 

stripos( string $haystack , string $needle , integer $offset 0 )

Find position of first occurrence of a case-insensitive string.

Parameters

string $haystack
The string from which to get the position of the first occurrence of $needle.
string $needle
The string to find in $haystack.
integer $offset optional 0
The position in $haystack to start searching.

Returns

integer|boolean
The numeric position of the first occurrence of $needle in the $haystack string, or false if $needle is not found.

stristrsource public static 

stristr( string $haystack , string $needle , boolean $part false )

Finds first occurrence of a string within another, case insensitive.

Parameters

string $haystack
The string from which to get the first occurrence of $needle.
string $needle
The string to find in $haystack.
boolean $part optional false
Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the first occurrence of $needle. If set to false, it returns all of $haystack from the first occurrence of $needle to the end, Default value is false.

Returns

integer|boolean
The portion of $haystack, or false if $needle is not found.

strlensource public static 

strlen( string $string )

Get string length.

Parameters

string $string
The string being checked for length.

Returns

integer
The number of characters in string $string

strpossource public static 

strpos( string $haystack , string $needle , integer $offset 0 )

Find position of first occurrence of a string.

Parameters

string $haystack
The string being checked.
string $needle
The position counted from the beginning of haystack.
integer $offset optional 0
The search offset. If it is not specified, 0 is used.

Returns

integer|boolean
The numeric position of the first occurrence of $needle in the $haystack string. If $needle is not found, it returns false.

strrchrsource public static 

strrchr( string $haystack , string $needle , boolean $part false )

Finds the last occurrence of a character in a string within another.

Parameters

string $haystack
The string from which to get the last occurrence of $needle.
string $needle
The string to find in $haystack.
boolean $part optional false
Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the last occurrence of $needle. If set to false, it returns all of $haystack from the last occurrence of $needle to the end, Default value is false.

Returns

string|boolean
The portion of $haystack. or false if $needle is not found.

strrichrsource public static 

strrichr( string $haystack , string $needle , boolean $part false )

Finds the last occurrence of a character in a string within another, case insensitive.

Parameters

string $haystack
The string from which to get the last occurrence of $needle.
string $needle
The string to find in $haystack.
boolean $part optional false
Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the last occurrence of $needle. If set to false, it returns all of $haystack from the last occurrence of $needle to the end, Default value is false.

Returns

string|boolean
The portion of $haystack. or false if $needle is not found.

strripossource public static 

strripos( string $haystack , string $needle , integer $offset 0 )

Finds position of last occurrence of a string within another, case insensitive

Parameters

string $haystack
The string from which to get the position of the last occurrence of $needle.
string $needle
The string to find in $haystack.
integer $offset optional 0
The position in $haystack to start searching.

Returns

integer|boolean
The numeric position of the last occurrence of $needle in the $haystack string, or false if $needle is not found.

strrpossource public static 

strrpos( string $haystack , string $needle , integer $offset 0 )

Find position of last occurrence of a string in a string.

Parameters

string $haystack
The string being checked, for the last occurrence of $needle.
string $needle
The string to find in $haystack.
integer $offset optional 0
May be specified to begin searching an arbitrary number of characters into the string. Negative values will stop searching at an arbitrary point prior to the end of the string.

Returns

integer|boolean
The numeric position of the last occurrence of $needle in the $haystack string. If $needle is not found, it returns false.

strstrsource public static 

strstr( string $haystack , string $needle , boolean $part false )

Finds first occurrence of a string within another

Parameters

string $haystack
The string from which to get the first occurrence of $needle.
string $needle
The string to find in $haystack
boolean $part optional false
Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the first occurrence of $needle. If set to false, it returns all of $haystack from the first occurrence of $needle to the end, Default value is FALSE.

Returns

string|boolean
The portion of $haystack, or true if $needle is not found.

strtolowersource public static 

strtolower( string $string )

Make a string lowercase

Parameters

string $string
The string being lowercased.

Returns

string
with all alphabetic characters converted to lowercase.

strtouppersource public static 

strtoupper( string $string )

Make a string uppercase

Parameters

string $string
The string being uppercased.

Returns

string
with all alphabetic characters converted to uppercase.

substrsource public static 

substr( string $string , integer $start , integer $length null )

Get part of string

Parameters

string $string
The string being checked.
integer $start
The first position used in $string.
integer $length optional null
The maximum length of the returned string.

Returns

string
The portion of $string specified by the $string and $length parameters.

substrCountsource public static 

substrCount( string $haystack , string $needle )

Count the number of substring occurrences

Parameters

string $haystack
The string being checked.
string $needle
The string being found.

Returns

integer
The number of times the $needle substring occurs in the $haystack string.

utf8source public static 

utf8( string $string )

Converts a multibyte character string to the decimal value of the character

Parameters

string $string
String to convert.

Returns

array
array

Properties summary

$_caseFoldsource

protected static array

Holds the case folding values

array()

$_codeRangesource

protected static array

Holds an array of Unicode code point ranges

array()

$_tablesource

protected static string

Holds the current code point range

null

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-Multibyte.html