param

IParameter extends ArrayAccess, Iterator, JsonSerializable
in

Enable safe handling of untrusted data received as string, array, or null values.

A parameter is suitable to encapsulate a value received as a string or array (or NULL) such as query parameters from a web request or database query result. It is used to validate and safely convert inputs to a more useful type.

Tags
suppress

PhanAccessWrongInheritanceCategoryInternal

extends
extends
see
Parameter

for the base implementation

Table of Contents

Methods

__toString()  : string
asArray()  : array<string|int, mixed>
asArrayOrNull()  : array<string|int, mixed>|null
asArrayOrString()  : array<string|int, mixed>|string
asArrayRecursive()  : array<string|int, mixed>
asArrayRecursiveOrNull()  : array<string|int, mixed>|null
asArrayRecursiveOrString()  : array<string|int, mixed>|string
asBool()  : bool
asBoolOrNull()  : bool|null
asConstant()  : string
Requires the parameter to be exactly the given value.
asCurrency()  : int
asCurrencyOrEmpty()  : int|null
asCurrencyOrNull()  : int|null
asDate()  : string
asDateOrNull()  : string|null
asDateTime()  : string
asDateTimeOrNull()  : string|null
asEmailAddress()  : string
asEmailAddressOrEmpty()  : string|null
asEmailAddressOrNull()  : string|null
asEmailUsername()  : string
asEmailUsernameOrEmpty()  : string|null
asEmailUsernameOrNull()  : string|null
asExistingDirectory()  : string
asExistingDirectoryOrEmpty()  : string|null
asExistingDirectoryOrNull()  : string|null
asExistingFilename()  : string
asExistingFilenameOrEmpty()  : string|null
asExistingFilenameOrNull()  : string|null
asFloat()  : float
asFloatOrEmpty()  : float|null
asFloatOrNull()  : float|null
asFloatRangeClosed()  : float
asFloatRangeClosedOrEmpty()  : float|null
asFloatRangeClosedOrNull()  : float|null
asFloatRangeHalfClosed()  : float
asFloatRangeHalfClosedOrEmpty()  : float|null
asFloatRangeHalfClosedOrNull()  : float|null
asFloatRangeOpen()  : float
asFloatRangeOpenOrEmpty()  : float|null
asFloatRangeOpenOrNull()  : float|null
asHostname()  : string
asHostnameOrEmpty()  : string|null
asHostnameOrNull()  : string|null
asInt()  : int
asIntOrEmpty()  : int|null
Returns the integer value or null for the empty string.
asIntOrNull()  : int|null
asIntRangeClosed()  : int
asIntRangeClosedOrEmpty()  : int|null
asIntRangeClosedOrNull()  : int|null
asIntRangeHalfClosed()  : int
asIntRangeHalfClosedOrEmpty()  : int|null
asIntRangeHalfClosedOrNull()  : int|null
asIntRangeOpen()  : int
asIntRangeOpenOrEmpty()  : int|null
asIntRangeOpenOrNull()  : int|null
asIP()  : string
asIPOrEmpty()  : string|null
asIPOrNull()  : string|null
asIPv4()  : string
asIPv4OrEmpty()  : string|null
asIPv4OrNull()  : string|null
asIPv6()  : string
asIPv6OrEmpty()  : string|null
asIPv6OrNull()  : string|null
asJSON()  : string
asKeyword()  : string
asKeywordOrEmpty()  : string|null
asKeywordOrNull()  : string|null
asMap()  : string
asMapOrEmpty()  : string|null
asMapOrNull()  : string|null
asNonexistentFilename()  : string
asNonexistentFilenameOrEmpty()  : string|null
asNonexistentFilenameOrNull()  : string|null
asPositiveFloat()  : float
asPositiveFloatOrEmpty()  : float|null
asPositiveFloatOrNull()  : float|null
asPositiveInt()  : int
asPositiveIntOrEmpty()  : int|null
asPositiveIntOrNull()  : int|null
asRoundedFloat()  : float
asRoundedFloatOrEmpty()  : float|null
asRoundedFloatOrNull()  : float|null
asRoundedInt()  : int
asRoundedIntOrEmpty()  : int|null
asRoundedIntOrNull()  : int|null
asString()  : string
asStringOrNull()  : string|null
asTime()  : string
asTimeOrNull()  : string|null
asTimeStamp()  : int
asTimeStampOrNull()  : int|null
asUnsignedFloat()  : float
asUnsignedFloatOrEmpty()  : float|null
asUnsignedFloatOrNull()  : float|null
asUnsignedInt()  : int
asUnsignedIntOrEmpty()  : int|null
asUnsignedIntOrNull()  : int|null
getValue()  : array<string|int, mixed>|string|null
has()  : bool
indexOrDefault()  : IParameter
indexOrNull()  : IParameter|null
is()  : bool
Provides an easy way to test whether the parameter is equal to a given value without getting too hung up on types. Int, string, array, and float values are compared using ==. In the case of arrays, the parameter's value is recursively collapsed first. If the given value is null, the parameter's value must be null to match.
isArray()  : bool
isBool()  : bool
Checks if the value is parseable as a boolean. Note that null is considered parseable as a boolean (false).
isEmpty()  : bool
Returns true if the value is null, an empty array, or an empty string.
isNull()  : bool
isSet()  : bool
isString()  : bool
new()  : static

