Koch\Form\Elements\Textarea

Complexity

Total Complexity

27

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getEditor()	0	4	1
A	setCols()	0	6	1
A	setRows()	0	6	1
A	setName()	0	6	1
A	setEditorFormelement()	0	6	1
A	getEditorFormelement()	0	8	2
A	transferPropertiesToEditor()	0	16	1
A	setEditor()	0	17	3
A	getCols()	0	4	1
A	getRows()	0	4	1
A	editorFactory()	0	18	2
F	render()	0	41	11

<?php

/**
 * Koch Framework
 * Jens-André Koch © 2005 - onwards.
 *
 * This file is part of "Koch Framework".
 *
 * License: GNU/GPL v2 or any later version, see LICENSE file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace Koch\Form\Elements;

use Koch\Form\FormElement;
use Koch\Form\FormElementInterface;
use Koch\Functions\Functions;

/**
 * This class renders the formelement textarea.
 * It gives you the option to add a JavaScript WYSIWYG editor as textarea replacement.
 */
class Textarea extends FormElement implements FormElementInterface
{
    /**
     * Flag variable for the What-You-See-Is-What-You-Get Editor.
     *
     * There are several different wysiwyg editor formelements available:
     *
     * 1) Nicedit   -> wysiwygnicedit.php
     * 2) TinyMCE   -> wysiwygtinymce.php
     * 3) CKEditor  -> wysiwygckeditor.php
     * 4) markItUp  -> wysiwygmarkItUp.phg
     *
     * @var string
     */
    private $editor;

    /**
     * @var int width of textarea in letters
     */
    public $cols = 0;

    /**
     * @var int height of textarea in rows
     */
    public $rows = 0;

    /**
     * @var object of the wysiwyg editor
     */
    private $editorObject;

    public function __construct()
    {
        $this->type = 'textarea';

        return $this;

Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct?

    }

    public function setEditor($editor = null)
    {
        /*
         *  if no editor is given, take the one definied in the general configuration.
         *  the expected config setting is [editor] type.
         *  if the configuration value is not given, use "ckeditor" as fallback.
         */
        if ($editor === null) {
            $config = Clansuite_CMS::getInjector()->instantiate('Koch\Config');
            $editor = isset($config['editor']['type']) ? $config['editor']['type'] : 'ckeditor';
            unset($config);
        }

        $this->editor = mb_strtolower($editor);

        return $this;
    }

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

    /**
     * defines width of textarea.
     *
     * @param int $cols
     */
    public function setCols($cols)
    {
        $this->cols = $cols;

        return $this;
    }

    /**
     * get defined width of textarea.
     */
    public function getCols()
    {
        return $this->cols;
    }

    /**
     * define height of textarea in rows.
     *
     * @param int $rows
     */
    public function setRows($rows)
    {
        $this->rows = $rows;

        return $this;
    }

    /**
     * get defined height of textarea in rows.
     */
    public function getRows()
    {
        return $this->rows;
    }

    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    public function setEditorFormelement(FormelementInterface $editorObject)
    {
        $this->editorObject = $editorObject;

        return $this;
    }

    public function getEditorFormelement()
    {
        if (empty($this->editorObject)) {
            return $this->setEditorFormelement($this->editorFactory());
        } else {
            return $this->editorObject;
        }
    }

    /**
     * editorFactory
     * loads and instantiates an wysiwyg editor object.
     */
    private function editorFactory()
    {
        // build classname
        $name = 'Wysiwyg' . ucfirst($this->getEditor());

        // attach namespace
        $classname = 'Koch\Form\Elements\\' . $name;

        // load file
        if (class_exists($classname, false) === false) {
            include __DIR__ . '/' . $name . '.php';
        }

        // instantiate
        $editor_formelement = new $classname();

$editor_formelement does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        return $editor_formelement;

$editor_formelement does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }

    /**
     * At some point in the lifetime of this object
     * you decided that this textarea should be a wysiwyg editor.
     * The editorFactory will load the file and instantiate the editor object.
     * But you already defined some properties like Cols or Rows for this textarea.
     * Therefore it's now time to transfer these properties to the editor object.
     * Because we don't render this textarea, but the requested wysiwyg editor object.
     */
    private function transferPropertiesToEditor()
    {
        // get editor formelement
        $formelement = $this->getEditorFormelement();

        // transfer props from $this to editor formelement
        $formelement->setRequired($this->required);
        $formelement->setRows($this->rows);
        $formelement->setCols($this->cols);
        $formelement->setLabel($this->label);
        $formelement->setName($this->name);
        $formelement->setValue($this->value);

        // return the editor formelement, to call e.g. render() on it
        return $formelement;
    }

    /**
     * Renders a normal html textarea representation when
     * no wysiwyg editor object is attached to this textarea object.
     * Otherwise the html content of the wysiwyg editor is prepended
     * to the textarea html.!
     *
     * @return $html HTML Representation of an textarea

The doc-type $html could not be parsed: Unknown type name "$html" at position 0. (view supported doc-types)

     */
    public function render()
    {
        $html = '';

        /*
         * Opening of textarea tag
         */
        $html .= '<textarea';
        $html .= (bool) $this->id ? ' id="' . $this->id . '"' : null;
        $html .= (bool) $this->name ? ' name="' . $this->name . '"' : null;
        $html .= (bool) $this->size ? ' size="' . $this->size . '"' : null;
        $html .= (bool) $this->cols ? ' cols="' . $this->cols . '"' : null;
        $html .= (bool) $this->rows ? ' rows="' . $this->rows . '"' : null;
        $html .= (bool) $this->class ? ' class="' . $this->class . '"' : null;
        $html .= (bool) $this->disabled ? ' disabled="disabled"' : null;
        $html .= (bool) $this->maxlength ? ' maxlength="' . $this->maxlength . '"' : null;
        $html .= (bool) $this->style ? ' style="' . $this->style . '"' : null;
        $html .= '>';

        /*
         * Content between tags (value)
         */
        $html .= Functions::UTF8_to_HTML($this->getValue());

        /*
         * Closing of textarea tag
         */
        $html .= '</textarea>';

        /*
         * Attach HTML content of WYSIWYG Editor
         *
         * Always after the textarea !
         * Because html elements are served first, before javascript dom selections are applied upon them!
         */
        if (empty($this->editor) === false) {
            $html .= $this->getEditorFormelement()->transferPropertiesToEditor()->render();
        }

        return $html;
    }
}