silverstripe-framework/forms/DatalessField.php

75 lines
1.6 KiB
PHP
Raw Normal View History

<?php
/**
* Abstract class for all fields without data.
* Labels, headings and the like should extend from this.
*
* @package forms
* @subpackage fields-dataless
*/
class DatalessField extends FormField {
/**
* @var bool $allowHTML
*/
protected $allowHTML;
/**
* @param string $name
* @param string $title The label itslef
* @param string $class An HTML class to apply to the label (Deprecated: use addExtraClass())
* @param boolean $allowHTML Determine if the tag content needs to be escaped (Deprecated: use setAllowHTML())
* @param Form $form
*/
function __construct($name, $title = null, $className = "", $allowHTML = false, $form = null) {
if($className) $this->extraClasses = array($className);
$this->allowHTML = $allowHTML;
parent::__construct($name, $title, null, $form);
}
/**
* Function that returns whether this field contains data.
* Always returns false.
*/
function hasData() { return false; }
/**
* Returns the field's representation in the form.
* For dataless fields, this defaults to $Field.
*/
function FieldHolder() {
return $this->Field();
}
/**
* Returns the field's representation in a field group.
* For dataless fields, this defaults to $Field.
*/
function SmallFieldHolder() {
return $this->Field();
}
/**
* Returns a readonly version of this field
*/
function performReadonlyTransformation() {
$clone = clone $this;
$clone->setReadonly(true);
return $clone;
}
/**
* @param bool $bool
*/
function setAllowHTML($bool) {
$this->allowHTML = $bool;
}
/**
* @return bool
*/
function getAllowHTML() {
return $this->allowHTML;
}
}
?>