ntentan\honam\engines\php\helpers\form\Container

Complexity

Total Complexity

13

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	renderHead()	0	1	?
	renderFoot()	0	1	?
A	setRenderMode()	0	4	1
A	addElement()	0	5	1
A	add()	0	8	2
A	setData()	0	9	3
A	render()	0	13	3
A	getElements()	0	4	1
A	__toString()	0	4	1
A	isContainer()	0	4	1

<?php

/**
 * Containers for containing form elements
 * 
 * Ntentan Framework
 * Copyright (c) 2008-2012 James Ekow Abaka Ainooson
 * 
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 * 
 * @author James Ainooson <jainooson@gmail.com>
 * @copyright Copyright 2010 James Ekow Abaka Ainooson
 * @license MIT
 */

namespace ntentan\honam\engines\php\helpers\form;


/**
 * The container class. This abstract class provides the necessary
 * basis for implementing form element containers. The container
 * is a special element which contains other form elements.
 */
abstract class Container extends Element
{

    const RENDER_MODE_ALL = 'all';
    const RENDER_MODE_HEAD = 'head';
    const RENDER_MODE_FOOT = 'foot';

    protected $renderMode = self::RENDER_MODE_ALL;
    protected $elements = array();

    abstract protected function renderHead();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    abstract protected function renderFoot();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    
    public function setRenderMode($renderMode)
    {
        $this->renderMode = $renderMode;
    }

    private function addElement($element)
    {
        $this->elements[] = $element;
        $element->parent = $this;
    }

    /**
     * Method for adding an element to the form container.
     * @return Container
     */
    public function add()
    {
        $arguments = func_get_args();
        foreach ($arguments as $element) {
            $this->addElement($element);
        }
        return $this;
    }

    /**
     * This method sets the data for the fields in this container. The parameter
     * passed to this method is a structured array which has field names as keys
     * and the values as value.
     */
    public function setData($data)
    {
        if (is_array($data)) {
            foreach ($this->elements as $element) {
                $element->setData($data);
            }
        }
        return $this;
    }

    public function render()

The return type could not be reliably inferred; please add a @return annotation.

    {
        switch ($this->renderMode) {
            case self::RENDER_MODE_HEAD;
                return $this->renderHead();
            case self::RENDER_MODE_FOOT:
                return $this->renderFoot();
            default:
                return $this->renderHead() 
                    . TemplateEngine::render('elements.tpl.php', array('elements' => $this->getElements()))
                    . $this->renderFoot();
        }
    }

    //! Returns an array of all the Elements found in this container.
    public function getElements()
    {
        return $this->elements;
    }

    public function __toString()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->render();
    }

    public function isContainer()
    {
        return true;
    }

}