Version: current

# Class HTMLVarchar

Represents a short text field that is intended to contain HTML content.

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

  Object
  ViewableData implements IteratorAggregate
  DBField
  StringField
  Varchar
  HTMLVarchar

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

## Methods summary

`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 `Varchar::scaffoldFormField`
`public `FormField`` | # `scaffoldSearchField( string $title = null )` Returns a FormField instance used as a default for searchform scaffolding. Returns a FormField instance used as a default for searchform scaffolding. Used by `SearchContext`, `ModelAdmin`, `DataObject::scaffoldFormFields()`. #### Parameters $title string $title Optional. Localized title of the generated instance #### Returns ``FormField`` FormField #### Overrides `DBField::scaffoldSearchField`

### Methods inherited from Varchar

`Initial()`, `LimitCharacters()`, `RTF()`, `URL()`, `__construct()`, `requireField()`

### Methods inherited from StringField

`Lower()`, `Upper()`, `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 Varchar

`$size`

### Properties inherited from StringField

`$nullifyEmpty`

### Properties inherited from DBField

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

### Properties inherited from ViewableData

`$casting`, `$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. -