Show:

Q_Dispatcher Class

Defined in: platform/classes/Q/Dispatcher.php:6
Module: Q

This class lets you dispatch requests

Item Index

Methods

Properties

Events

Methods

dispatch

(
  • [$uri=null]
  • [$check=array('accessible')]
)
Boolean static

Defined in platform/classes/Q/Dispatcher.php:118

Dispatches a URI for internal processing. Usually called by a front controller.

Parameters:

  • [$uri=null] Mixed optional

    You can pass a custom URI to dispatch. Otherwise, Qbix will attempt to route the requested URL, if any.

  • [$check=array('accessible')] Array optional

    Pass array() to skip checking whether the URI can be obtained as a result of routing some URL.

Returns:

Boolean:

errors

(
  • $exception
  • $module
  • [$partialResponse=null]
)
protected static

Defined in platform/classes/Q/Dispatcher.php:476

Parameters:

  • $exception Exception
  • $module String
  • [$partialResponse=null] String optional

forward

(
  • $uri
  • [$check=array('accessible')]
  • [$skip=null]
)
static

Defined in platform/classes/Q/Dispatcher.php:38

Forwards internally to a new URL, starting the dispatcher loop again

Parameters:

  • $uri Mixed

    The URI to forward to, either as a string, an array or a Q_Uri object.

  • [$check=array('accessible')] Mixed optional

    Pass array() here to skip checking whether the URI can be obtained as a result of routing some URL.

  • [$skip=null] Array optional

    Pass an array of events to avoid firing the next time through the dispatcher loop.

forward

(
  • $uri
)
static

Defined in platform/classes/Q/Dispatcher.php:72

Forwards internally to the URI "$AppName/notFound", starting the dispatcher loop again

Parameters:

  • $uri Mixed

    The URI to forward to, either as a string, an array or a Q_Uri object.

response

(
  • [$closeConnection=false]
  • [$flushBuffers=false]
)
static

Defined in platform/classes/Q/Dispatcher.php:416

Returns a response to the client.

Parameters:

  • [$closeConnection=false] Boolean optional

    Whether to flush all the buffers and send headers to close the connection

  • [$flushBuffers=false] Boolean optional

    Whether to flush the buffers

result

(
  • [$new_result=null]
  • [$overwrite=false]
)
static

Defined in platform/classes/Q/Dispatcher.php:100

Used to get/set the result of the dispatching

Parameters:

  • [$new_result=null] String optional

    Pass a string here to record a result of the dispatching.

  • [$overwrite=false] Boolean optional

    If a result is already set, doesn't override it unless you pass true here.

showErrors

() static

Defined in platform/classes/Q/Dispatcher.php:86

Stops processing the request and asks the dispatcher to jump straight to displaying the errors.

skip

() static

Defined in platform/classes/Q/Dispatcher.php:28

Call this to tell the dispatcher to skip firing a certain event coming up

uri

() Q_Uri static

Defined in platform/classes/Q/Dispatcher.php:12

Returns the URI that is currently being dispatched. You should usually use this instead of Q_Request::uri(), as they may be different after a call to Q_Dispatcher::forward()

Returns:

Q_Uri:

Properties

$errorsOccurred

Boolean protected static

Defined in platform/classes/Q/Dispatcher.php:579

$handlingErrors

Boolean protected static

Defined in platform/classes/Q/Dispatcher.php:572

$routed

Array public static

Defined in platform/classes/Q/Dispatcher.php:610

$servedResponse

Boolean public static

Defined in platform/classes/Q/Dispatcher.php:602

Whether a response was served since the last time dispatch started

$skip

Array protected static

Defined in platform/classes/Q/Dispatcher.php:565

$startedResponse

Boolean public static

Defined in platform/classes/Q/Dispatcher.php:594

Whether a response was started, since the beginning of the request

$uri

Q_Uri protected static

Defined in platform/classes/Q/Dispatcher.php:558

@startedDispatch

Boolean public static

Defined in platform/classes/Q/Dispatcher.php:586

Whether the dispatch method was called since the beginning of the request

Events

$module/errors

Defined in platform/classes/Q/Dispatcher.php:507

Event Payload:

  • exception Exception
  • module String
  • partialResponse String

Q/analytics

Defined in platform/classes/Q/Dispatcher.php:332

Gives the app a chance to gather analytics from the request.

Event Payload:

  • $routed Array

Q/dir

Defined in platform/classes/Q/Dispatcher.php:174

Event Payload:

  • filename String
  • routed_uri String

Q/errors

Defined in platform/classes/Q/Dispatcher.php:515

Event Payload:

  • exception Exception
  • module String
  • partialResponse String

Q/exception

Defined in platform/classes/Q/Dispatcher.php:525

Event Payload:

  • exception Exception

Q/file

Defined in platform/classes/Q/Dispatcher.php:183

Event Payload:

  • filename String
  • routed_uri String

Q/noModule

Defined in platform/classes/Q/Dispatcher.php:213

Occurs when no module was found during routing. The parameters are the routed array

Q/notFound

Defined in platform/classes/Q/Dispatcher.php:229

Occurs when no defined action was found during routing. The parameters are the routed array

Event Payload:

  • $routed Array

Q/objects

Defined in platform/classes/Q/Dispatcher.php:289

Gives the app a chance to fetch objects needed for handling the request.

Event Payload:

  • $routed Array

Q/prepare

Defined in platform/classes/Q/Dispatcher.php:256

Gives the app a chance to prepare for handling a request The parameters are the routed array

Event Payload:

  • $routed Array

Q/reroute

Defined in platform/classes/Q/Dispatcher.php:300

Gives the app a chance to reroute the request

Event Payload:

  • $routed Array

Q/response

Defined in platform/classes/Q/Dispatcher.php:448

Gives the app a chance to generate a response. You should not change the server state when handling this event.

Event Payload:

  • $routed Array

Q/validate

Defined in platform/classes/Q/Dispatcher.php:267

Gives the app a chance to validate the request and call Q_Response::addError() zero or more times. The parameters are the routed array

Event Payload:

  • $routed Array