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

highlight

line:61 at /cake/libs/view/helpers/text.php
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.

Method

(string) highlight ($text, $phrase, $options = array())

Parameters

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

Return

string

Comment

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

@param string $text Text to search the phrase in
@param string $phrase The phrase that will be searched
@param array $options An array of html attributes and options.
@return string The highlighted text
@access public
@link http://book.cakephp.org/view/1469/Text#highlight-1622