Class TextHelper

Text helper library.

Text manipulations: Highlight, excerpt, truncate, strip of links, convert email addresses to mailto: links...

Object
Extended by Helper
Extended by AppHelper
Extended by TextHelper
Package: Cake\View\Helper
Link: http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html
See: String
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/View/Helper/TextHelper.php

Properties summary

  • $_engine protected
    stdClass
    CakeText utility instance
  • $_placeholders protected
    array

    An array of md5sums and their contents. Used when inserting links into text.

  • $helpers public
    array
    helpers

Magic properties summary

Inherited Properties

Method Summary

  • __call() public
    Call methods from CakeText utility class
  • __construct() public
    Constructor
  • Saves the placeholder for a string, for later use. This gets around double escaping content in URL's.

  • _linkEmails() protected
    Links email addresses
  • _linkUrls() protected
    Replace placeholders with links.
  • autoLink() public
    Convert all links and email addresses to HTML links.
  • Adds email links (<a href="mailto:....) to a given text.
  • Adds links (<a href=....) to a given text, by finding text that begins with strings like http:// and ftp://.

  • Formats paragraphs around given text for all line breaks
    added for single line return

    <

    p> added for double line return

  • excerpt() public

    Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.

  • highlight() public

    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.

  • stripLinks() public
    Strips given text of all links (<a href=....)
  • tail() public
    Truncates text starting from the end.
  • toList() public
    Creates a comma separated list where the last two items are joined with 'and', forming natural language.
  • truncate() public
    Truncates text.

Method Detail

__call()source public

__call( string $method , array $params )

Call methods from CakeText utility class

Parameters

string $method
Method to call.
array $params
Parameters to pass to method.

Returns

mixed
Whatever is returned by called method, or false on failure

Overrides

Helper::__call()

__construct()source public

__construct( View $View , array $settings array() )

Constructor

Settings:

  • engine Class name to use to replace CakeText functionality. The class needs to be placed in the Utility directory.

Parameters

View $View
the view object the helper is attached to.
array $settings optional array()
Settings array Settings array

Throws

CakeException
when the engine class could not be found.

Overrides

Helper::__construct()

_insertPlaceHolder()source protected

_insertPlaceHolder( array $matches )

Saves the placeholder for a string, for later use. This gets around double escaping content in URL's.

Parameters

array $matches
An array of regexp matches.

Returns

string
Replaced values.

_linkEmails()source protected

_linkEmails( string $text , array $options )

Links email addresses

Parameters

string $text
The text to operate on
array $options
An array of options to use for the HTML.

Returns

string

See

TextHelper::autoLinkEmails()

_linkUrls()source protected

_linkUrls( string $text , array $htmlOptions )

Replace placeholders with links.

Parameters

string $text
The text to operate on.
array $htmlOptions
The options for the generated links.

Returns

string
The text with links inserted.
autoLink( string $text , array $options array() )

Convert all links and email addresses to HTML links.

Options

  • escape Control HTML escaping of input. Defaults to true.

Parameters

string $text
Text
array $options optional array()
Array of HTML options, and options listed above.

Returns

string
The text with links

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLink

autoLinkEmails()source public

autoLinkEmails( string $text , array $options array() )

Adds email links (<a href="mailto:....) to a given text.

Options

  • escape Control HTML escaping of input. Defaults to true.

Parameters

string $text
Text
array $options optional array()
Array of HTML options, and options listed above.

Returns

string
The text with links

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkEmails

autoLinkUrls()source public

autoLinkUrls( string $text , array $options array() )

Adds links (<a href=....) to a given text, by finding text that begins with strings like http:// and ftp://.

Options

  • escape Control HTML escaping of input. Defaults to true.

Parameters

string $text
Text
array $options optional array()
Array of HTML options, and options listed above.

Returns

string
The text with links

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkUrls

autoParagraph()source public

autoParagraph( string $text )

Formats paragraphs around given text for all line breaks
added for single line return

<

p> added for double line return

Parameters

string $text
Text

Returns

string

The text with proper

<

p> and
tags


Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoParagraph

excerpt()source public

excerpt( string $text , string $phrase , integer $radius 100 , string $ending '...' )

Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.

Parameters

string $text
String 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 $ending optional '...'
Ending that will be appended

Returns

string
Modified string

See

CakeText::excerpt()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::excerpt

highlight()source public

highlight( string $text , string $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.

Parameters

string $text
Text to search the phrase in
string $phrase
The phrase that will be searched
array $options optional array()
An array of html attributes and options.

Returns

string
The highlighted text

See

CakeText::highlight()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::highlight
stripLinks( string $text )

Strips given text of all links (<a href=....)

Parameters

string $text
Text

Returns

string
The text without links

See

CakeText::stripLinks()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::stripLinks

tail()source public

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:

  • ellipsis Will be used as Beginning and prepended to the trimmed string
  • exact If false, $text will not be cut mid-word

Parameters

string $text
String to truncate.
integer $length optional 100
Length of returned string, including ellipsis.
array $options optional array()
An array of html attributes and options.

Returns

string
Trimmed string.

See

CakeText::tail()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::tail

toList()source public

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

string
The glued together string.

See

CakeText::toList()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::toList

truncate()source public

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:

  • ellipsis Will be used as Ending and appended to the trimmed string (ending is deprecated)
  • exact If false, $text will not be cut mid-word
  • html If true, HTML tags would be handled correctly

Parameters

string $text
String to truncate.
integer $length optional 100
Length of returned string, including ellipsis.
array $options optional array()
An array of html attributes and options.

Returns

string
Trimmed string.

See

CakeText::truncate()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::truncate

Methods inherited from Helper

__get()source public

__get( string $name )

Lazy loads helpers. Provides access to deprecated request properties as well.

Deprecated

3.0.0 Accessing request properties through this method is deprecated and will be removed in 3.0.

Parameters

string $name
Name of the property being accessed.

Returns

mixed
Helper or property found at $name

__set()source public

__set( string $name , mixed $value )

Provides backwards compatibility access for setting values to the request object.

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

string $name
Name of the property being accessed.
mixed $value
Value to set.

_clean()source protected

_clean( )

Removes harmful content from output

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message
Message to be displayed
string $okCode
Code to be executed after user chose 'OK'
string $cancelCode optional ''
Code to be executed after user chose 'Cancel', also executed when okCode doesn't return
array $options optional array()
Array of options

Returns

string
onclick JS code

_encodeUrl()source protected

_encodeUrl( string $url )

Encodes a URL for use in HTML attributes.

Parameters

string $url
The URL to encode.

Returns

string
The URL encoded for both URL & HTML contexts.

_formatAttribute()source protected

_formatAttribute( string $key , string $value , boolean $escape true )

Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

Parameters

string $key
The name of the attribute to create
string $value
The value of the attribute to create.
boolean $escape optional true
Define if the value must be escaped

Returns

string
The composed attribute.

_initInputField()source protected

_initInputField( string $field , array $options array() )

Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes.

Parameters

string $field
The field name to initialize.
array $options optional array()
Array of options to use while initializing an input field.

Returns

array
Array options for the form input.

_name()source protected

_name( array|string $options array() , string $field null , string $key 'name' )

Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.

Parameters

array|string $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null
Field name.
string $key optional 'name'
The name of the attribute to be set, defaults to 'name'

Returns

mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.


_parseAttributes()source protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of those listed in Helper::$_minimizedAttributes

And its value is one of:

  • '1' (string)
  • 1 (integer)
  • true (boolean)
  • 'true' (string)

Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.

'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.

If value for any option key is set to null or false, that option will be excluded from output.

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

Parameters

array $options
Array of options.
array $exclude optional null
Array of options to be excluded, the options here will not be part of the return.
string $insertBefore optional ' '
String to be inserted before options.
string $insertAfter optional null
String to be inserted after options.

Returns

string
Composed attributes.

_reset()source protected

_reset( )

Resets the vars used by Helper::clean() to null

_selectedArray()source protected

_selectedArray( string|array $data , string $key 'id' )

Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element

Parameters

string|array $data
Data array or model name.
string $key optional 'id'
Field name.

Returns

array

addClass()source public

addClass( array $options array() , string $class null , string $key 'class' )

Adds the given class to the element options

Parameters

array $options optional array()
Array options/attributes to add a class to
string $class optional null
The class name being added.
string $key optional 'class'
the key to use for class.

Returns

array
Array of options with $key set.

afterLayout()source public

afterLayout( string $layoutFile )

After layout callback. afterLayout is called after the layout has rendered.

Overridden in subclasses.

Parameters

string $layoutFile
The layout file that was rendered.

afterRender()source public

afterRender( string $viewFile )

After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.

Overridden in subclasses.

Parameters

string $viewFile
The view file that was rendered.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

After render file callback. Called after any view fragment is rendered.

Overridden in subclasses.

Parameters

string $viewFile
The file just be rendered.
string $content
The content that was rendered.

assetTimestamp()source public

assetTimestamp( string $path )

Adds a timestamp to a file based resource based on the value of Asset.timestamp in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp === 'force' a timestamp will be added.

Parameters

string $path
The file path to timestamp, the path must be inside WWW_ROOT

Returns

string
Path with a timestamp added, or not.

assetUrl()source public

assetUrl( string|array $path , array $options array() )

Generate URL for given asset file. Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files

Parameters

string|array $path
Path string or URL array
array $options optional array()

Options array. Possible keys: fullBase Return full URL with domain name pathPrefix Path prefix for relative URLs ext Asset extension to append plugin False value will prevent parsing path as a plugin

Returns

string
Generated URL

beforeLayout()source public

beforeLayout( string $layoutFile )

Before layout callback. beforeLayout is called before the layout is rendered.

Overridden in subclasses.

Parameters

string $layoutFile
The layout about to be rendered.

beforeRender()source public

beforeRender( string $viewFile )

Before render callback. beforeRender is called before the view file is rendered.

Overridden in subclasses.

Parameters

string $viewFile
The view file that is going to be rendered

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

Before render file callback. Called before any view fragment is rendered.

Overridden in subclasses.

Parameters

string $viewFile
The file about to be rendered.

clean()source public

clean( string|array $output )

Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possibilities. Escaping content is the best way to prevent all possible attacks.

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

string|array $output
Either an array of strings to clean or a single string to clean.

Returns

string|array|null
Cleaned content for output

domId()source public

domId( array|string $options null , string $id 'id' )

Generates a DOM ID for the selected element, if one is not set. Uses the current View::entity() settings to generate a CamelCased id attribute.

Parameters

array|string $options optional null

Either an array of html attributes to add $id into, or a string with a view entity path to get a domId for.

string $id optional 'id'
The name of the 'id' attribute.

Returns

mixed

If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.


entity()source public

entity( )

Returns the entity reference of the current context as an array of identity parts

Returns

array
An array containing the identity elements of an entity

field()source public

field( )

Gets the currently-used model field of the rendering context. Strips off field suffixes such as year, month, day, hour, min, meridian when the current entity is longer than 2 elements.

Returns

string

model()source public

model( )

Gets the currently-used model of the rendering context.

Returns

string

output()source public

output( string $str )

Returns a string generated by a helper method

This method can be overridden in subclasses to do generalized output post-processing

Deprecated

3.0.0 This method will be removed in future versions.

Parameters

string $str
String to be output.

Returns

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Sets this helper's model and field properties to the dot-separated value-pair in $entity.

Parameters

string $entity
A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"
boolean $setScope optional false
Sets the view scope to the model specified in $tagValue

url()source public

url( string|array $url null , boolean $full false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters

string|array $url optional null

Either a relative string url like /products/view/23 or an array of URL parameters. Using an array for URLs will allow you to leverage the reverse routing features of CakePHP.

boolean $full optional false
If true, the full base URL will be prepended to the result

Returns

string
Full translated URL with base path.

Link

http://book.cakephp.org/2.0/en/views/helpers.html

value()source public

value( array|string $options array() , string $field null , string $key 'value' )

Gets the data for the current tag

Parameters

array|string $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null
Field name.
string $key optional 'value'
The name of the attribute to be set, defaults to 'value'

Returns

mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.


webroot()source public

webroot( string $file )

Checks if a file exists when theme is used, if no file is found default location is returned

Parameters

string $file
The file to create a webroot path to.

Returns

string
Web accessible path to file.

Methods inherited from Object

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Parameters

array $properties
The name of the properties to merge.
string $class
The class to merge the property with.
boolean $normalize optional true
Set to true to run the properties through Hash::normalize() before merging.

_set()source protected

_set( array $properties array() )

Allows 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.

_stop()source protected

_stop( integer|string $status 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

integer|string $status optional 0
see http://php.net/exit for values

dispatchMethod()source 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

Parameters

string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters

string $msg
Log message
integer $type optional LOG_ERR
Error type constant. Defined in app/Config/core.php.
null|string|array $scope optional null

The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.

Returns

boolean
Success of log write

requestAction()source public

requestAction( string|array $url , array $extra array() )

Calls 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.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

string|array $url

String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.

array $extra optional array()

if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.


toString()source public

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

$_enginesource

protected stdClass

CakeText utility instance

$_placeholderssource

protected array

An array of md5sums and their contents. Used when inserting links into text.

array()

$helperssource

public array

helpers

array('Html')

Magic properties detail

$Htmlsource

public HtmlHelper

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-TextHelper.html