cakephp-1.3 > TextHelper :: truncate()
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

truncate

line:184 at /cake/libs/view/helpers/text.php
Truncates text.

Method

(string) truncate ($text, $length = 100, $options = array())

Parameters

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

Return

string

Comment

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

@param string $text String to truncate.
@param integer $length Length of returned string, including ellipsis.
@param array $options An array of html attributes and options.
@return string Trimmed string.
@access public
@link http://book.cakephp.org/view/1469/Text#truncate-1625