Class Multibyte
Multibyte handling methods.
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/I18n/Multibyte.php
Properties summary
- Holds the case folding values
array
- Holds an array of Unicode code point ranges
array
- Holds the current code point range
string
Method Summary
- Return the Code points range for Unicode characters
- Find the related code folding values for $char
-
Converts the decimal value of a multibyte character string to a string
- Check the $string for multibyte characters
- Prepare a string for mail transport, using the provided encoding
- Find position of first occurrence of a case-insensitive string.
- Finds first occurrence of a string within another, case insensitive.
- Get string length.
- Find position of first occurrence of a string.
- Finds the last occurrence of a character in a string within another.
- Finds the last occurrence of a character in a string within another, case insensitive.
- Finds position of last occurrence of a string within another, case insensitive
- Find position of last occurrence of a string in a string.
- Finds first occurrence of a string within another
- Make a string lowercase
- Make a string uppercase
- Get part of string
- Count the number of substring occurrences
-
Converts a multibyte character string to the decimal value of the character
Method Detail
_codepoint()source protected static
_codepoint( integer $decimal )
Return the Code points range for Unicode characters
Parameters
- integer
$decimal
- Decimal value.
Returns
string_find()source 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
arrayascii()source public static
ascii( array $array )
Converts the decimal value of a multibyte character string to a string
Parameters
- array
$array
- Values array.
Returns
stringcheckMultibyte()source public static
checkMultibyte( string $string )
Check the $string for multibyte characters
Parameters
- string
$string
- Value to test.
Returns
booleanmimeEncode()source 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
stringstripos()source 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|booleanThe numeric position of the first occurrence of $needle in the $haystack string, or false if $needle is not found.
stristr()source 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|booleanThe portion of $haystack, or false if $needle is not found.
strlen()source public static
strlen( string $string )
Get string length.
Parameters
- string
$string
- The string being checked for length.
Returns
integerThe number of characters in string $string
strpos()source 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|booleanThe numeric position of the first occurrence of $needle in the $haystack string. If $needle is not found, it returns false.
strrchr()source 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|booleanThe portion of $haystack. or false if $needle is not found.
strrichr()source 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|booleanThe portion of $haystack. or false if $needle is not found.
strripos()source 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|booleanThe numeric position of the last occurrence of $needle in the $haystack string, or false if $needle is not found.
strrpos()source 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|booleanThe numeric position of the last occurrence of $needle in the $haystack string. If $needle is not found, it returns false.
strstr()source 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|booleanThe portion of $haystack, or true if $needle is not found.
strtolower()source public static
strtolower( string $string )
Make a string lowercase
Parameters
- string
$string
- The string being lowercased.
Returns
stringwith all alphabetic characters converted to lowercase.
strtoupper()source public static
strtoupper( string $string )
Make a string uppercase
Parameters
- string
$string
- The string being uppercased.
Returns
stringwith all alphabetic characters converted to uppercase.
substr()source 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
stringThe portion of $string specified by the $string and $length parameters.
substrCount()source 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
integerThe number of times the $needle substring occurs in the $haystack string.
utf8()source public static
utf8( string $string )
Converts a multibyte character string to the decimal value of the character
Parameters
- string
$string
- String to convert.
Returns
arrayProperties detail
© 2005–2017 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.
https://api.cakephp.org/2.10/class-Multibyte.html