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

excerpt

line:285 at /cake/libs/view/helpers/text.php
Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.

Method

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

Parameters

ParameterTypeCommentDefault
$text string required String to search the phrase in
$phrase string required Phrase that will be searched for
$radius integer optional The amount of characters that will be returned on each side of the founded phrase 100
$ending string optional Ending that will be appended '...'

Return

string

Comment

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

@param string $text String to search the phrase in
@param string $phrase Phrase that will be searched for
@param integer $radius The amount of characters that will be returned on each side of the founded phrase
@param string $ending Ending that will be appended
@return string Modified string
@access public
@link http://book.cakephp.org/view/1469/Text#excerpt-1621