Multibyte Class Info:
- Class Declaration:
class Multibyte extends Object
- File name:
- cake/libs/multibyte.php
- Description:
Multibyte handling methods.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs
Properties:
Method Summary:
- ascii( $array )
- cakeError( $method, $messages = array ( ) )
- checkMultibyte( $string )
- __construct( )
- dispatchMethod( $method, $params = array ( ) )
- getInstance( )
- log( $msg, $type = 2 )
- mimeEncode( $string, $charset = NULL, $newline = ' ' )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- stripos( $haystack, $needle, $offset = 0 )
- stristr( $haystack, $needle, $part = false )
- strlen( $string )
- strpos( $haystack, $needle, $offset = 0 )
- strrchr( $haystack, $needle, $part = false )
- strrichr( $haystack, $needle, $part = false )
- strripos( $haystack, $needle, $offset = 0 )
- strrpos( $haystack, $needle, $offset = 0 )
- strstr( $haystack, $needle, $part = false )
- strtolower( $string )
- strtoupper( $string )
- substr( $string, $start, $length = NULL )
- substrCount( $haystack, $needle )
- toString( )
- utf8( $string )
ascii
topConverts the decimal value of a multibyte character string to a string
- Parameters:
-
-
array $array required
-
- Method defined in:
- cake/libs/multibyte.php on line 354
- Return
string
- Access
public
- Static
cakeError
topUsed to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
- Parameters:
-
-
string $method required
Method to be called in the error class (AppError or ErrorHandler classes)
-
array $messages optional array ( )
Message that is to be displayed by the error class
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
checkMultibyte
topCheck the $string for multibyte characters
- Parameters:
-
-
string $string required
value to test
-
- Method defined in:
- cake/libs/multibyte.php on line 1161
- Return
boolean
- Access
public
- Static
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
getInstance
topGets a reference to the Multibyte object instance
- Method defined in:
- cake/libs/multibyte.php on line 295
- Return
object Multibyte instance
- Access
public
- Static
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
mimeEncode
topPrepare a string for mail transport, using the provided encoding
- Parameters:
-
-
string $string required
value to encode
-
string $charset optional NULL
charset to use for encoding. defaults to UTF-8
-
string $newline optional ' '
charset to use for encoding. defaults to UTF-8
-
- Method defined in:
- cake/libs/multibyte.php on line 1030
- Return
string
- Access
public
- Static
- TODO
: add support for 'Q'('Quoted Printable') encoding
Object
topA hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
stripos
topFind position of first occurrence of a case-insensitive string.
- Parameters:
-
-
$haystack required
-
$needle required
-
integer $offset optional 0
The position in $haystack to start searching.
-
- Method defined in:
- cake/libs/multibyte.php on line 383
- Return
integer|boolean The numeric position of the first occurrence of $needle in the $haystack string, or false if $needle is not found.
- Access
public
- Static
stristr
topFinds first occurrence of a string within another, case insensitive.
- Parameters:
-
-
string $haystack required
The string from which to get the first occurrence of $needle.
-
string $needle required
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.
-
- Method defined in:
- cake/libs/multibyte.php on line 405
- Return
int|boolean The portion of $haystack, or false if $needle is not found.
- Access
public
- Static
strlen
topGet string length.
- Parameters:
-
-
string $string required
The string being checked for length.
-
- Method defined in:
- cake/libs/multibyte.php on line 463
- Return
integer The number of characters in string $string
- Access
public
- Static
strpos
topFind position of first occurrence of a string.
- Parameters:
-
-
string $haystack required
The string being checked.
-
string $needle required
The position counted from the beginning of haystack.
-
integer $offset optional 0
The search offset. If it is not specified, 0 is used.
-
- Method defined in:
- cake/libs/multibyte.php on line 482
- Return
integer|boolean The numeric position of the first occurrence of $needle in the $haystack string. If $needle is not found, it returns false.
- Access
public
- Static
strrchr
topFinds the last occurrence of a character in a string within another.
- Parameters:
-
-
string $haystack required
The string from which to get the last occurrence of $needle.
-
string $needle required
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.
-
- Method defined in:
- cake/libs/multibyte.php on line 529
- Return
string|boolean The portion of $haystack. or false if $needle is not found.
- Access
public
- Static
strrichr
topFinds the last occurrence of a character in a string within another, case insensitive.
- Parameters:
-
-
string $haystack required
The string from which to get the last occurrence of $needle.
-
string $needle required
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.
-
- Method defined in:
- cake/libs/multibyte.php on line 591
- Return
string|boolean The portion of $haystack. or false if $needle is not found.
- Access
public
- Static
strripos
topFinds position of last occurrence of a string within another, case insensitive
- Parameters:
-
-
string $haystack required
The string from which to get the position of the last occurrence of $needle.
-
string $needle required
The string to find in $haystack.
-
integer $offset optional 0
The position in $haystack to start searching.
-
- Method defined in:
- cake/libs/multibyte.php on line 653
- Return
integer|boolean The numeric position of the last occurrence of $needle in the $haystack string, or false if $needle is not found.
- Access
public
- Static
strrpos
topFind position of last occurrence of a string in a string.
- Parameters:
-
-
string $haystack required
The string being checked, for the last occurrence of $needle.
-
string $needle required
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.
-
- Method defined in:
- cake/libs/multibyte.php on line 706
- Return
integer|boolean The numeric position of the last occurrence of $needle in the $haystack string. If $needle is not found, it returns false.
- Access
public
- Static
strstr
topFinds first occurrence of a string within another
- Parameters:
-
-
string $haystack required
The string from which to get the first occurrence of $needle.
-
string $needle required
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.
-
- Method defined in:
- cake/libs/multibyte.php on line 759
- Return
string|boolean The portion of $haystack, or true if $needle is not found.
- Access
public
- Static
strtolower
topMake a string lowercase
- Parameters:
-
-
string $string required
The string being lowercased.
-
- Method defined in:
- cake/libs/multibyte.php on line 815
- Return
string with all alphabetic characters converted to lowercase.
- Access
public
- Static
strtoupper
topMake a string uppercase
- Parameters:
-
-
string $string required
The string being uppercased.
-
- Method defined in:
- cake/libs/multibyte.php on line 864
- Return
string with all alphabetic characters converted to uppercase.
- Access
public
- Static
substr
topGet part of string
- Parameters:
-
-
string $string required
The string being checked.
-
integer $start required
The first position used in $string.
-
integer $length optional NULL
The maximum length of the returned string.
-
- Method defined in:
- cake/libs/multibyte.php on line 995
- Return
string The portion of $string specified by the $string and $length parameters.
- Access
public
- Static
substrCount
topCount the number of substring occurrences
- Parameters:
-
-
string $haystack required
The string being checked.
-
string $needle required
The string being found.
-
- Method defined in:
- cake/libs/multibyte.php on line 957
- Return
integer The number of times the $needle substring occurs in the $haystack string.
- Access
public
- Static
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
utf8
topConverts a multibyte character string to the decimal value of the character
- Parameters:
-
-
multibyte $string required
$string
-
- Method defined in:
- cake/libs/multibyte.php on line 313
- Return
array
- Access
public
- Static
