Romm\Formz\Middleware\AbstractMiddleware

Complexity

Total Complexity

7

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	initialize()	0	4	1
A	execute()	0	14	3
	process()	0	1	?
A	getNextMiddleware()	0	4	1
A	wasExecuted()	0	4	1

<?php
/*
 * 2017 Romain CANON <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 Formz project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\Formz\Middleware;

use Romm\Formz\Exceptions\ExecutionDoneException;

abstract class AbstractMiddleware implements MiddlewareInterface
{
    /**
     * @var MiddlewareInterface
     */
    private $nextMiddleware;

    /**
     * @var bool
     */
    private $wasExecuted = false;

    /**
     * @param MiddlewareInterface $nextMiddleware
     */
    final public function __construct(MiddlewareInterface $nextMiddleware)
    {
        $this->nextMiddleware = $nextMiddleware;
    }

    /**
     * @todo
     */
    final protected function initialize()
    {
        // @todo add options handling
    }

    /**
     * Executes the life-workflow of the middleware: first it is initialized,
     * then processed, and at the end the next middleware is executed if it was
     * not done previously.
     */
    final public function execute()
    {
        if (true === $this->wasExecuted) {
            throw ExecutionDoneException::middlewareAlreadyExecuted($this);
        }

        $this->initialize();
        $this->process();
        $this->wasExecuted = true;

        if (false === $this->nextMiddleware->wasExecuted()) {
            $this->nextMiddleware->execute();
        }
    }

    /**
     * Wrapper used by this abstract class to give more flexibility to the
     * function `execute`.
     *
     * Implement it in own child classes to execute the main logic of the
     * middleware.
     *
     * @return void
     */
    abstract protected function process();

    /**
     * @return MiddlewareInterface
     */
    final public function getNextMiddleware()
    {
        return $this->nextMiddleware;
    }

    /**
     * @return bool
     */
    final public function wasExecuted()
    {
        return $this->wasExecuted;
    }
}