SilverStripe 3.0 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
Version: master
  • master
  • 3.1
  • 3.0
  • 2.4
  • tagfield

Packages

  • cms
    • assets
    • batchaction
    • batchactions
    • content
    • control
    • controller
    • controllers
    • core
    • export
    • filesystem
    • forms
    • model
    • publishers
    • reports
    • search
    • security
    • tasks
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • framework
    • admin
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • fields-relational
    • filesystem
    • formatters
    • forms
    • gridfield
    • i18n
    • injector
    • integration
    • manifest
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • validation
    • view
  • None
  • PHP

Classes

  • AjaxUniqueTextField
  • ConfirmedPasswordField
  • CreditCardField
  • CurrencyField
  • CurrencyField_Disabled
  • CurrencyField_Readonly
  • EmailField
  • HtmlEditorConfig
  • HtmlEditorField
  • HtmlEditorField_Readonly
  • HtmlEditorField_Toolbar
  • NumericField
  • PasswordField
  • PhoneNumberField

Class HtmlEditorField

A TinyMCE-powered WYSIWYG HTML editor field with image and link insertion and tracking capabilities. Editor fields are created from <textarea> tags, which are then converted with JavaScript.

Object
Extended by ViewableData implements IteratorAggregate
Extended by RequestHandler
Extended by FormField
Extended by TextareaField
Extended by HtmlEditorField
Package: forms\fields-formattedinput
Located at sapphire/forms/HtmlEditorField.php

Methods summary

public static
# include_js( )

Includes the JavaScript neccesary for this field to work using the Requirements system.

Includes the JavaScript neccesary for this field to work using the Requirements system.

public
# __construct( mixed $name, mixed $title = null, mixed $value = '' )

Parameters

$name
mixed
$name Field name
$title
mixed
$title Field title
$value
mixed
$value The current value

See

TextareaField::__construct()

Overrides

TextareaField::__construct
public string
# Field( array $properties = array() )

Parameters

$properties
array
$properties key value pairs of template variables

Returns

string

Overrides

FormField::Field
public array
# getAttributes( )

Returns

array

Overrides

TextareaField::getAttributes
public
# saveInto( DataObjectInterface $record )

Method to save this form field into the given data object. By default, makes use of $this->dataValue()

Method to save this form field into the given data object. By default, makes use of $this->dataValue()

Overrides

FormField::saveInto
public HtmlEditorField_Readonly
# performReadonlyTransformation( )

Returns

HtmlEditorField_Readonly

Overrides

FormField::performReadonlyTransformation
public FormField
# performDisabledTransformation( )

Performs a disabled transformation on this field. You shouldn't be able to copy from this field, and it should not send any data when you submit the form it's attached to.

Performs a disabled transformation on this field. You shouldn't be able to copy from this field, and it should not send any data when you submit the form it's attached to.

The element shouldn't be both disabled and readonly at the same time.

Returns

FormField

Overrides

TextareaField::performDisabledTransformation

Methods inherited from TextareaField

Type(), Value(), setColumns(), setRows()

Methods inherited from FormField

FieldHolder(), ID(), LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), addExtraClass(), attrTitle(), attrValue(), createTag(), dataValue(), debug(), describe(), extraClass(), forTemplate(), getAttribute(), getAttributesHTML(), getCustomValidationMessage(), getDescription(), getFieldHolderTemplate(), getFieldHolderTemplates(), getForm(), getName(), getSmallFieldHolderTemplate(), getSmallFieldHolderTemplates(), getTabIndex(), getTemplate(), getTemplates(), hasClass(), hasData(), isComposite(), isDisabled(), isReadonly(), name_to_label(), removeExtraClass(), rootFieldList(), rootFieldSet(), securityTokenEnabled(), setAttribute(), setContainerFieldList(), setContainerFieldSet(), setCustomValidationMessage(), setDescription(), setDisabled(), setError(), setFieldHolderTemplate(), setForm(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setSmallFieldHolderTemplate(), setTabIndex(), setTemplate(), setTitle(), setValue(), transform(), validate()

Methods inherited from RequestHandler

allowedActions(), checkAccessAction(), getRequest(), handleRequest(), hasAction(), httpError(), isAjax(), setDataModel(), setRequest()

Methods inherited from ViewableData

ATT_val(), CSSClasses(), Debug(), JS_val(), Me(), RAW_val(), SQL_val(), ThemeDir(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getXMLValues(), hasField(), hasValue(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), clearCache(), combined_static(), config(), create(), createMethod(), create_from_string(), exists(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_extra_config_sources(), 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(), static_lookup(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

public static Boolean $use_gzip
#

Use TinyMCE's GZIP compressor

Use TinyMCE's GZIP compressor

protected integer $rows
#

Visible number of text lines.

Visible number of text lines.

Properties inherited from TextareaField

$cols

Properties inherited from FormField

$attributes, $containerFieldList, $customValidationMessage, $description, $disabled, $dontEscape, $extraClass, $extraClasses, $fieldHolderTemplate, $form, $leftTitle, $message, $messageType, $name, $readonly, $rightTitle, $smallFieldHolderTemplate, $template, $title, $value

Properties inherited from RequestHandler

$allowed_actions, $brokenOnConstruct, $model, $request, $url_handlers

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover

Properties inherited from Object

$class, $extension_instances, $extensions

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.
blog comments powered by Disqus
SilverStripe 3.0 API Docs API documentation generated by ApiGen 2.8.0