diff --git a/en/appendices/6-0-migration-guide.rst b/en/appendices/6-0-migration-guide.rst index 7f64ab0603..26bf9d71ae 100644 --- a/en/appendices/6-0-migration-guide.rst +++ b/en/appendices/6-0-migration-guide.rst @@ -16,3 +16,9 @@ Behavior Changes ``JsonType`` by default. - ``Cake\View\Widget\FileWidget`` was removed as it was redundant. The standard input widget will be used for file inputs in 6.x. + +Breaking Changes +================ +- The default placeholder format for ``Text::insert()`` has been changed. + They are now of the form ``{foo}`` instead of ``:foo``. You can get the old + behavior by using the ``before`` and ``after`` keys of ``$options``. diff --git a/en/core-libraries/text.rst b/en/core-libraries/text.rst index 16c60c3a30..3238e11c1c 100644 --- a/en/core-libraries/text.rst +++ b/en/core-libraries/text.rst @@ -129,18 +129,18 @@ The insert method is used to create string templates and to allow for key/value replacements:: Text::insert( - 'My name is :name and I am :age years old.', + 'My name is {name} and I am {age} years old.', ['name' => 'Bob', 'age' => '65'] ); // Returns: "My name is Bob and I am 65 years old." .. php:staticmethod:: cleanInsert($string, $options = []) -Cleans up a ``Text::insert`` formatted string with given ``$options`` depending +Cleans up a ``Text::insert()`` formatted 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 unneeded markup around placeholders that did not get replaced by -``Text::insert``. +``Text::insert()``. You can use the following options in the options array::