Agavi\Routing\RoutingCallback

Complexity

Total Complexity

5

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize()	0	5	1
A	getContext()	0	4	1
A	onMatched()	0	4	1
A	onNotMatched()	0	4	1
A	onGenerate()	0	4	1

<?php
namespace Agavi\Routing;

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// |                                                                           |
// | 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:                                                                    |
// +---------------------------------------------------------------------------+
use Agavi\Core\Context;
use Agavi\Dispatcher\ExecutionContainer;
use Agavi\Util\ParameterHolder;

/**
 * RoutingCallback allows you to provide callbacks into the routing
 *
 * @package    agavi
 * @subpackage routing
 *
 * @author     Dominik del Bondio <ddb@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.11.0
 *
 * @version    $Id$
 */
abstract class RoutingCallback extends ParameterHolder
{
    /**
     * @var        Context An Context instance.
     */
    protected $context = null;

    /**
     * @var        array An array with information about the route.
     */
    protected $route = null;

    /**
     * Initialize the callback instance.
     *
     * @param      Context $context A Context instance.
     * @param      array   $route An array with information about the route.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function initialize(Context $context, array &$route)
    {
        $this->context = $context;
        $this->route =& $route;
    }

    /**
     * Retrieve the current application context.
     *
     * @return     Context An Context instance.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    final public function getContext()
    {
        return $this->context;
    }

    /**
     * Gets executed when the route of this callback route matched.
     *
     * @param      array              $parameters The parameters generated by this route.
     * @param      ExecutionContainer $container The original execution container.
     *
     * @return     bool Whether the routing should handle the route as matched.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function onMatched(array &$parameters, ExecutionContainer $container)

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

    {
        return true;
    }

    /**
     * Gets executed when the route of this callback route did not match.
     *
     * @param      ExecutionContainer $container The original execution container.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function onNotMatched(ExecutionContainer $container)

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

    {
        return;
    }

    /**
     * Gets executed when the route of this callback is about to be reverse
     * generated into an URL.
     *
     * @param      array $defaultParameters The default parameters stored in the route.
     * @param      array $userParameters The parameters the user supplied to AgaviRouting::gen().
     * @param      array $userOptions The options the user supplied to AgaviRouting::gen().
     *
     * @return     bool  Whether this route part should be generated.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function onGenerate(array $defaultParameters, array &$userParameters, array &$userOptions)

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

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

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

    {
        return true;
    }
}