Docs For Class Request

method clearAttributes [line 74]

void clearAttributes(
)

Clear all attributes associated with this request.

Tags:

access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method extractParameters [line 96]

array &extractParameters(
array
$names)

Extract parameter values from the request.

Tags:

return:	An associative array of parameters and their values. If a specified parameter doesn't exist an empty string will be returned for its value.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

array

$names

An indexed array of parameter names to extract.

[ Top ]

method getAttribute [line 130]

mixed &getAttribute(
string
$name)

Retrieve an attribute.

Tags:

return:	An attribute value, if the attribute exists, otherwise null.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$name

An attribute name.

[ Top ]

method getAttributeNames [line 156]

array getAttributeNames(
)

Retrieve an array of attribute names.

Tags:

return:	An indexed array of attribute names.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method getError [line 175]

string getError(
string
$name)

Retrieve an error message.

Tags:

return:	An error message, if the error exists, otherwise null.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$name

An error name.

[ Top ]

method getErrorNames [line 201]

array getErrorNames(
)

Retrieve an array of error names.

Tags:

return:	An indexed array of error names.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method getErrors [line 218]

array getErrors(
)

Retrieve an array of errors.

Tags:

return:	An associative array of errors.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method getMethod [line 237]

int getMethod(
)

Retrieve this request's method.

Tags:

return:	One of the following constants: Request::GET Request::POST
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method hasAttribute [line 256]

bool hasAttribute(
string
$name)

Indicates whether or not an attribute exists.

Tags:

return:	true, if the attribute exists, otherwise false.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$name

An attribute name.

[ Top ]

method hasError [line 275]

bool hasError(
string
$name)

Indicates whether or not an error exists.

Tags:

return:	true, if the error exists, otherwise false.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$name

An error name.

[ Top ]

method hasErrors [line 293]

bool hasErrors(
)

Indicates whether or not any errors exist.

Tags:

return:	true, if any error exist, otherwise false.
access:	public
since:	2.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method initialize [line 317]

bool initialize(
Context
$context, [array
$parameters = null])

Initialize this Request.

Tags:

return:	true, if initialization completes successfully, otherwise false.
abstract:
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	InitializationException If an error occurs while initializing this Request.

Overridden in child classes as:

ConsoleRequest::initialize(): Initialize this Request.

WebRequest::initialize(): Initialize this Request.

Parameters:

Context	$context	A Context instance.
array	$parameters	An associative array of initialization parameters.

[ Top ]

method newInstance [line 334]

Request newInstance(
string
$class)

Retrieve a new Request implementation instance.

Tags:

return:	A Request implementation instance.
static:
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	FactoryException If a request implementation instance cannot be created.

Parameters:

string

$class

A Request implementation name.

[ Top ]

method removeAttribute [line 368]

mixed &removeAttribute(
string
$name)

Remove an attribute.

Tags:

return:	An attribute value, if the attribute was removed, otherwise null.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$name

An attribute name.

[ Top ]

method removeError [line 399]

string &removeError(
string
$name)

Remove an error.

Tags:

return:	An error message, if the error was removed, otherwise null.
access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$name

An error name.

[ Top ]

method setAttribute [line 433]

void setAttribute(
string
$name, mixed
$value)

Set an attribute.

If an attribute with the name already exists the value will be overridden.

Tags:

access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string	$name	An attribute name.
mixed	$value	An attribute value.

[ Top ]

method setAttributeByRef [line 456]

void setAttributeByRef(
string
$name, mixed
&$value)

Set an attribute by reference.

If an attribute with the name already exists the value will be overridden.

Tags:

access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string	$name	An attribute name.
mixed	&$value	A reference to an attribute value.

[ Top ]

method setAttributes [line 479]

void setAttributes(
array
$attributes)

Set an array of attributes.

If an existing attribute name matches any of the keys in the supplied array, the associated value will be overridden.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

array

$attributes

An associative array of attributes and their associated values.

[ Top ]

method setAttributesByRef [line 502]

void setAttributesByRef(
array
&$attributes)

Set an array of attributes by reference.

If an existing attribute name matches any of the keys in the supplied array, the associated value will be overridden.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

array

&$attributes

An associative array of attributes and references to their associated values.

[ Top ]

method setError [line 527]

void setError(
name
$name, message
$message)

Set an error.

Tags:

access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

name	$name	An error name.
message	$message	An error message.

[ Top ]

method setErrors [line 551]

void setErrors(
array
$errors)

Set an array of errors

If an existing error name matches any of the keys in the supplied array, the associated message will be overridden.

Tags:

access:	public
since:	2.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

array

$errors

An associative array of errors and their associated messages.

[ Top ]

method setMethod [line 575]

void setMethod(
int
$method)

Set the request method.

Tags:

access:	public
since:	2.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	MojaviException If the specified request method is invalid.

Parameters:

int

$method

One of the following constants:

Request::GET
Request::POST

[ Top ]

method shutdown [line 605]

void shutdown(
)

Execute the shutdown procedure.

Tags:

abstract:
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overridden in child classes as:

ConsoleRequest::shutdown(): Execute the shutdown procedure.

WebRequest::shutdown(): Execute the shutdown procedure.

[ Top ]

Class: Request

Class Overview

Author(s):

Version:

Copyright:

Variables

Constants

Methods

Child classes:

Inherited Variables

Class: ParameterHolder

Inherited Methods

Class: ParameterHolder

Class Details

Tags:

Class Variables

$errors = array()

$method =

Class Methods

method clearAttributes [line 74]

Tags:

method extractParameters [line 96]

Tags:

Parameters:

method getAttribute [line 130]

Tags:

Parameters:

method getAttributeNames [line 156]

Tags:

method getError [line 175]

Tags:

Parameters:

method getErrorNames [line 201]

Tags:

method getErrors [line 218]

Tags:

method getMethod [line 237]

Tags:

method hasAttribute [line 256]

Tags:

Parameters:

method hasError [line 275]

Tags:

Parameters:

method hasErrors [line 293]

Tags:

method initialize [line 317]

Tags:

Parameters:

method newInstance [line 334]

Tags:

Parameters:

method removeAttribute [line 368]

Tags:

Parameters:

method removeError [line 399]

Tags:

Parameters:

method setAttribute [line 433]

Tags:

Parameters:

method setAttributeByRef [line 456]

Tags:

Parameters:

method setAttributes [line 479]

Tags:

Parameters:

method setAttributesByRef [line 502]

Tags:

Parameters:

method setError [line 527]

Tags:

Parameters:

method setErrors [line 551]

Tags:

Parameters:

method setMethod [line 575]

Tags:

Parameters:

method shutdown [line 605]