LiteralField

Complexity

Total Complexity

10

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	1	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	FieldHolder()	0	13	3
A	Field()	0	3	1
A	setContent()	0	5	1
A	getContent()	0	3	1
A	setValue()	0	5	1
A	performReadonlyTransformation()	0	7	1
A	getSchemaStateDefaults()	0	7	1

<?php

/**
 * This field lets you put an arbitrary piece of HTML into your forms.
 *
 * <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 {

	private static $casting = [
		'Value' => 'HTMLFragment',
	];

	/**
	 * @var string|FormField
	 */
	protected $content;

	protected $schemaDataType = self::SCHEMA_DATA_TYPE_STRUCTURAL;

	protected $schemaComponent = 'LiteralField';

	/**
	 * @param string $name
	 * @param string|FormField $content
	 */
	public function __construct($name, $content) {
		$this->setContent($content);

		parent::__construct($name);
	}

	/**
	 * @param array $properties
	 *
	 * @return string
	 */
	public function FieldHolder($properties = array()) {
		if($this->content instanceof ViewableData) {
			$context = $this->content;

			if($properties) {

The expression $properties of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

				$context = $context->customise($properties);
			}

			return $context->forTemplate();

The method forTemplate does only exist in FormField, but not in ViewableData_Customised.

		}

		return $this->content;
	}

	/**
	 * @param array $properties
	 *
	 * @return string
	 */
	public function Field($properties = array()) {
		return $this->FieldHolder($properties);
	}

	/**
	 * Sets the content of this field to a new value.
	 *
	 * @param string|FormField $content
	 *
	 * @return $this
	 */
	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.
	 *
	 * @param string|FormField $content
	 *
	 * @return $this
	 */
	public function setValue($content) {
		$this->setContent($content);

		return $this;
	}

	/**
	 * @return static
	 */
	public function performReadonlyTransformation() {
		$clone = clone $this;

		$clone->setReadonly(true);

		return $clone;
	}

	/**
	 * Header fields support dynamic titles via schema state
	 *
	 * @return array
	 */
	public function getSchemaStateDefaults() {
		$state = parent::getSchemaStateDefaults();

		$state['data']['content'] = $this->FieldHolder();

		return $state;
	}
}