FilterChain.php

<?php
/*
 * This file has its roots as part of the Mojavi package which was
 * Copyright (c) 2003 Sean Kerr. It has been incorporated into this
 * derivative work under the terms of the LGPL V2.1.
 * (http://www.gnu.org/licenses/lgpl-2.1.html)
 */

namespace Xmf\Xadr;

/**
 * FilterChain controls the sequence of Filter execution.
 *
 * @category  Xmf\Xadr\FilterChain
 * @package   Xmf
 * @author    Richard Griffith <richard@geekwright.com>
 * @author    Sean Kerr <skerr@mojavi.org>
 * @copyright 2013-2015 XOOPS Project (http://xoops.org)
 * @copyright 2003 Sean Kerr
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      http://xoops.org
 */
class FilterChain extends \SplQueue
{

    /**
     * Execute the next filter in the chain.
     *
     *  _This method should never be called manually._
     *
     * @return void
     */
    public function execute()
    {
        if ($this->count() > 0) {
            $this->dequeue()->execute($this);
        }
    }

    /**
     * Register a filter.
     *
     * @param Filter $filter A Filter instance.
     *
     * @return void
     */
    public function register(Filter $filter)
    {
        $this->enqueue($filter);
    }
}