Methods

__toString()

public __toString() : string
Return values
string

asArray()

public asArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

asArrayOrNull()

public asArrayOrNull() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

asArrayOrString()

public asArrayOrString() : array<string|int, mixed>|string
Return values
array<string|int, mixed>|string

asArrayRecursive()

public asArrayRecursive() : array<string|int, mixed>
Return values
array<string|int, mixed>

asArrayRecursiveOrNull()

public asArrayRecursiveOrNull() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

asArrayRecursiveOrString()

public asArrayRecursiveOrString() : array<string|int, mixed>|string
Return values
array<string|int, mixed>|string

asBool()

public asBool() : bool
Return values
bool

asBoolOrNull()

public asBoolOrNull() : bool|null
Return values
bool|null

asConstant()

Requires the parameter to be exactly the given value.

public asConstant(string $i_stConstant) : string
Parameters
$i_stConstant : string
Return values
string

asCurrency()

public asCurrency() : int
Return values
int

asCurrencyOrEmpty()

public asCurrencyOrEmpty() : int|null
Return values
int|null

asCurrencyOrNull()

public asCurrencyOrNull() : int|null
Return values
int|null

asDate()

public asDate() : string
Return values
string

asDateOrNull()

public asDateOrNull() : string|null
Return values
string|null

asDateTime()

public asDateTime() : string
Return values
string

asDateTimeOrNull()

public asDateTimeOrNull() : string|null
Return values
string|null

asEmailAddress()

public asEmailAddress() : string
Return values
string

asEmailAddressOrEmpty()

public asEmailAddressOrEmpty() : string|null
Return values
string|null

asEmailAddressOrNull()

public asEmailAddressOrNull() : string|null
Return values
string|null

asEmailUsername()

public asEmailUsername() : string
Return values
string

asEmailUsernameOrEmpty()

public asEmailUsernameOrEmpty() : string|null
Return values
string|null

asEmailUsernameOrNull()

public asEmailUsernameOrNull() : string|null
Return values
string|null

asExistingDirectory()

public asExistingDirectory() : string
Return values
string

asExistingDirectoryOrEmpty()

public asExistingDirectoryOrEmpty() : string|null
Return values
string|null

asExistingDirectoryOrNull()

public asExistingDirectoryOrNull() : string|null
Return values
string|null

asExistingFilename()

public asExistingFilename() : string
Return values
string

asExistingFilenameOrEmpty()

