BeSimpleSoap/src/BeSimple/SoapCommon/SoapKernel.php

<?php

/*
 * This file is part of the BeSimpleSoapCommon.
 *
 * (c) Christian Kerl <christian-kerl@web.de>
 * (c) Francis Besset <francis.besset@gmail.com>
 * (c) Andreas Schamberger <mail@andreass.net>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace BeSimple\SoapCommon;

use BeSimple\SoapCommon\SoapRequest;
use BeSimple\SoapCommon\SoapResponse;

use BeSimple\SoapCommon\SoapRequestFilter;
use BeSimple\SoapCommon\SoapResponseFilter;

/**
 * SoapKernel provides methods to pre- and post-process SoapRequests and SoapResponses using
 * chains of SoapRequestFilter and SoapResponseFilter objects (roughly following 
 * the chain-of-responsibility pattern).
 * 
 * @author Christian Kerl <christian-kerl@web.de>
 */
class SoapKernel
{
    private $requestFilters = array();
    private $responseFilters = array();
    
    /**
     * Registers the given object either as filter for SoapRequests or as filter for SoapResponses 
     * or as filter for both depending on the implemented interfaces. Inner filters have to be registered
     * before outer filters. This means the order is as follows: RequestFilter2->RequestFilter1 and 
     * ResponseFilter1->ResponseFilter2.
     * 
     * TODO: add priority mechanism to ensure correct order of filters
     * 
     * @param SoapRequestFilter|SoapResponseFilter $filter
     */
    public function registerFilter($filter)
    {   
        if($filter instanceof SoapRequestFilter)
        {
            array_unshift($this->requestFilters, $filter);
        }
        
        if($filter instanceof SoapResponseFilter)
        {
            array_push($this->responseFilters, $filter);
        }
    }
    
    /**
     * Applies all registered SoapRequestFilter to the given SoapRequest. 
     * 
     * @param SoapRequest $request
     */
    public function filterRequest(SoapRequest $request)
    {
        foreach($this->requestFilters as $filter)
        {
            $filter->filterRequest($request);
        }
    }
    
    /**
     * Applies all registered SoapResponseFilter to the given SoapResponse. 
     * 
     * @param SoapResponse $response
     */
    public function filterResponse(SoapResponse $response)
    {
        foreach($this->responseFilters as $filter)
        {
            $filter->filterResponse($response);
        }
    }
}