Apache Zeta Components Manual :: File Source for dispatcher_configuration.php

Source for file dispatcher_configuration.php

Documentation is available at dispatcher_configuration.php

  1. <?php
  2. /**
  3.  * File containing the ezcMvcDispatcherConfiguration class
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  23.  * @version //autogentag//
  24.  * @filesource
  25.  * @package MvcTools
  26.  */
  27.  
  28. /**
  29.  * Configure a dispatcher with an instance of an implementation of this
  30.  * interface.
  31.  *
  32.  * You can use any dispatcher with the same configuration class.
  33.  *
  34.  * @package MvcTools
  35.  * @version //autogentag//
  36.  * @mainclass
  37.  */
  38. {
  39.     /**
  40.      * Creates the request parser able to produce a relevant request object
  41.      * for this session.
  42.      *
  43.      * @return ezcMvcRequestParser 
  44.      */
  45.     public function createRequestParser();
  46.  
  47.     /**
  48.      * Create the router able to instantiate a relevant controller for this
  49.      * request.
  50.      *
  51.      * @param ezcMvcRequest $request 
  52.      *
  53.      * @return ezcMvcRouter 
  54.      */
  55.     public function createRouterezcMvcRequest $request );
  56.  
  57.     /**
  58.      * Creates the view handler that is able to process the result.
  59.      *
  60.      * @param ezcMvcRoutingInformation $routeInfo 
  61.      * @param ezcMvcRequest $request 
  62.      * @param ezcMvcResult $result 
  63.      *
  64.      * @return ezcMvcView 
  65.      */
  66.     public function createViewezcMvcRoutingInformation $routeInfoezcMvcRequest $requestezcMvcResult $result );
  67.  
  68.     /**
  69.      * Creates a response writer that uses the response and sends its
  70.      * output.
  71.      *
  72.      * This method should be able to pick different response writers, but the
  73.      * response writer itself will only know about the $response.
  74.      *
  75.      * @param ezcMvcRoutingInformation $routeInfo 
  76.      * @param ezcMvcRequest $request 
  77.      * @param ezcMvcResult $result 
  78.      * @param ezcMvcResponse $response 
  79.      *
  80.      * @return ezcMvcResponseWriter 
  81.      */
  82.     public function createResponseWriterezcMvcRoutingInformation $routeInfoezcMvcRequest $requestezcMvcResult $resultezcMvcResponse $response );
  83.  
  84.     /**
  85.      * Create the default internal redirect object in case something goes
  86.      * wrong in the views.
  87.      *
  88.      * @param ezcMvcRequest $request 
  89.      * @param ezcMvcResult  $result 
  90.      * @param Exception     $e 
  91.      *
  92.      * @return ezcMvcRedirect 
  93.      */
  94.     public function createFatalRedirectRequestezcMvcRequest $requestezcMvcResult $resultException $e );
  95.  
  96.     /**
  97.      * Runs all the pre-routing filters that are deemed necessary depending on
  98.      * information in $request.
  99.      *
  100.      * The pre-routing filters could modify the request data so that a
  101.      * different router can be chosen.
  102.      *
  103.      * @param ezcMvcRequest $request 
  104.      */
  105.     public function runPreRoutingFiltersezcMvcRequest $request );
  106.  
  107.     /**
  108.      * Runs all the request filters that are deemed necessary depending on
  109.      * information in $routeInfo and $request.
  110.      *
  111.      * This method can return an object of class ezcMvcInternalRedirect in case
  112.      * the filters require this. A reason for this could be in case an
  113.      * authentication filter requires authentication credentials to be passed
  114.      * in through a login form. The method can also not return anything in case
  115.      * no redirect is necessary.
  116.      *
  117.      * @param ezcMvcRoutingInformation $routeInfo 
  118.      * @param ezcMvcRequest $request 
  119.      *
  120.      * @return ezcMvcInternalRedirect|null
  121.      */
  122.     public function runRequestFiltersezcMvcRoutingInformation $routeInfoezcMvcRequest $request );
  123.  
  124.     /**
  125.      * Runs all the request filters that are deemed necessary depending on
  126.      * information in $routeInfo, $request and $result.
  127.      *
  128.      * @param ezcMvcRoutingInformation $routeInfo 
  129.      * @param ezcMvcRequest $request 
  130.      * @param ezcMvcResult $result 
  131.      */
  132.     public function runResultFiltersezcMvcRoutingInformation $routeInfoezcMvcRequest $requestezcMvcResult $result );
  133.  
  134.     /**
  135.      * Runs all the request filters that are deemed necessary depending on
  136.      * information in $routeInfo, $request, $result and $response.
  137.      *
  138.      * @param ezcMvcRoutingInformation $routeInfo 
  139.      * @param ezcMvcRequest $request 
  140.      * @param ezcMvcResult  $result 
  141.      * @param ezcMvcResponse $response 
  142.      */
  143.     public function runResponseFiltersezcMvcRoutingInformation $routeInfoezcMvcRequest $requestezcMvcResult $resultezcMvcResponse $response );
  144. }
  145. ?>
Documentation generated by phpDocumentor 1.4.3