CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.0 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.0
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Auth
    • Core
    • Error
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
    • Network
      • Email
      • Http
    • Routing
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • AppHelper
  • CacheHelper
  • FormHelper
  • HtmlHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • MootoolsEngineHelper
  • NumberHelper
  • PaginatorHelper
  • PrototypeEngineHelper
  • RssHelper
  • SessionHelper
  • TextHelper
  • TimeHelper

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
Copyright: Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/View/Helper/TextHelper.php

Properties summary

  • $helpers public
    array
    helpers

Magic properties summary

  • $Html public
    HtmlHelper

Inherited Properties

  • _View, _association, _cleaned, _entityPath, _fieldSuffixes, _helperMap, _modelScope, _tainted, fieldset, plugin, request, tags, theme

Method Summary

  • _linkBareUrl() protected
    Links urls that include http://
  • _linkEmails() protected
    Links email addresses
  • _linkUrls() protected
    Links urls missing http://
  • autoLink() public
    Convert all links and email addresses to HTML links.
  • autoLinkEmails() public
    Adds email links (<a href="mailto:....) to a given text.
  • autoLinkUrls() public

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

  • 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=....)
  • toList() public
    Creates a comma separated list where the last two items are joined with 'and', forming natural English
  • truncate() public
    Truncates text.

Method Detail

_linkBareUrl() protected ¶

_linkBareUrl( array $matches )

Links urls that include http://

Parameters
array $matches
Returns
string
See
TextHelper::autoLinkUrls()

_linkEmails() protected ¶

_linkEmails( array $matches )

Links email addresses

Parameters
array $matches
Returns
string
See
TextHelper::autoLinkUrls()

_linkUrls() protected ¶

_linkUrls( array $matches )

Links urls missing http://

Parameters
array $matches
Returns
string
See
TextHelper::autoLinkUrls()

autoLink() public ¶

autoLink( string $text , array $options = array() )

Convert all links and email addresses to HTML links.

Parameters
string $text
Text
array $options optional array()
Array of HTML options.
Returns
string
The text with links
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLink

autoLinkEmails() public ¶

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

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

Parameters
string $text
Text
array $options optional array()
Array of HTML options.
Returns
string
The text with links
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkEmails

autoLinkUrls() public ¶

autoLinkUrls( string $text , array $htmlOptions = array() )

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

Parameters
string $text
Text to add links to
array $htmlOptions optional array()
Array of HTML options.
Returns
string
The text with links
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkUrls

excerpt() 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
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::excerpt

highlight() 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.

Options:

  • format The piece of html with that the phrase will be highlighted
  • html If true, will ignore any HTML tags, ensuring that only the correct text is highlighted
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
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::highlight

stripLinks() public ¶

stripLinks( string $text )

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

Parameters
string $text
Text
Returns
string
The text without links
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::stripLinks

toList() public ¶

toList( array $list , string $and = 'and' , string $separator = ', ' )

Creates a comma separated list where the last two items are joined with 'and', forming natural English

Parameters
array $list
The list to be joined
string $and optional 'and'
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.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::toList

truncate() 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 ending if the text is longer than length.

Options:

  • ending Will be used as Ending and appended to the trimmed string
  • 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.
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::truncate

Methods inherited from Helper

__call() public ¶

__call( string $method , array $params )

Provide non fatal errors on missing method calls.

Parameters
string $method
Method to invoke
array $params
Array of params for the method.

__construct() public ¶

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

Default Constructor

Parameters
View $View
The View this helper is being attached to.
array $settings optional array()
Configuration settings for the helper.
Overrides
Object::__construct()

__get() public ¶

__get( string $name )

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

Parameters
string $name
Name of the property being accessed.
Returns
mixed
Helper or property found at $name

__set() public ¶

__set( string $name , mixed $value )

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

Parameters
string $name
Name of the property being accessed.
mixed $value
Returns
mixed
Return the $value

_clean() protected ¶

_clean( )

Removes harmful content from output

_formatAttribute() protected deprecated ¶

_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
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() 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. Will also add a 'form-error' class if the field contains validation errors.

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() protected ¶

_name( mixed $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
mixed $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
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() protected deprecated ¶

_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:

  • 'compact'
  • 'checked'
  • 'declare'
  • 'readonly'
  • 'disabled'
  • 'selected'
  • 'defer'
  • 'ismap'
  • 'nohref'
  • 'noshade'
  • 'nowrap'
  • 'multiple'
  • 'noresize'

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
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() protected ¶

_reset( )

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

_selectedArray() protected ¶

_selectedArray( mixed $data , string $key = 'id' )

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

Parameters
mixed $data
string $key optional 'id'
Returns
array

addClass() 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 classname being added.
string $key optional 'class'
the key to use for class.
Returns
array
Array of options with $key set.

afterLayout() 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() 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.

assetTimestamp() 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.

beforeLayout() 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() 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

clean() public ¶

clean( mixed $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.

Parameters
mixed $output
Either an array of strings to clean or a single string to clean.
Returns
string|array
cleaned content for output

domId() public ¶

domId( mixed $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
mixed $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() 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() 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() public ¶

model( )

Gets the currently-used model of the rendering context.

Returns
string

output() public deprecated ¶

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
This method will be removed in future versions.
Parameters
string $str
String to be output.
Returns
string

setEntity() public ¶

setEntity( mixed $entity , boolean $setScope = false )

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

Parameters
mixed $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() public ¶

url( mixed $url = null , boolean $full = false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters
mixed $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() public ¶

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

Gets the data for the current tag

Parameters
mixed $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
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() 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() 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 Set::normalize() before merging.

_set() 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() 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() 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() public ¶

log( string $msg , integer $type = LOG_ERROR )

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_ERROR
Error type constant. Defined in app/Config/core.php.
Returns
boolean
Success of log write

requestAction() public ¶

requestAction( mixed $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
mixed $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() public ¶

toString( )

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

Returns
string
The name of this class

Properties detail

$helpers ¶

public array

helpers

array('Html')

Magic properties detail

$Html ¶

public HtmlHelper
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs