silverstripe-framework/forms/LiteralField.php
2014-08-19 09:17:15 +12:00

77 lines
1.4 KiB
PHP

<?php
/**
* This field lets you put an arbitrary piece of HTML into your forms.
*
* <b>Usage</b>
*
* <code>
* new LiteralField (
* $name = "literalfield",
* $content = '<b>some bold text</b> and <a href="http://silverstripe.com">a link</a>'
* )
* </code>
*
* @package forms
* @subpackage fields-dataless
*/
class LiteralField extends DatalessField {
/**
* @var string $content
*/
protected $content;
public function __construct($name, $content) {
$this->content = $content;
parent::__construct($name);
}
public function FieldHolder($properties = array()) {
if(is_object($this->content)) {
$obj = $this->content;
if($properties)
$obj = $obj->customise($properties);
return $obj->forTemplate();
} else {
return $this->content;
}
}
public function Field($properties = array()) {
return $this->FieldHolder($properties);
}
/**
* Sets the content of this field to a new value
*
* @param string $content
*/
public function setContent($content) {
$this->content = $content;
return $this;
}
/**
* @return string
*/
public function getContent() {
return $this->content;
}
/**
* Synonym of {@link setContent()} so that LiteralField is more compatible with other field types.
*/
public function setValue($value) {
$this->setContent($value);
return $this;
}
public function performReadonlyTransformation() {
$clone = clone $this;
$clone->setReadonly(true);
return $clone;
}
}