Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitDispatcherConfiguration

Core::arbitDispatcherConfiguration

Class arbitDispatcherConfiguration

Basic arbit request dispatcher configuration

Basic arbit request dispatcher configuration

Author(s):
Version:   $Revision: 1692 $
License:   GPL

Member Variables

protected bool $testLogging = false
Enables logging of requests and responses for functional tests.

Enables logging of requests and responses for functional tests.

Method Summary

public ezcMvcInternalRedirect createFatalRedirectRequest( $request , $result , $response )
Create the default internal redirect object in case something goes wrong in the views.
public ezcMvcRequestParser createRequestParser( )
Creates the request parser able to produce a relevant request object for this session.
public ezcMvcResponseWriter createResponseWriter( $routeInfo , $request , $result , $response )
Creates a response writer that uses the response and sends its output.
public ezcMvcRouter createRouter( $request )
Create the router able to instantiate a relevant controller for this request.
public ezcMvcViewHandler createView( $routeInfo , $request , $result )
Creates the view handler that is able to process the result.
protected void logStruct( $type , $struct )
Log structure Log provided structure, so it can be used to replay the requests in funcitonal tests.
public void runPreRoutingFilters( $request )
Runs all the pre-routing filters that are deemed necessary depending on information in $request.
public ezcMvcInternalRedirect|null runRequestFilters( $routeInfo , $request )
Runs all the request filters that are deemed necessary depending on information in $routeInfo and $request.
public void runResponseFilters( $routeInfo , $request , $result , $response )
Runs all the request filters that are deemed necessary depending on information in $routeInfo, $request, $result and $response.
public void runResultFilters( $routeInfo , $request , $result )
Runs all the request filters that are deemed necessary depending on information in $routeInfo, $request and $result.

Methods

createFatalRedirectRequest

ezcMvcInternalRedirect createFatalRedirectRequest( $request , $result , $response )

Create the default internal redirect object in case something goes wrong in the views.

Create the default internal redirect object in case something goes wrong in the views.

Parameters:
Name Type Description
$request ezcMvcRequest
$result ezcMvcResult
$response ezcMvcResponse

createRequestParser

ezcMvcRequestParser createRequestParser( )

Creates the request parser able to produce a relevant request object for this session.

Creates the request parser able to produce a relevant request object for this session.

createResponseWriter

ezcMvcResponseWriter createResponseWriter( $routeInfo , $request , $result , $response )

Creates a response writer that uses the response and sends its output.

Creates a response writer that uses the response and sends its output. This method should be able to pick different response writers, but the response writer itself will only know about the $response.

Parameters:
Name Type Description
$routeInfo ezcMvcRoutingInformation
$request ezcMvcRequest
$result ezcMvcResult
$response ezcMvcResponse

createRouter

ezcMvcRouter createRouter( $request )

Create the router able to instantiate a relevant controller for this request.

Create the router able to instantiate a relevant controller for this request.

Parameters:
Name Type Description
$request ezcMvcRequest

createView

ezcMvcViewHandler createView( $routeInfo , $request , $result )

Creates the view handler that is able to process the result.

Creates the view handler that is able to process the result.

Parameters:
Name Type Description
$routeInfo ezcMvcRoutingInformation
$request ezcMvcRequest
$result ezcMvcResult

logStruct

void logStruct( string $type , mixed $struct )

Log structure Log provided structure, so it can be used to replay the requests in funcitonal tests.

Log structure Log provided structure, so it can be used to replay the requests in funcitonal tests.

Parameters:
Name Type Description
$type string
$struct mixed

runPreRoutingFilters

void runPreRoutingFilters( $request )

Runs all the pre-routing filters that are deemed necessary depending on information in $request.

Runs all the pre-routing filters that are deemed necessary depending on information in $request. The pre-routing filters could modify the request data so that a different router can be chosen.

Parameters:
Name Type Description
$request ezcMvcRequest

runRequestFilters

ezcMvcInternalRedirect|null runRequestFilters( $routeInfo , $request )

Runs all the request filters that are deemed necessary depending on information in $routeInfo and $request.

Runs all the request filters that are deemed necessary depending on information in $routeInfo and $request. This method can return an object of class ezcMvcInternalRedirect in case the filters require this. A reason for this could be in case an authentication filter requires authentication credentials to be passed in through a login form. The method can also not return anything in case no redirect is necessary.

Parameters:
Name Type Description
$routeInfo ezcMvcRoutingInformation
$request ezcMvcRequest

runResponseFilters

void runResponseFilters( $routeInfo , $request , $result , $response )

Runs all the request filters that are deemed necessary depending on information in $routeInfo, $request, $result and $response.

Runs all the request filters that are deemed necessary depending on information in $routeInfo, $request, $result and $response.

Parameters:
Name Type Description
$routeInfo ezcMvcRoutingInformation
$request ezcMvcRequest
$result ezcMvcResultt
$response ezcMvcResponse

runResultFilters

void runResultFilters( $routeInfo , $request , $result )

Runs all the request filters that are deemed necessary depending on information in $routeInfo, $request and $result.

Runs all the request filters that are deemed necessary depending on information in $routeInfo, $request and $result.

Parameters:
Name Type Description
$routeInfo ezcMvcRoutingInformation
$request ezcMvcRequest
$result ezcMvcResult
Documentation generated on Mon, 05 Apr 2010 14:01:49 +0200 by phpDocumentor 1.4.3