cakephp-1.3 > String :: insert()
String
A
AclBase
AclBehavior
AclComponent
AclNode
AclShell
Aco
AcoAction
AjaxHelper
ApcEngine
ApiShell
App
AppController
AppController
AppHelper
AppHelper
AppModel
AppModel
Aro
AuthComponent
B
BakeShell
BakeTask
BehaviorCollection
C
Cache
CacheEngine
CacheHelper
CakeErrorController
CakeLog
CakeRoute
CakeSchema
CakeSession
CakeSocket
ClassRegistry
Component
Configure
ConnectionManager
ConsoleShell
ContainableBehavior
Controller
ControllerTask
CookieComponent
D
DataSource
DbAcl
DbAclSchema
DbConfigTask
DboMssql
DboMysql
DboMysqlBase
DboMysqli
DboOracle
DboPostgres
DboSource
DboSqlite
Debugger
Dispatcher
E
EmailComponent
ErrorHandler
ErrorHandler
ExtractTask
F
File
FileEngine
FileLog
FixtureTask
Folder
FormHelper
H
Helper
HtmlHelper
HttpSocket
I
I18n
I18nModel
i18nSchema
I18nShell
Inflector
IniAcl
J
JavascriptHelper
JqueryEngineHelper
JsBaseEngineHelper
JsHelper
L
L10n
M
MagicDb
MagicFileResource
MediaView
MemcacheEngine
Model
ModelBehavior
ModelTask
MootoolsEngineHelper
Multibyte
N
NumberHelper
O
Object
Overloadable
Overloadable
Overloadable2
Overloadable2
P
PagesController
PagesController
PaginatorHelper
Permission
PluginShortRoute
PluginTask
ProjectTask
PrototypeEngineHelper
R
RequestHandlerComponent
Router
RssHelper
S
Sanitize
Scaffold
ScaffoldView
SchemaShell
Security
SecurityComponent
SessionComponent
SessionHelper
SessionsSchema
Set
Shell
ShellDispatcher
String
T
TemplateTask
TestSuiteShell
TestTask
TextHelper
ThemeView
TimeHelper
TranslateBehavior
TreeBehavior
V
Validation
View
ViewTask
X
XcacheEngine
Xml
XmlElement
XmlHelper
XmlManager
XmlNode
XmlTextNode
insert
line:208 at
/cake/libs/string.php
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: `String::insert(':name is :age years old.', array('name' => 'Bob', '65'));`
Returns: Bob is 65 years old.
Method
(string)
insert
($str, $data, $options = array())
Parameters
Parameter | Type | Comment | Default |
---|---|---|---|
$str | string | required A string containing variable placeholders | |
$data | string | required A key => val array where each key stands for a placeholder variable name to be replaced with val | |
$options | string | optional An array of options, see description above | array() |
Return
stringComment
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: `String::insert(':name is :age years old.', array('name' => 'Bob', '65'));`
Returns: Bob is 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
@param string $str A string containing variable placeholders
@param string $data A key => val array where each key stands for a placeholder variable name
to be replaced with val
@param string $options An array of options, see description above
@return string
@access public
@static
corresponds to a variable placeholder name in $str.
Example: `String::insert(':name is :age years old.', array('name' => 'Bob', '65'));`
Returns: Bob is 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
@param string $str A string containing variable placeholders
@param string $data A key => val array where each key stands for a placeholder variable name
to be replaced with val
@param string $options An array of options, see description above
@return string
@access public
@static