silverstripe-framework/forms/DatalessField.php
2016-07-13 18:45:57 +12:00

83 lines
1.5 KiB
PHP

<?php
use SilverStripe\ORM\FieldType\DBHTMLText;
/**
* 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;
/**
* function that returns whether this field contains data.
* Always returns false.
*/
public function hasData() { return false; }
public function getAttributes() {
return array_merge(
parent::getAttributes(),
array(
'type' => 'hidden',
)
);
}
/**
* Returns the field's representation in the form.
* For dataless fields, this defaults to $Field.
*
* @return DBHTMLText
*/
public function FieldHolder($properties = array()) {
return $this->Field($properties);
}
/**
* Returns the field's representation in a field group.
* For dataless fields, this defaults to $Field.
*
* @return DBHTMLText
*/
public function SmallFieldHolder($properties = array()) {
return $this->Field($properties);
}
/**
* Returns a readonly version of this field
*/
public function performReadonlyTransformation() {
$clone = clone $this;
$clone->setReadonly(true);
return $clone;
}
/**
* @param bool $bool
* @return $this
*/
public function setAllowHTML($bool) {
$this->allowHTML = $bool;
return $this;
}
/**
* @return bool
*/
public function getAllowHTML() {
return $this->allowHTML;
}
public function Type() {
return 'readonly';
}
}