PHP Class Clockwork\Request\Request

Show file Open project: itsgoingd/clockwork Class Usage Examples

Public Properties

Property Type Description
$controller Textual representation of executed controller
$cookies Cookies array
$databaseQueries Database queries array
$emailsData Emails data array
$getData GET data array
$headers Request headers
$id Unique request ID
$log Log messages array
$method Request method
$postData POST data array
$responseStatus Response status code
$responseTime Response time
$routes Application routes array
$sessionData Session data array
$time Request time
$timelineData Timeline data array
$uri Request URI
$userData Custom user data (not used by Clockwork app)
$version Data protocol version
$viewsData Views data array

Public Methods

Method Description
__construct ( array $data = null ) Create a new request, if optional data array argument is provided, it will be used to populate the request object, otherwise empty request with autogenerated ID will be created
getDatabaseDuration ( ) Compute and return sum of duration of all database queries
getResponseDuration ( ) Compute and return response duration in milliseconds
toArray ( ) Return request data as an array
toJson ( ) Return request data as a JSON string

Protected Methods

Method Description
generateRequestId ( ) Generate unique request ID in form .

Method Details

__construct() public method

Create a new request, if optional data array argument is provided, it will be used to populate the request object, otherwise empty request with autogenerated ID will be created
public __construct ( array $data = null )
$data array

generateRequestId() protected method

Generate unique request ID in form .
protected generateRequestId ( )

getDatabaseDuration() public method

Compute and return sum of duration of all database queries
public getDatabaseDuration ( )

getResponseDuration() public method

Compute and return response duration in milliseconds
public getResponseDuration ( )

toArray() public method

Return request data as an array
public toArray ( )

toJson() public method

Return request data as a JSON string
public toJson ( )

Property Details

$controller public property

Textual representation of executed controller
public $controller

$cookies public property

Cookies array
public $cookies

$databaseQueries public property

Database queries array
public $databaseQueries

$emailsData public property

Emails data array
public $emailsData

$getData public property

GET data array
public $getData

$headers public property

Request headers
public $headers

$id public property

Unique request ID
public $id

$log public property

Log messages array
public $log

$method public property

Request method
public $method

$postData public property

POST data array
public $postData

$responseStatus public property

Response status code
public $responseStatus

$responseTime public property

Response time
public $responseTime

$routes public property

Application routes array
public $routes

$sessionData public property

Session data array
public $sessionData

$time public property

Request time
public $time

$timelineData public property

Timeline data array
public $timelineData

$uri public property

Request URI
public $uri

$userData public property

Custom user data (not used by Clockwork app)
public $userData

$version public property

Data protocol version
public $version

$viewsData public property

Views data array
public $viewsData