Docs For Class DatalessField

Inheritance: Object < ViewableData < RequestHandler < FormField < DatalessField

Summary: Abstract class for all fields without data.

Methods

public `constructor __construct ( $name, [$title = null], [$className = ""], [$allowHTML = false], [$form = null] )`
public `FieldHolder ( )`	Returns the field's representation in the form.
public `getAllowHTML ( )`
public `hasData ( )`	Function that returns whether this field contains data.
public `performReadonlyTransformation ( )`	Returns a readonly version of this field
public `setAllowHTML ( $bool )`
public `SmallFieldHolder ( )`	Returns the field's representation in a field group.

Inherited Methods

public `FormField::__construct()`
public `FormField::addExtraClass()`
public `FormField::attrName()`
public `FormField::attrTitle()`
public `FormField::attrValue()`
public `FormField::createTag()`
public `FormField::dataValue()`
public `FormField::debug()`
public `FormField::describe()`
public `FormField::extraClass()`
public `FormField::Field()`
public `FormField::FieldHolder()`
public `FormField::forTemplate()`
public `FormField::getCustomValidationMessage()`
public `FormField::getForm()`
public `FormField::getTabIndex()`
protected `FormField::getTabIndexHTML()`
public `FormField::hasClass()`
public `FormField::hasData()`
public `FormField::id()`
public `FormField::isComposite()`
public `FormField::isDisabled()`
public `FormField::isReadonly()`
public `FormField::jsValidation()`
public `FormField::LeftTitle()`
public `FormField::Link()`
public `FormField::Message()`
public `FormField::MessageType()`
public `FormField::Name()`
public `FormField::name_to_label()`
public `FormField::performDisabledTransformation()`
public `FormField::performReadonlyTransformation()`
public `FormField::removeExtraClass()`
public `FormField::Required()`
public `FormField::RightTitle()`
public `FormField::rootFieldSet()`
public `FormField::saveInto()`
public `FormField::securityTokenEnabled()`
public `FormField::setContainerFieldSet()`
public `FormField::setCustomValidationMessage()`
public `FormField::setDisabled()`
public `FormField::setError()`
public `FormField::setForm()`
public `FormField::setLeftTitle()`
public `FormField::setName()`
public `FormField::setReadonly()`
public `FormField::setRightTitle()`
public `FormField::setTabIndex()`
public `FormField::setTitle()`
public `FormField::setValue()`
public `FormField::SmallFieldHolder()`
public `FormField::Title()`
public `FormField::transform()`
public `FormField::Type()`
public `FormField::validate()`
public `FormField::Value()`
public `RequestHandler::__construct()`
public `RequestHandler::allowedActions()`
public `RequestHandler::checkAccessAction()`
public `RequestHandler::getRequest()`
public `RequestHandler::handleRequest()`
public `RequestHandler::hasAction()`
public `RequestHandler::httpError()`
public `ViewableData::ATT_val()`
public `ViewableData::BaseHref()`
public `ViewableData::buildCastingCache()`
public `ViewableData::cachedCall()`
public `ViewableData::castingClass()`
public `ViewableData::castingHelper()`
public `ViewableData::castingHelperPair()`
public `ViewableData::castingObjectCreator()`
public `ViewableData::castingObjectCreatorPair()`
public `ViewableData::CSSClasses()`
public `ViewableData::CurrentMember()`
public `ViewableData::CurrentPage()`
public `ViewableData::customise()`
public `ViewableData::Debug()`
public `ViewableData::defineMethods()`
public `ViewableData::escapeTypeForField()`
public `ViewableData::Even()`
public `ViewableData::EvenOdd()`
public `ViewableData::First()`
public `ViewableData::FirstLast()`
public `ViewableData::getField()`
public `ViewableData::getIterator()`
public `ViewableData::getSecurityID()`
public `ViewableData::getXMLValues()`
public `ViewableData::hasField()`
public `ViewableData::HasPerm()`
public `ViewableData::hasValue()`
public `ViewableData::i18nLocale()`
public `ViewableData::IsAjax()`
public `ViewableData::iteratorProperties()`
public `ViewableData::JS_val()`
public `ViewableData::Last()`
public `ViewableData::Me()`
public `ViewableData::Middle()`
public `ViewableData::MiddleString()`
public `ViewableData::Modulus()`
public `ViewableData::MultipleOf()`
public `ViewableData::obj()`
public `ViewableData::Odd()`
public `ViewableData::Pos()`
public `ViewableData::RAW_val()`
public `ViewableData::renderWith()`
public `ViewableData::setCustomisedObj()`
public `ViewableData::setField()`
public `ViewableData::SQL_val()`
public `ViewableData::ThemeDir()`
public `ViewableData::Top()`
public `ViewableData::TotalItems()`
public `ViewableData::XML_val()`
public `ViewableData::__get()`
public `ViewableData::__isset()`
public `ViewableData::__set()`
public `Object::__construct()`
protected `Object::addMethodsFrom()`
public `Object::addStaticVars()`
protected `Object::addWrapperMethod()`
public `Object::add_extension()`
public `Object::add_static_var()`
public `Object::allMethodNames()`
public `Object::cacheToFile()`
public `Object::cacheToFileWithArgs()`
public `Object::clearCache()`
public `Object::combined_static()`
public `Object::create()`
protected `Object::createMethod()`
public `Object::create_from_string()`
protected `Object::defineMethods()`
public `Object::exists()`
public `Object::extend()`
public `Object::extInstance()`
public `Object::getCustomClass()`
public `Object::getExtensionInstance()`
public `Object::getExtensionInstances()`
public `Object::get_extensions()`
public `Object::get_static()`
public `Object::hasExtension()`
public `Object::hasMethod()`
public `Object::has_extension()`
public `Object::invokeWithExtensions()`
public `Object::is_a()`
protected `Object::loadCache()`
public `Object::parentClass()`
public `Object::parse_class_spec()`
public `Object::remove_extension()`
protected `Object::sanitiseCachename()`
protected `Object::saveCache()`
public `Object::set_stat()`
public `Object::set_static()`
public `Object::set_uninherited()`
public `Object::stat()`
public `Object::strong_create()`
public `Object::uninherited()`
public `Object::uninherited_static()`
public `Object::useCustomClass()`
public `Object::__call()`
public `Object::__toString()`

