AbstractElement.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Form\Domain\Model\Element;

abstract class AbstractElement {

    const ELEMENT_TYPE_FORM = 'FORM';

    const ELEMENT_TYPE_PLAIN = 'PLAIN';

    const ELEMENT_TYPE_CONTENT = 'CONTENT';
    protected $elementId;

    protected $elementType = self::ELEMENT_TYPE_FORM;

    protected $name;

    protected $acceptsParentName = FALSE;

    protected $attributes;

    protected $additional;

    protected $layout;

    protected $value;

    protected $data;

    protected $allowedAdditional = array(
        'label',
        'legend'
    );

    protected $mandatoryAttributes = array();

    protected $allowedAttributes = array();

    protected $localCobj;

    protected $requestHandler;

    protected $elementCounter;

    protected $validateClass;

    protected $filter;

    public function __construct() {
        $this->localCobj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
        $this->requestHandler = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\Request');
        $this->validateClass = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\Utility\\ValidatorUtility');
        $this->elementCounter = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\ElementCounter');
        $this->setElementId();
        $this->createAttributes();
        $this->createAdditional();
        $this->createFilter();
    }

    public function setElementId() {
        $this->elementId = $this->elementCounter->getElementId();
    }

    public function getElementId() {
        return $this->elementId;
    }

    public function getElementType() {
        return $this->elementType;
    }

    public function setName($name = '') {
        if (is_string($name) === FALSE) {
            $name = '';
        }
        if ($name !== '') {
            $this->name = $name;
        } else {
            $this->name = 'id-' . $this->getElementId();
        }
    }

    public function getName() {
        return $this->name;
    }

    public function acceptsParentName() {
        return $this->acceptsParentName;
    }

    public function setAttribute($attribute, $value) {
        if (array_key_exists($attribute, $this->allowedAttributes)) {
            $this->attributes->addAttribute($attribute, $value);
        }
        return $this;
    }

    public function getAllowedAttributes() {
        return $this->allowedAttributes;
    }

    public function getMandatoryAttributes() {
        return $this->mandatoryAttributes;
    }

    public function hasAllowedAttributes() {
        return empty($this->allowedAttributes) === FALSE;
    }

    public function hasAllowedAdditionals() {
        return empty($this->allowedAdditional) === FALSE;
    }

    public function getAllowedAdditionals() {
        return $this->allowedAdditional;
    }

    public function getAttributes() {
        return $this->attributes->getAttributes();
    }

    public function hasAttribute($key) {
        return $this->attributes->hasAttribute($key);
    }

    public function getAttributeValue($key) {
        return $this->attributes->getValue($key);
    }

    public function getAdditional() {
        return $this->additional->getAdditional();
    }

    public function getAdditionalObjectByKey($key) {
        return $this->additional->getAdditionalObjectByKey($key);
    }

    public function getAdditionalValue($key) {
        return $this->additional->getValue($key);
    }

    protected function createAttributes() {
        $className = 'TYPO3\\CMS\\Form\\Domain\\Model\\Attribute\\AttributesAttribute';
        $this->attributes = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance($className, $this->elementId);
    }

    public function setLayout($layout = '') {
        $this->layout = (string) $layout;
    }

    public function getLayout() {
        return $this->layout;
    }

    public function setValue($value = '') {
        $this->value = (string) $value;
    }

    public function getValue() {
        return $this->value;
    }

    public function setData($data = '') {
        $this->data = (string) $data;
    }

    public function setMessagesFromValidation() {
        if ($this->validateClass->hasMessage($this->getName())) {
            $messages = $this->validateClass->getMessagesByName($this->getName());
            $this->setAdditional('mandatory', 'COA', $messages);
        }
    }

    public function setErrorsFromValidation() {
        if ($this->validateClass->hasErrors($this->getName())) {
            $errors = $this->validateClass->getErrorsByName($this->getName());
            $this->setAdditional('error', 'COA', $errors);
        }
    }

    public function setAdditional($additional, $type, $value) {
        $this->additional->addAdditional($additional, $type, $value);
        return $this;
    }

    public function additionalIsSet($key) {
        return $this->additional->additionalIsSet($key);
    }

    protected function createAdditional() {
        $className = 'TYPO3\\CMS\\Form\\Domain\\Model\\Additional\\AdditionalAdditionalElement';
        $this->additional = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance($className);
    }

    public function setAdditionalLayout($key, $layout) {
        $this->additional->setLayout($key, $layout);
    }

    protected function createFilter() {
        $this->filter = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\Utility\\FilterUtility');
    }

    public function makeFilter($class, $arguments = array()) {
        $filter = $this->filter->makeFilter($class, $arguments);
        return $filter;
    }

    public function addFilter($filter) {
        $this->filter->addFilter($filter);
    }

    public function checkFilterAndSetIncomingDataFromRequest() {
        return $this;
    }

}