public asExistingFilenameOrEmpty() : string|null
Return values
string|null

asExistingFilenameOrNull()

public asExistingFilenameOrNull() : string|null
Return values
string|null

asFloat()

public asFloat() : float
Return values
float

asFloatOrEmpty()

public asFloatOrEmpty() : float|null
Return values
float|null

asFloatOrNull()

public asFloatOrNull() : float|null
Return values
float|null

asFloatRangeClosed()

public asFloatRangeClosed(float $i_fMin, float $i_fMax) : float
Parameters
$i_fMin : float
$i_fMax : float
Return values
float

asFloatRangeClosedOrEmpty()

public asFloatRangeClosedOrEmpty(float $i_fMin, float $i_fMax) : float|null
Parameters
$i_fMin : float
$i_fMax : float
Return values
float|null

asFloatRangeClosedOrNull()

public asFloatRangeClosedOrNull(float $i_fMin, float $i_fMax) : float|null
Parameters
$i_fMin : float
$i_fMax : float
Return values
float|null

asFloatRangeHalfClosed()

public asFloatRangeHalfClosed(float $i_fMin, float $i_fMax) : float
Parameters
$i_fMin : float
$i_fMax : float
Return values
float

asFloatRangeHalfClosedOrEmpty()

public asFloatRangeHalfClosedOrEmpty(float $i_fMin, float $i_fMax) : float|null
Parameters
$i_fMin : float
$i_fMax : float
Return values
float|null

asFloatRangeHalfClosedOrNull()

public asFloatRangeHalfClosedOrNull(float $i_fMin, float $i_fMax) : float|null
Parameters
$i_fMin : float
$i_fMax : float
Return values
float|null

asFloatRangeOpen()

public asFloatRangeOpen(float $i_fMin, float $i_fMax) : float
Parameters
$i_fMin : float
$i_fMax : float
Return values
float

asFloatRangeOpenOrEmpty()

public asFloatRangeOpenOrEmpty(float $i_fMin, float $i_fMax) : float|null
Parameters
$i_fMin : float
$i_fMax : float
Return values
float|null

asFloatRangeOpenOrNull()

public asFloatRangeOpenOrNull(float $i_fMin, float $i_fMax) : float|null
Parameters
$i_fMin : float
$i_fMax : float
Return values
float|null

asHostname()

public asHostname() : string
Return values
string

asHostnameOrEmpty()

public asHostnameOrEmpty() : string|null
Return values
string|null

asHostnameOrNull()

public asHostnameOrNull() : string|null
Return values
string|null

asIntOrEmpty()

Returns the integer value or null for the empty string.

public asIntOrEmpty() : int|null
Return values
int|null

asIntOrNull()

public asIntOrNull() : int|null
Return values
int|null

asIntRangeClosed()

public asIntRangeClosed(int $i_iMin, int $i_iMax) : int
Parameters
$i_iMin : int
$i_iMax : int
Return values
int

asIntRangeClosedOrEmpty()

public asIntRangeClosedOrEmpty(int $i_iMin, int $i_iMax) : int|null
Parameters
$i_iMin : int
$i_iMax : int
Return values
int|null

asIntRangeClosedOrNull()

public asIntRangeClosedOrNull(int $i_iMin, int $i_iMax) : int|null
Parameters
$i_iMin : int
$i_iMax : int
Return values
int|null

asIntRangeHalfClosed()

public asIntRangeHalfClosed(int $i_iMin, int $i_iMax) : int
Parameters
$i_iMin : int
$i_iMax : int
Return values
int

asIntRangeHalfClosedOrEmpty()

public asIntRangeHalfClosedOrEmpty(int $i_iMin, int $i_iMax) : int|null
Parameters
$i_iMin : int
$i_iMax : int
Return values
int|null

asIntRangeHalfClosedOrNull()

public asIntRangeHalfClosedOrNull(int $i_iMin, int $i_iMax) : int|null
Parameters
$i_iMin : int
$i_iMax : int
Return values
int|null

asIntRangeOpen()

public asIntRangeOpen(int $i_iMin, int $i_iMax) : int
Parameters
$i_iMin : int
$i_iMax : int
Return values
int

asIntRangeOpenOrEmpty()

public asIntRangeOpenOrEmpty(int $i_iMin, int $i_iMax) : int|null
Parameters
$i_iMin : int
$i_iMax : int
Return values
int|null

asIntRangeOpenOrNull()

public asIntRangeOpenOrNull(int $i_iMin, int $i_iMax) : int|null
Parameters
$i_iMin : int
$i_iMax : int
Return values
int|null

asIP()

public asIP() : string
Return values
string

asIPOrEmpty()

public asIPOrEmpty() : string|null
Return values
string|null

asIPOrNull()

public asIPOrNull() : string|null
Return values
string|null

asIPv4()

public asIPv4() : string
Return values
string

asIPv4OrEmpty()

public asIPv4OrEmpty() : string|null
Return values
string|null

asIPv4OrNull()

public asIPv4OrNull() : string|null
Return values
string|null

asIPv6()

public asIPv6() : string
Return values
string

asIPv6OrEmpty()

public asIPv6OrEmpty() : string|null
Return values
string|null

asIPv6OrNull()

public asIPv6OrNull() : string|null
Return values
string|null

asJSON()

public asJSON() : string
Return values
string

asKeyword()

public asKeyword(array<int, string> $i_rKeywords) : string
Parameters
$i_rKeywords : array<int, string>

List of allowable keywords.

Return values
string

asKeywordOrEmpty()

public asKeywordOrEmpty(array<int, string> $i_rKeywords) : string|null
Parameters
$i_rKeywords : array<int, string>

List of allowable keywords.

Return values
string|null

asKeywordOrNull()

public asKeywordOrNull(array<int, string> $i_rKeywords) : string|null
Parameters
$i_rKeywords : array<int, string>

List of allowable keywords.

Return values
string|null

asMap()

public asMap(array<string, mixed> $i_rMap) : string
Parameters
$i_rMap : array<string, mixed>
Return values
string —

The mapped value for the key specified by this parameter.

asMapOrEmpty()

public asMapOrEmpty(array<string, mixed> $i_rMap) : string|null
Parameters
$i_rMap : array<string, mixed>
Return values
string|null —

The mapped value for the key specified by this parameter, or null if the parameter is the empty string.

asMapOrNull()

public asMapOrNull(array<string, mixed> $i_rMap) : string|null
Parameters
$i_rMap : array<string, mixed>
Return values
string|null —

The mapped value for the key specified by this parameter, or null.

asNonexistentFilename()

public asNonexistentFilename() : string
Return values
string

asNonexistentFilenameOrEmpty()

public asNonexistentFilenameOrEmpty() : string|null
Return values
string|null

asNonexistentFilenameOrNull()

public asNonexistentFilenameOrNull() : string|null
Return values
string|null

asPositiveFloat()

public asPositiveFloat() : float
Return values
float

asPositiveFloatOrEmpty()

public asPositiveFloatOrEmpty() : float|null
Return values
float|null

asPositiveFloatOrNull()

public asPositiveFloatOrNull() : float|null
Return values
float|null

asPositiveInt()

public asPositiveInt() : int
Return values
int

asPositiveIntOrEmpty()

public asPositiveIntOrEmpty() : int|null
Return values
int|null

asPositiveIntOrNull()

public asPositiveIntOrNull() : int|null
Return values
int|null

asRoundedFloat()

public asRoundedFloat([int $i_iPrecision = 0 ]) : float
Parameters
$i_iPrecision : int = 0
Return values
float

asRoundedFloatOrEmpty()

public asRoundedFloatOrEmpty([int $i_iPrecision = 0 ]) : float|null
Parameters
$i_iPrecision : int = 0
Return values
float|null

