Class String
String handling methods.
- Object
-
String
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: string.php
Inherited Properties
Method Summary
-
cleanInsert() public
Cleans up a Set::insert formated string with given $options depending on the 'clean' key in $options. The default method used is text but html is also available. The goal of this function is to replace all whitespace and uneeded markup around placeholders that did not get replaced by Set::insert.
-
getInstance() public
Gets a reference to the String object instance -
insert() public
Replaces variable placeholders inside a $str with any given $data. Each key in the $data array corresponds to a variable placeholder name in $str. Example:
-
tokenize() public
Tokenizes a string using $separator, ignoring any instance of $separator that appears between $leftBound and $rightBound
-
uuid() public
Generate a random UUID
Method Detail
cleanInsert() public ¶
cleanInsert( string $str , string $options )
Cleans up a Set::insert formated string with given $options depending on the 'clean' key in $options. The default method used is text but html is also available. The goal of this function is to replace all whitespace and uneeded markup around placeholders that did not get replaced by Set::insert.
Parameters
- string $str
- string $options
Returns
getInstance() public ¶
getInstance( )
Gets a reference to the String object instance
Returns
String instance
insert() public ¶
insert( string $str , string $data , string $options = array() )
Replaces variable placeholders inside a $str with any given $data. Each key in the $data array corresponds to a variable placeholder name in $str. Example:
Sample: String::insert('My name is :name and I am :age years old.', array('name' => 'Bob', '65')); Returns: My name is Bob and I am 65 years old.
Available $options are: before: The character or string in front of the name of the variable placeholder (Defaults to ':') after: The character or string after the name of the variable placeholder (Defaults to null) escape: The character or string used to escape the before character / string (Defaults to '\') format: A regex to use for matching variable placeholders. Default is: '/(?<!\):%s/' (Overwrites before, after, breaks escape / clean) clean: A boolean or array with instructions for String::cleanInsert
Parameters
- string $str
- A string containing variable placeholders
- string $data
- A key => val array where each key stands for a placeholder variable name to be replaced with val
- string $options optional array()
- An array of options, see description above
Returns
tokenize() public ¶
tokenize( string $data , string $separator = ',' , $leftBound = '(' , $rightBound = ')' )
Tokenizes a string using $separator, ignoring any instance of $separator that appears between $leftBound and $rightBound
Parameters
- string $data
- The data to tokenize
- string $separator optional ','
- The token to split the data on
- $leftBound optional '('
- $rightBound optional ')'
Returns
Methods inherited from Object
Object() public ¶
Object( )
A 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()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks 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
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used 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
- 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
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class