Variables

protected $allowHTML

Inherited Variables

protected `FormField::$containerFieldSet`
protected `FormField::$customValidationMessage`
protected `FormField::$description`
protected `FormField::$disabled`
public `FormField::$dontEscape`
protected `FormField::$extraClass`
protected `FormField::$extraClasses`
protected `FormField::$form`
protected `FormField::$leftTitle`
protected `FormField::$message`
protected `FormField::$messageType`
protected `FormField::$name`
protected `FormField::$readonly`
protected `FormField::$rightTitle`
protected `FormField::$tabIndex`
protected `FormField::$title`
protected `FormField::$value`
public `RequestHandler::$allowed_actions`
protected `RequestHandler::$brokenOnConstruct`
protected `RequestHandler::$request`
public `RequestHandler::$url_handlers`
public `ViewableData::$casting`
protected `ViewableData::$customisedObject`
public `ViewableData::$default_cast`
protected `ViewableData::$failover`
protected `ViewableData::$iteratorPos`
protected `ViewableData::$iteratorTotalItems`
public `Object::$class`
public `Object::$extensions`
protected `Object::$extension_instances`

Constants

(none)

public __construct ¶

DatalessField __construct( string $name, [string $title = null], [ $className = ""], [boolean $allowHTML = false], [Form $form = null], string $class)

[line 23]

Overridden in child classes as:
HeaderField::__construct() LiteralField::__construct() LabelField::__construct()

Overrides FormField::__construct() (Create a new field.)

Parameters:

string $name -
string $title - The label itslef
string $class - An HTML class to apply to the label (Deprecated: use addExtraClass())
boolean $allowHTML - Determine if the tag content needs to be escaped (Deprecated: use setAllowHTML())
Form $form -
$className -

[ Top ]

public FieldHolder ¶

void FieldHolder( )

[line 40]

Returns the field's representation in the form.

For dataless fields, this defaults to $Field.

Overridden in child classes as:
LiteralField::FieldHolder()

Overrides FormField::FieldHolder() (Returns a "Field Holder" for this field - used by templates.)

[ Top ]

public getAllowHTML ¶

bool getAllowHTML( )

[line 71]

[ Top ]

public hasData ¶

void hasData( )

[line 34]

Function that returns whether this field contains data.

Always returns false.

Overrides FormField::hasData() (Returns true if this field has its own data.)

[ Top ]

public performReadonlyTransformation ¶

void performReadonlyTransformation( )

[line 55]

Returns a readonly version of this field

Overridden in child classes as:
LiteralField::performReadonlyTransformation()

Overrides FormField::performReadonlyTransformation() (Returns a readonly version of this field)

[ Top ]

public setAllowHTML ¶

void setAllowHTML( bool $bool)

[line 64]

Parameters:

bool $bool -

[ Top ]

public SmallFieldHolder ¶

void SmallFieldHolder( )

[line 48]

Returns the field's representation in a field group.

For dataless fields, this defaults to $Field.

Overrides FormField::SmallFieldHolder() (Returns a restricted field holder used within things like FieldGroups.)

[ Top ]

protected static $allowHTML ¶

[line 14]

Type: bool

[ Top ]

API Documentation

Packages:

Classes:

Files:

Class: DatalessField

Methods

Inherited Methods

Variables

Inherited Variables

Constants

Child classes:

Class Details

Class Methods

public __construct ¶

Parameters:

public FieldHolder ¶

public getAllowHTML ¶

public hasData ¶

public performReadonlyTransformation ¶

public setAllowHTML ¶

Parameters:

public SmallFieldHolder ¶

Class Variables

protected static $allowHTML ¶

Comments