Response.php

<?php

/**
 * The MIT License
 *
 * Copyright (c) 2010 - 2012 Tony R Quilkey <trq@proemframework.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


/**
 * @namespace Proem\Bootstrap\Filter\Event
 */
namespace Proem\Bootstrap\Filter\Event;

use Proem\Service\Manager\Template as Manager;
use Proem\Bootstrap\Signal\Event\Bootstrap;
use Proem\Service\Asset\Standard as Asset;
use Proem\IO\Response\Http\Standard as HTTPResponse;
use Proem\Filter\Event\Generic as Event;

/**
 * The default "Response" filter event.
 */
class Response extends Event
{
    /**
     * Called prior to inBound.
     *
     * A listener responding with an event containing a DI container holding an
     * implemention of the Proem\IO\Response\Template interface, will result in
     * that implementation being placed within the main service manager under
     * the index of *response*.
     *
     * @param Proem\Service\Manager\Template $assets
     * @triggers Proem\Bootstrap\Signal\Event\Bootstrap proem.pre.in.response
     */
    public function preIn(Manager $assets)
    {
        if ($assets->provides('events', 'Proem\Signal\Manager\Template')) {
            $assets->get('events')->trigger(
                (new Bootstrap('proem.pre.in.response'))->setServiceManager($assets),
                function ($response) use ($assets) {
                    if (
                        $response->has('response.asset') &&
                        $response->getParam('response.asset')->provides('Proem\IO\Response\Template')
                    ) {
                        $assets->set('response', $response->getParam('response.asset'));
                    }
                }
            );
        }
    }

    /**
     * Method to be called on the way into the filter.
     *
     * If not already provided, this method will add a default
     * Proem\IO\Response\Template implementation to the main service
     * manager under the index of *response*.
     *
     * @param Proem\Service\Manager\Template $assets
     */
    public function inBound(Manager $assets)
    {
        if (!$assets->provides('Proem\IO\Response\Template')) {
            $asset = new Asset;
            $assets->set(
                'response',
                $asset->set(
                    'Proem\IO\Response\Template',
                    $asset->single(
                        function () {
                            return new HTTPResponse;
                        }
                    )
                )
            );
        }
    }

    /**
     * Called after outBound.
     *
     * @param Proem\Service\Manager\Template $assets
     * @triggers Proem\Bootstrap\Signal\Event\Bootstrap proem.post.in.response
     */
    public function postIn(Manager $assets)
    {
        if ($assets->provides('events', 'Proem\Signal\Manager\Template')) {
            $assets->get('events')->trigger((new Bootstrap('proem.post.in.response'))->setServiceManager($assets));
        }
    }

    /**
     * Called prior to outBound.
     *
     * @param Proem\Service\Manager\Template $assets
     * @triggers Proem\Bootstrap\Signal\Event\Bootstrap proem.pre.out.response
     */
    public function preOut(Manager $assets)
    {
        if ($assets->provides('events', 'Proem\Signal\Manager\Template')) {
            $assets->get('events')->trigger((new Bootstrap('proem.pre.out.response'))->setServiceManager($assets));
        }
    }

    /**
     * Method to be called on the way out of the filter.
     *
     * This method is responseible for sending the response
     * to the client.
     *
     * @see Proem\IO\Response\Template
     * @param Proem\Service\Manager\Template $assets
     * @triggers Proem\Bootstrap\Signal\Event\Bootstrap proem.pre.in.response
     */
    public function outBound(Manager $assets)
    {
        if ($assets->provides('Proem\IO\Response\Template')) {
            $assets->get('response')->send();
        }
    }

    /**
     * Called after outBound.
     *
     * @param Proem\Service\Manager\Template $assets
     * @triggers Proem\Bootstrap\Signal\Event\Bootstrap proem.post.out.response
     */
    public function postOut(Manager $assets)
    {
        if ($assets->provides('events', 'Proem\Signal\Manager\Template')) {
            $assets->get('events')->trigger((new Bootstrap('proem.post.out.response'))->setServiceManager($assets));
        }
    }
}