Vectorface\SnappyRouter\Plugin\AbstractControllerPlugin

Complexity

Total Complexity

4

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	beforeControllerSelected()	0	5	1
A	afterControllerSelected()	0	7	1
A	beforeActionInvoked()	0	7	1
A	afterActionInvoked()	0	8	1

<?php

namespace Vectorface\SnappyRouter\Plugin;

use Vectorface\SnappyRouter\Controller\AbstractController;
use Vectorface\SnappyRouter\Handler\AbstractHandler;
use Vectorface\SnappyRouter\Request\HttpRequest;

/**
 * The base class for all controller-based plugins.
 * @copyright Copyright (c) 2014, VectorFace, Inc.
 * @author Dan Bruce <dbruce@vectorface.com>
 */
abstract class AbstractControllerPlugin extends AbstractPlugin implements ControllerPluginInterface
{
    /**
     * Invoked before the handler decides which controller will be used.
     * @param AbstractHandler $handler The handler selected by the router.
     * @param HttpRequest $request The request to be handled.
     */
    public function beforeControllerSelected(
        AbstractHandler $handler,
        HttpRequest $request
    ) {
    }

    /**
     * Invoked after the router has decided which controller will be used.
     * @param AbstractHandler $handler The handler selected by the router.
     * @param HttpRequest $request The request to be handled.
     * @param AbstractController $controller The controller determined to be used.
     * @param string $action The name of the action that will be invoked.
     */
    public function afterControllerSelected(
        AbstractHandler $handler,
        HttpRequest $request,
        AbstractController $controller,
        $action
    ) {
    }

    /**
     * Invoked before the handler invokes the selected action.
     * @param AbstractHandler $handler The handler selected by the router.
     * @param HttpRequest $request The request to be handled.
     * @param AbstractController $controller The controller determined to be used.
     * @param string $action The name of the action that will be invoked.
     */
    public function beforeActionInvoked(
        AbstractHandler $handler,
        HttpRequest $request,
        AbstractController $controller,
        $action
    ) {
    }

    /**
     * Invoked after the handler invoked the selected action.
     * @param AbstractHandler $handler The handler selected by the router.
     * @param HttpRequest $request The request to be handled.
     * @param AbstractController $controller The controller determined to be used.
     * @param string $action The name of the action that will be invoked.
     * @param mixed $response The response from the controller action.
     */
    public function afterActionInvoked(
        AbstractHandler $handler,
        HttpRequest $request,
        AbstractController $controller,
        $action,
        $response
    ) {
    }
}