Version: current

# Class HTMLText

Represents a large text field that contains HTML content.

This behaves similarly to Text, but the template processor won't escape any HTML content within it.

  Object
  ViewableData implements IteratorAggregate
  DBField
  StringField
  Text
  HTMLText

Package: sapphire\model
Located at sapphire/core/model/fieldtypes/HTMLText.php

## Methods summary

`public string` | # `LimitCharacters( integer $limit = 20, string $add = "..." )` Limit this field's content by a number of characters. This makes use of strip_tags() to avoid malforming the HTML tags in the string of text. Limit this field's content by a number of characters. This makes use of strip_tags() to avoid malforming the HTML tags in the string of text. #### Parameters $limit int $limit Number of characters to limit by $add string $add Ellipsis to add to the end of truncated string #### Returns `string` string #### Overrides `Text::LimitCharacters`
`public string` | # `Summary( integer $maxWords = 50, integer $flex = 15, string $add = '...' )` Create a summary of the content. This will be some section of the first paragraph, limited by $maxWords. All internal tags are stripped out - the return value is a string Create a summary of the content. This will be some section of the first paragraph, limited by $maxWords. All internal tags are stripped out - the return value is a string This is sort of the HTML aware equivilent to Text#Summary, although the logic for summarising is not exactly the same #### Parameters $maxWords int $maxWords Maximum number of words to return - may return less, but never more. Pass -1 for no limit $flex int $flex Number of words to search through when looking for a nice cut point $add string $add What to add to the end of the summary if we cut at a less-than-ideal cut point #### Returns `string` A nice(ish) summary with no html tags (but possibly still some html entities) #### See sapphire/core/model/fieldtypes/Text#Summary($maxWords) #### Overrides `Text::Summary`
`public` | # `FirstSentence( )` Returns the first sentence from the first paragraph. If it can't figure out what the first paragraph is (or there isn't one) it returns the same as Summary() Returns the first sentence from the first paragraph. If it can't figure out what the first paragraph is (or there isn't one) it returns the same as Summary() This is the HTML aware equivilent to Text#FirstSentence #### See sapphire/core/model/fieldtypes/Text#FirstSentence() #### Overrides `Text::FirstSentence`
`public string` | # `forTemplate( )` #### Returns `string` string #### Overrides `DBField::forTemplate`
`public boolean` | # `hasValue( )` (non-PHPdoc) (non-PHPdoc) #### Returns `boolean` boolean #### See core/model/fieldtypes/DBField#hasValue() #### Overrides `StringField::hasValue`
`public `FormField`` | # `scaffoldFormField( string $title = null, mixed $params = null )` (non-PHPdoc) (non-PHPdoc) #### Parameters $title string $title Optional. Localized title of the generated instance $params #### Returns ``FormField`` FormField #### See ``DBField::scaffoldFormField()`` #### Overrides `Text::scaffoldFormField`
`public `FormField`` | # `scaffoldSearchField( string $title = null )` (non-PHPdoc) (non-PHPdoc) #### Parameters $title string $title Optional. Localized title of the generated instance #### Returns ``FormField`` FormField #### See ``DBField::scaffoldSearchField()`` #### Overrides `Text::scaffoldSearchField`

### Methods inherited from Text

`AbsoluteLinks()`, `BigSummary()`, `ContextSummary()`, `EscapeXML()`, `FirstParagraph()`, `LimitSentences()`, `LimitWordCount()`, `LimitWordCountXML()`, `NoHTML()`, `Parse()`, `requireField()`

### Methods inherited from StringField

`Lower()`, `Upper()`, `__construct()`, `getNullifyEmpty()`, `prepValueForDB()`, `setNullifyEmpty()`, `setOptions()`

### Methods inherited from DBField

`ATT()`, `HTML()`, `HTMLATT()`, `JS()`, `LowerCase()`, `RAW()`, `RAWURLATT()`, `URLATT()`, `UpperCase()`, `XML()`, `addToQuery()`, `create()`, `debug()`, `defaultSearchFilter()`, `exists()`, `getName()`, `getValue()`, `nullValue()`, `saveInto()`, `setName()`, `setTable()`, `setValue()`, `writeToManipulation()`

### Methods inherited from ViewableData

`ATT_val()`, `BaseHref()`, `CSSClasses()`, `ColumnBreak()`, `ColumnCalc()`, `ColumnNumber()`, `ColumnPad()`, `ColumnPos()`, `CurrentMember()`, `CurrentPage()`, `Debug()`, `Even()`, `EvenOdd()`, `First()`, `FirstLast()`, `HasPerm()`, `IsAjax()`, `JS_val()`, `Last()`, `Me()`, `Middle()`, `MiddleString()`, `Modulus()`, `MultipleOf()`, `Odd()`, `Pos()`, `RAW_val()`, `SQL_val()`, `ThemeDir()`, `ThemeName()`, `Top()`, `TotalItems()`, `XML_val()`, `__get()`, `__isset()`, `__set()`, `buildCastingCache()`, `cachedCall()`, `castingClass()`, `castingHelper()`, `castingHelperPair()`, `castingObjectCreator()`, `castingObjectCreatorPair()`, `customise()`, `defineMethods()`, `escapeTypeForField()`, `getField()`, `getIterator()`, `getSecurityID()`, `getXMLValues()`, `hasField()`, `i18nLocale()`, `iteratorProperties()`, `obj()`, `renderWith()`, `setCustomisedObj()`, `setField()`

### Methods inherited from Object

`__call()`, `__toString()`, `__wakeup()`, `addMethodsFrom()`, `addStaticVars()`, `addWrapperMethod()`, `add_extension()`, `add_static_var()`, `allMethodNames()`, `cacheToFile()`, `cacheToFileWithArgs()`, `clearCache()`, `combined_static()`, `createMethod()`, `create_from_string()`, `extInstance()`, `extend()`, `getCustomClass()`, `getExtensionInstance()`, `getExtensionInstances()`, `get_extensions()`, `get_static()`, `hasExtension()`, `hasMethod()`, `has_extension()`, `invokeWithExtensions()`, `is_a()`, `loadCache()`, `parentClass()`, `parse_class_spec()`, `remove_extension()`, `sanitiseCachename()`, `saveCache()`, `set_stat()`, `set_static()`, `set_uninherited()`, `stat()`, `strong_create()`, `uninherited()`, `uninherited_static()`, `useCustomClass()`

### Magic methods summary

## Properties summary

`public static string` | $escape_type | # The escape type for this field when inserted into a template - either "xml" or "raw". The escape type for this field when inserted into a template - either "xml" or "raw".

### Properties inherited from Text

`$casting`

### Properties inherited from StringField

`$nullifyEmpty`

### Properties inherited from DBField

`$arrayValue`, `$defaultVal`, `$default_search_filter_class`, `$name`, `$tableName`, `$value`

### Properties inherited from ViewableData

`$customisedObject`, `$default_cast`, `$failover`, `$iteratorPos`, `$iteratorTotalItems`

### Properties inherited from Object

`$class`, `$extension_instances`, `$extensions`

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -