contenido\classes\class.request.php

Show:

inherited

Classes
- \Request
- \ValidationError

Table of Contents

\Request
jump to top

Package: Default

Request class

Author: Andreas Kummer, w3concepts AG
Copyright: Copyright © 2008, w3concepts AG
Version: $Id: request.class.php 2289 2008-09-29 13:46:08Z atelierq $

Constants

 
                POST
                = 'POST'

 
                GET
                = 'GET'

 
                COOKIE
                = 'COOKIE'

 
                TYPE_INTEGER
                = 1

 
                TYPE_FLOAT
                = 2

 
                TYPE_STRING
                = 4

 
                TYPE_ARRAY
                = 8

 
                TRANS_STRIP_HTML
                = 1

 
                TRANS_STRIP_PHP
                = 2

 
                DATE_PATTERN_ISO
                = '/^\\d{4}\\-\\d{2}\\-\\d{2}$/'

 
                DATE_PATTERN_DE
                = '/^\\d{2}\\.\\d{2}\\.(?:\\d{2}|\\d{4})$/'

 
                DATETIME_PATTERN
                = '/^\\d{4}\\-\\d{2}\\-\\d{2}\\s\\d{2}\\:\\d{2}$/'

 
                DATETIME_PATTERN_DE
                = '/^\\d{2}\\.\\d{2}\\.(?:\\d{2}|\\d{4})\\s\\d{2}.\\d{2}$/'

 
                HEXDEC_HASH
                = '/^[\\da-f]*$/'

Properties

$COOKIE

Details

Type: n/a

$COOKIEcleared

Details

Type: n/a

$GET

Details

Type: n/a

$GETcleared

Details

Type: n/a

$POST

Details

Type: n/a

$POSTcleared

Details

Type: n/a

$bHasValidationErrors

Details

Type: n/a

Methods

__construct() : void

Constructor.

Details

Access: private

cookie(String $sName, $bWithErrors = false) : Mixed

static

Returns the COOKIE value of the specified parameter.

Null if it does not exist or if it is not valid.

Parameters

Name	Type	Description
$sName	String	sName Name of the parameter.
$bWithErrors

Returns

Type	Description
Mixed	Value of the parameter or null.

Details

Access: public
Static

finish() : Object

Replaces all error objects with null.

Must be called after registering the required parameters.

Returns

Type	Description
Object	Reference to the current instance.

get(String $sName, $bWithErrors = false) : Mixed

static

Returns the GET value of the specified parameter.

Null if it does not exist or if it is not valid.

Parameters

Name	Type	Description
$sName	String	sName Name of the parameter.
$bWithErrors

Returns

Type	Description
Mixed	Value of the parameter or null.

Details

Access: public
Static

getInstance() : Object

static

Factory.

Returns

Type	Description
Object	Reference to the current single instance of the class.

Details

Access: public
Static

getVar(String $sRequestType, String $sName, $bWithErrors = false) : Mixed

Returns the parameter specified by sName and the request type sRequestType.

The method throws an exception if the specified paramter has not yet been registered.

Parameters

Name	Type	Description
$sRequestType	String	sRequestType Request type (GET, POST or COOKIE).
$sName	String	sName Name of the parameter.
$bWithErrors

Returns

Type	Description
Mixed	Value of the specified parameter.

Details

Access: private

hasError(\Reference $mItem, Mixed $mKey) : Void

static

Callback function to check whether a validation error occured or not.

Parameters

Name	Type	Description
$mItem	\Reference	mItem Reference to the current item.
$mKey	Mixed	mKey Current key.

Returns

Type	Description
Void

Details

Access: private
Static

hasValidationErrors(String $sRequestType, Array $aParams) : Boolean

static

Returns true, if one of the specified parameters has given a validation error.

Parameters

Name	Type	Description
$sRequestType	String	sRequestType Request type.
$aParams	Array	aParams Array of parameters to be checked.

Returns

Type	Description
Boolean	True if no validation errors occured. False otherwise.

isFloat(Mixed $mValue) : Boolean

static

Checks whether or not the given value is a double value.

Parameters

Name	Type	Description
$mValue	Mixed	mValue Value to be checked.

Returns

Type	Description
Boolean	True if the value is a float or integer value.

Details

Access: private
Static

isInteger(Mixed $mValue) : Boolean

static

Checks whether or not the given value is a integer value.

Parameters

Name	Type	Description
$mValue	Mixed	mValue Value to be checked.

Returns

Type	Description
Boolean	True if the value is a integer value.

Details

Access: private
Static

isRegistered( $sName, $sRequestType) : void

Parameters

Name	Type	Description
$sName
$sRequestType

post(String $sName, $bWithErrors = false) : Mixed

static

Returns the POST value of the specified parameter.

Null if it does not exist or if it is not valid.

Parameters

Name	Type	Description
$sName	String	sName Name of the parameter.
$bWithErrors

Returns

Type	Description
Mixed	Value of the parameter or null.

Details

Access: public
Static

register(String $sRequestType, String $sName, Integer $iType, Float $iMin = null, Float $iMax = null, String $sRegex = null,  $iTransformation = null) : Object

Registers a request variable with the request class.

Parameters

Name	Type	Description
$sRequestType	String	sRequestType Either POST, GET or COOKIE.
$sName	String	sName Parameter name.
$iType	Integer	iType Parameter type (either integer, float or string).
$iMin	Float	iMin Minimum length (string) or minimum value (float, integer).
$iMax	Float	iMax Maximum length (string) or maximum value (float, integer).
$sRegex	String	sRegex Regex pattern the value is checked against.
$iTransformation

Returns

Type	Description
Object	Reference to the current instance to enable method chaining.

Details

Access: public

request(String $sName, $bWithErrors = false) : Mixed

static

Returns the REQUEST value of the specified parameter.

Null if it does not exist or if it is not valid.

Parameters

Name	Type	Description
$sName	String	sName Name of the parameter.
$bWithErrors

Returns

Type	Description
Mixed	Value of the parameter or null.

Details

Access: private
Static

setErrorsToNull(\Reference $mItem, Mixed $mKey) : Void

static

Callback function to clear the resulting arrays from ValidationError objects.

Parameters

Name	Type	Description
$mItem	\Reference	mItem Reference to the item of the array to be cleared.
$mKey	Mixed	mKey Key of the current item to be processed.

Returns

Type	Description
Void

Details

Access: private
Static

setValidationError(Boolean $bValidationError) : Void

Sets the member bValidationError to the given value.

Parameters

Name	Type	Description
$bValidationError	Boolean	bValidationError True, if a validation error occured.

Returns

Type	Description
Void

transform(String $sValue, Integer $iRules) : String

static

Transforms the value according to the given rules.

Parameters

Name	Type	Description
$sValue	String	sValue Value to be transformed.
$iRules	Integer	iRules Sum of the transformation rules to be applied.

Returns

Type	Description
String	Transformed value.

Details

Access: private
Static

validateArray(\Reference $mItem, Mixed $mKey, Array $aParams) : Void

static

Callback function for validating items of arrays.

Parameters

Name	Type	Description
$mItem	\Reference	mItem Reference to the item of the array to be validated.
$mKey	Mixed	mKey Key of the current item to be processed.
$aParams	Array	aParams Parameter array to be used in the validation process.

Returns

Type	Description
Void

Details

Access: private
Static

validateValue(Mixed $mValue, Integer $iType, Integer $iMin, Integer $iMax, Integer $sRegex,  $iTransformation) : Mixed

static

Validates the value against type, range, pattern, optionally after a transformation process.

Parameters

Name	Type	Description
$mValue	Mixed	mValue Value to be validated.
$iType	Integer	iType Type (integer, float or string).
$iMin	Integer	iMin Minimum value (integer and float) or minimum length (string).
$iMax	Integer	iMax Maximum value (integer and float) or maximum length (string).
$sRegex	Integer	iTransformation Sum of transformations to be applied.
$iTransformation

Returns

Type	Description
Mixed	Either the transformed and validated value or null.

Details

Access: private
Static

\ValidationError
jump to top

Package: Default

Constants

 
                NOT_INTEGER
                = 1

 
                NOT_FLOAT
                = 2

 
                NOT_SCALAR
                = 3

 
                TOO_LONG
                = 4

 
                TOO_SHORT
                = 5

 
                TOO_BIG
                = 6

 
                TOO_SMALL
                = 7

 
                WRONG_PATTERN
                = 8

Properties

$iType

Details

Type: n/a

$mTransValue

Details

Type: n/a

$sMessage

Details

Type: n/a

Methods

__construct(Integer $iType, String $sMessage, Mixed $mTransValue) : void

Constructor.

Parameters

Name	Type	Description
$iType	Integer	iType Error type (see constants).
$sMessage	String	sMessage Error message.
$mTransValue	Mixed	mTransValue Original and eventually transformed value.

Details

Access: private

getError() : Integer

Returns the error type.

Returns

Type	Description
Integer	Error type.

Details

Access: public

getMessage() : String

Returns the error message.

Returns

Type	Description
String	Error message.

Details

Access: public

getValue() : Mixed

Returns the eventually transformed value.

Returns

Type	Description
Mixed	Transformed value.

Details

Access: public

set(Integer $iType, Mixed $mTransValue, String $sMessage = '') : Object

static

Returns an object reference of the given type.

Parameters

Name	Type	Description
$iType	Integer	iType Error type.
$mTransValue	Mixed	mTransValue Original and eventually transformed value.
$sMessage	String	sMessage Error message.

Returns

Type	Description
Object	New validation error object.

Details

Access: public
Static

contenido\classes\class.request.php

\Requestjump to top

Constants

Properties

Methods

\ValidationErrorjump to top

Constants

Properties

Methods

\Request
jump to top

\ValidationError
jump to top