asRoundedFloatOrNull()

public asRoundedFloatOrNull([int $i_iPrecision = 0 ]) : float|null
Parameters
$i_iPrecision : int = 0
Return values
float|null

asRoundedInt()

public asRoundedInt([int $i_iPrecision = 0 ]) : int
Parameters
$i_iPrecision : int = 0
Return values
int

asRoundedIntOrEmpty()

public asRoundedIntOrEmpty([int $i_iPrecision = 0 ]) : int|null
Parameters
$i_iPrecision : int = 0
Return values
int|null

asRoundedIntOrNull()

public asRoundedIntOrNull([int $i_iPrecision = 0 ]) : int|null
Parameters
$i_iPrecision : int = 0
Return values
int|null

asString()

public asString() : string
Return values
string

asStringOrNull()

public asStringOrNull() : string|null
Return values
string|null

asTime()

public asTime() : string
Return values
string

asTimeOrNull()

public asTimeOrNull() : string|null
Return values
string|null

asTimeStamp()

public asTimeStamp() : int
Return values
int

asTimeStampOrNull()

public asTimeStampOrNull() : int|null
Return values
int|null

asUnsignedFloat()

public asUnsignedFloat() : float
Return values
float

asUnsignedFloatOrEmpty()

public asUnsignedFloatOrEmpty() : float|null
Return values
float|null

asUnsignedFloatOrNull()

public asUnsignedFloatOrNull() : float|null
Return values
float|null

asUnsignedInt()

public asUnsignedInt() : int
Return values
int

asUnsignedIntOrEmpty()

public asUnsignedIntOrEmpty() : int|null
Return values
int|null

asUnsignedIntOrNull()

public asUnsignedIntOrNull() : int|null
Return values
int|null

getValue()

public getValue() : array<string|int, mixed>|string|null
Return values
array<string|int, mixed>|string|null

has()

public has(int|string $key) : bool
Parameters
$key : int|string
Return values
bool —

True if this is an array that has the given key, otherwise false.

If this parameter is not an array, disaster will ensue.

indexOrDefault()

public indexOrDefault(int|string $key, array<string|int, mixed>|string|null $default) : IParameter
Parameters
$key : int|string
$default : array<string|int, mixed>|string|null
Return values
IParameter —

Returns a parameter containing the value for a given key, or the specified default value if the key is not set.

If this parameter is not an array, disaster will ensue.

indexOrNull()

public indexOrNull(int|string $key) : IParameter|null
Parameters
$key : int|string
Return values
IParameter|null —

Returns a parameter containing the value for a given key, or null if the key is not set.

If this parameter is not an array, disaster will ensue.

is()

Provides an easy way to test whether the parameter is equal to a given value without getting too hung up on types. Int, string, array, and float values are compared using ==. In the case of arrays, the parameter's value is recursively collapsed first. If the given value is null, the parameter's value must be null to match.

public is(array<string|int, mixed>|int|string|float|bool|IParameter|null $i_xValue) : bool
Parameters
$i_xValue : array<string|int, mixed>|int|string|float|bool|IParameter|null
Return values
bool —

True if this parameter equals the given value.

isArray()

public isArray() : bool
Return values
bool

isBool()

Checks if the value is parseable as a boolean. Note that null is considered parseable as a boolean (false).

public isBool() : bool
Return values
bool —

True if the value is parseable as a boolean, otherwise false.

isEmpty()

Returns true if the value is null, an empty array, or an empty string.

public isEmpty() : bool

This is useful for interacting with parameters that can be optionally left blank.

Return values
bool

isNull()

public isNull() : bool
Return values
bool

isSet()

public isSet() : bool
Return values
bool

isString()

public isString() : bool
Return values
bool

new()

public new(array<string|int, mixed>|string|null $xValue) : static
Parameters
$xValue : array<string|int, mixed>|string|null
Return values
static 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results