EditableLiteralField

Complexity

Total Complexity

11

Size/Duplication

Total Lines	150
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	9

Test Coverage

Coverage

66.67%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getEditorConfig()	0	8	2
A	sanitiseContent()	0	13	2
A	getContent()	0	6	1
A	setContent()	0	6	1
A	getFormField()	0	16	1
A	showInReports()	0	4	1
A	getCMSFields()	0	22	1
A	updateFormField()	0	10	2

<?php

/**
 * Editable Literal Field. A literal field is just a blank slate where
 * you can add your own HTML / Images / Flash
 *
 * @package userforms
 */

class EditableLiteralField extends EditableFormField

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    private static $singular_name = 'HTML Block';

The property $singular_name is not used and could be removed.

Consider using a different property name as you override a private property of the parent class.

    private static $plural_name = 'HTML Blocks';

The property $plural_name is not used and could be removed.

Consider using a different property name as you override a private property of the parent class.

    /**
     * Mark as literal only
     *
     * @config
     * @var bool
     */
    private static $literal = true;

Consider using a different property name as you override a private property of the parent class.

The property $literal is not used and could be removed.

    /**
     * Get the name of the editor config to use for HTML sanitisation. Defaults to the active config.
     *
     * @var string
     * @config
     */
    private static $editor_config = null;

The property $editor_config is not used and could be removed.

    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'Content' => 'HTMLText', // From CustomSettings
        'HideFromReports' => 'Boolean(0)', // from CustomSettings
        'HideLabel' => 'Boolean(0)'
    );

    private static $defaults = array(

Consider using a different property name as you override a private property of the parent class.

The property $defaults is not used and could be removed.

        'HideFromReports' => false
    );

    /**
     * Returns the {@see HtmlEditorConfig} instance to use for sanitisation
     *
     * @return HtmlEditorConfig
     */
    protected function getEditorConfig()
    {
        $editorConfig = $this->config()->editor_config;
        if ($editorConfig) {
            return HtmlEditorConfig::get($editorConfig);
        }
        return HtmlEditorConfig::get_active();
    }

    /**
     * Safely sanitise html content, if enabled
     *
     * @param string $content Raw html
     * @return string Safely sanitised html
     */
    protected function sanitiseContent($content)
    {
        // Check if sanitisation is enabled
        if (!HtmlEditorField::config()->sanitise_server_side) {
            return $content;
        }

        // Perform sanitisation
        $htmlValue = Injector::inst()->create('HTMLValue', $content);
        $santiser = Injector::inst()->create('HtmlEditorSanitiser', $this->getEditorConfig());
        $santiser->sanitise($htmlValue);
        return $htmlValue->getContent();
    }

    /**
     * Get HTML Content of this literal field
     *
     * @return string
     */
    public function getContent()
    {
        // Apply html editor sanitisation rules
        $content = $this->getField('Content');
        return $this->sanitiseContent($content);
    }

    /**
     * Set the content with the given value
     *
     * @param string $content
     */
    public function setContent($content)
    {
        // Apply html editor sanitisation rules
        $content = $this->sanitiseContent($content);
        $this->setField('Content', $content);
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName(array('Default', 'Validation', 'RightTitle'));

        $fields->addFieldsToTab('Root.Main', array(
            HTMLEditorField::create('Content', _t('EditableLiteralField.CONTENT', 'HTML'))
                ->setRows(4)
                ->setColumns(20),
            CheckboxField::create(
                'HideFromReports',
                _t('EditableLiteralField.HIDEFROMREPORT', 'Hide from reports?')
            ),
            CheckboxField::create(
                'HideLabel',
                _t('EditableLiteralField.HIDELABEL', "Hide 'Title' label on frontend?")
            )
        ));

        return $fields;
    }

    public function getFormField()
    {
        $content = LiteralField::create(
            "LiteralFieldContent-{$this->ID}]",
            $this->dbObject('Content')->forTemplate()
        );

        $field = CompositeField::create($content)
            ->setName($this->Name)
            ->setID($this->Name)
            ->setFieldHolderTemplate('UserFormsLiteralField_holder');

        $this->doUpdateFormField($field);

        return $field;
    }

    protected function updateFormField($field)
    {
        parent::updateFormField($field);

        if ($this->HideLabel) {

The property HideLabel does not exist on object<EditableLiteralField>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->ExtraClass .= ' nolabel';

The property ExtraClass does not exist on object<EditableLiteralField>. Since you implemented __set, maybe consider adding a @property annotation.

        } else {
            $field->setTitle($this->Title);
        }
    }

    public function showInReports()
    {
        return ! $this->HideFromReports;

The property HideFromReports does not exist on object<EditableLiteralField>. Since you implemented __get, maybe consider adding a @property annotation.

    }
}