Class CakeText
String handling methods.
Direct Subclasses
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Utility/CakeText.php
Method Summary
-
_wordWrap() protected static
Helper method for wordWrap(). -
cleanInsert() public static
Cleans up a CakeText::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 CakeText::insert().
-
excerpt() public static
Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
-
highlight() public static
Highlights a given phrase in a text. You can specify any expression in highlighter that may include the \1 expression to include the $phrase found.
-
insert() public static
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:
CakeText::insert(':name is :age years old.', array('name' => 'Bob', '65'));Returns: Bob is 65 years old. -
stripLinks() public static
Strips given text of all links (<a href=....). -
tail() public static
Truncates text starting from the end. -
toList() public static
Creates a comma separated list where the last two items are joined with 'and', forming natural language. -
tokenize() public static
Tokenizes a string using $separator, ignoring any instance of $separator that appears between $leftBound and $rightBound.
-
truncate() public static
Truncates text. -
uuid() public static
Generate a random UUID -
wordWrap() public static
Unicode aware version of wordwrap. -
wrap() public static
Wraps text to a specific width, can optionally wrap at word breaks.
Method Detail
_wordWrap() protected static ¶
_wordWrap( string $text , integer $width = 72 , string $break = "\n" , boolean $cut = false )
Helper method for wordWrap().
Parameters
- string $text
- The text to format.
- integer $width optional 72
- The width to wrap to. Defaults to 72.
- string $break optional "\n"
- The line is broken using the optional break parameter. Defaults to '\n'.
- boolean $cut optional false
- If the cut is set to true, the string is always wrapped at the specified width.
Returns
Formatted text.
cleanInsert() public static ¶
cleanInsert( string $str , array $options )
Cleans up a CakeText::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 CakeText::insert().
Parameters
- string $str
- CakeText to clean.
- array $options
- Options list.
Returns
See
excerpt() public static ¶
excerpt( string $text , string $phrase , integer $radius = 100 , string $ellipsis = '...' )
Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
Parameters
- string $text
- CakeText to search the phrase in
- string $phrase
- Phrase that will be searched for
- integer $radius optional 100
- The amount of characters that will be returned on each side of the founded phrase
- string $ellipsis optional '...'
- Ending that will be appended
Returns
Modified string
Link
highlight() public static ¶
highlight( string $text , string|array $phrase , array $options = array() )
Highlights a given phrase in a text. You can specify any expression in highlighter that may include the \1 expression to include the $phrase found.
Options:
formatThe piece of html with that the phrase will be highlightedhtmlIf true, will ignore any HTML tags, ensuring that only the correct text is highlightedregexa custom regex rule that is used to match words, default is '|$tag|iu'
Parameters
- string $text
- Text to search the phrase in.
- string|array $phrase
- The phrase or phrases that will be searched.
- array $options optional array()
- An array of html attributes and options.
Returns
The highlighted text
Link
insert() public static ¶
insert( string $str , array $data , array $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: CakeText::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 CakeText::cleanInsert
Parameters
- string $str
- A string containing variable placeholders
- array $data
A key => val array where each key stands for a placeholder variable name to be replaced with val
- array $options optional array()
- An array of options, see description above
Returns
stripLinks() public static ¶
stripLinks( string $text )
Strips given text of all links (<a href=....).
Parameters
- string $text
- Text
Returns
The text without links
Link
tail() public static ¶
tail( string $text , integer $length = 100 , array $options = array() )
Truncates text starting from the end.
Cuts a string to the length of $length and replaces the first characters with the ellipsis if the text is longer than length.
Options:
ellipsisWill be used as Beginning and prepended to the trimmed stringexactIf false, $text will not be cut mid-word
Parameters
- string $text
- CakeText to truncate.
- integer $length optional 100
- Length of returned string, including ellipsis.
- array $options optional array()
- An array of options.
Returns
Trimmed string.
toList() public static ¶
toList( array $list , string $and = null , string $separator = ', ' )
Creates a comma separated list where the last two items are joined with 'and', forming natural language.
Parameters
- array $list
- The list to be joined.
- string $and optional null
- The word used to join the last and second last items together with. Defaults to 'and'.
- string $separator optional ', '
- The separator used to join all the other items together. Defaults to ', '.
Returns
The glued together string.
Link
tokenize() public static ¶
tokenize( string $data , string $separator = ',' , string $leftBound = '(' , string $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.
- string $leftBound optional '('
- The left boundary to ignore separators in.
- string $rightBound optional ')'
- The right boundary to ignore separators in.
Returns
Array of tokens in $data or original input if empty.
truncate() public static ¶
truncate( string $text , integer $length = 100 , array $options = array() )
Truncates text.
Cuts a string to the length of $length and replaces the last characters with the ellipsis if the text is longer than length.
Options:
ellipsisWill be used as Ending and appended to the trimmed string (endingis deprecated)exactIf false, $text will not be cut mid-wordhtmlIf true, HTML tags would be handled correctly
Parameters
- string $text
- CakeText to truncate.
- integer $length optional 100
- Length of returned string, including ellipsis.
- array $options optional array()
- An array of html attributes and options.
Returns
Trimmed string.
Link
uuid() public static ¶
uuid( )
Generate a random UUID
Returns
RFC 4122 UUID
See
wordWrap() public static ¶
wordWrap( string $text , integer $width = 72 , string $break = "\n" , boolean $cut = false )
Unicode aware version of wordwrap.
Parameters
- string $text
- The text to format.
- integer $width optional 72
- The width to wrap to. Defaults to 72.
- string $break optional "\n"
- The line is broken using the optional break parameter. Defaults to '\n'.
- boolean $cut optional false
- If the cut is set to true, the string is always wrapped at the specified width.
Returns
Formatted text.
wrap() public static ¶
wrap( string $text , array|integer $options = array() )
Wraps text to a specific width, can optionally wrap at word breaks.
Options
widthThe width to wrap to. Defaults to 72.wordWrapOnly wrap on words breaks (spaces) Defaults to true.indentCakeText to indent with. Defaults to null.indentAt0 based index to start indenting at. Defaults to 0.
Parameters
- string $text
- The text to format.
- array|integer $options optional array()
- Array of options to use, or an integer to wrap the text to.
Returns
Formatted text.