horros / agavi2

src/controller/Controller.class.php

<?php

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// | Based on the Mojavi3 MVC Framework, Copyright (c) 2003-2005 Sean Kerr.    |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+
namespace Agavi\Controller;

use Agavi\Core\Context;
use Agavi\Dispatcher\ExecutionContainer;
use Agavi\Request\RequestDataHolder;

/**
 * Controller allows you to separate application and business logic from your
 * presentation. By providing a core set of methods used by the framework,
 * automation in the form of security and validation can occur.
 *
 * @package    agavi
 * @subpackage controller
 *
 * @author     Sean Kerr <skerr@mojavi.org>
 * @author     David Zülke <dz@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.9.0
 *
 * @version    $Id$
 */
abstract class Controller
{
    /**
     * @var        ExecutionContainer This controller's execution container.
     */
    protected $container = null;

    /**
     * @var        Context A Context instance.
     */
    protected $context = null;

    /**
     * Retrieve the current application context.
     *
     * @return     Context The current Context instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    final public function getContext()
    {
        return $this->context;
    }

    /**
     * Retrieve the execution container for this controller.
     *
     * @return     ExecutionContainer This controller's execution container.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    final public function getContainer()
    {
        return $this->container;
    }

    /**
     * Retrieve the credential required to access this controller.
     *
     * @return     mixed Data that indicates the level of security for this
     *                   controller.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function getCredentials()
    {
        return null;
    }

    /**
     * Execute any post-validation error application logic.
     *
     * @param      RequestDataHolder $rd The controller's request data holder.
     *
     * @return     mixed A string containing the view name associated with this
     *                   controller.
     *                   Or an array with the following indices:
     *                   - The parent module of the view that will be executed.
     *                   - The view that will be executed.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function handleError(RequestDataHolder $rd)

The parameter $rd is not used and could be removed.

    {
        return 'Error';
    }

    /**
     * Initialize this controller.
     *
     * @param      ExecutionContainer $container This Controller's execution container.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function initialize(ExecutionContainer $container)
    {
        $this->container = $container;

        $this->context = $container->getContext();
    }

    /**
     * Indicates that this controller requires security.
     *
     * @return     bool true, if this controller requires security, otherwise false.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function isSecure()
    {
        return false;
    }

    /**
     * Whether or not this controller is "simple", i.e. does not use validation etc.
     *
     * @return     bool true, if this controller should act in simple mode, or false.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function isSimple()
    {
        return false;
    }

    /**
     * Manually register validators for this controller.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function registerValidators()
    {
    }

    /**
     * Manually validate files and parameters.
     *
     * @param      RequestDataHolder $rd The controller's request data holder.
     *
     * @return     bool true, if validation completed successfully, otherwise
     *                  false.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function validate(RequestDataHolder $rd)

The parameter $rd is not used and could be removed.

    {
        return true;
    }

    /**
     * Get the default View name if this Controller doesn't serve the Request method.
     *
     * @return     mixed A string containing the view name associated with this
     *                   controller.
     *                   Or an array with the following indices:
     *                   - The parent module of the view that will be executed.
     *                   - The view that will be executed.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function getDefaultViewName()
    {
        return 'Input';
    }

    /**
     * @see        AttributeHolder::clearAttributes()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function clearAttributes()
    {
        $this->container->clearAttributes();
    }

    /**
     * @see        AttributeHolder::getAttribute()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function &getAttribute($name, $default = null)
    {
        return $this->container->getAttribute($name, null, $default);
    }

    /**
     * @see        AttributeHolder::getAttributeNames()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function getAttributeNames()
    {
        return $this->container->getAttributeNames();
    }

    /**
     * @see        AttributeHolder::getAttributes()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function &getAttributes()
    {
        return $this->container->getAttributes();
    }

    /**
     * @see        AttributeHolder::hasAttribute()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function hasAttribute($name)
    {
        return $this->container->hasAttribute($name);
    }

    /**
     * @see        AttributeHolder::removeAttribute()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function &removeAttribute($name)
    {
        return $this->container->removeAttribute($name);
    }

    /**
     * @see        AttributeHolder::setAttribute()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function setAttribute($name, $value)
    {
        $this->container->setAttribute($name, $value);
    }

    /**
     * @see        AttributeHolder::appendAttribute()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.10.0
     */
    public function appendAttribute($name, $value)
    {
        $this->container->appendAttribute($name, $value);
    }

    /**
     * @see        AttributeHolder::setAttributeByRef()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function setAttributeByRef($name, &$value)
    {
        $this->container->setAttributeByRef($name, $value);
    }

    /**
     * @see        AttributeHolder::appendAttributeByRef()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.10.0
     */
    public function appendAttributeByRef($name, &$value)
    {
        $this->container->appendAttributeByRef($name, $value);
    }

    /**
     * @see        AttributeHolder::setAttributes()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function setAttributes(array $attributes)
    {
        $this->container->setAttributes($attributes);
    }

    /**
     * @see        AttributeHolder::setAttributesByRef()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function setAttributesByRef(array &$attributes)
    {
        $this->container->setAttributesByRef($attributes);
    }
}