MvcTools/src/result_types/external_redirect.php

<?php
/**
 * File containing the ezcMvcExternalRedirect class.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @package MvcTools
 * @version //autogentag//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

/**
 * This result type is used to force an external redirect
 *
 * @package MvcTools
 * @version //autogentag//
 */
class ezcMvcExternalRedirect implements ezcMvcResultStatusObject
{
    /**
     * The location where to re-direct to.
     *
     * @var string
     */
    public $location;

    /**
     * Constructs an ezcMvcExternalRedirect object to re-direct to $location
     *
     * @param string $location
     */
    public function __construct( $location = '/' )
    {
        $this->location = $location;
    }

    /**
     * Uses the passed in $writer to set the proper location header.
     *
     * @param ezcMvcResponseWriter $writer
     */
    public function process( ezcMvcResponseWriter $writer )
    {
        if ( $writer instanceof ezcMvcHttpResponseWriter )
        {
            $writer->headers['Location'] = $this->location;
        }
    }
}
?>