Parameter
in package
Defines a Query Parameter.
Tags
Table of Contents
Properties
- $name : string
- The parameter name.
- $type : mixed
- The parameter type.
- $typeSpecified : bool
- Whether the parameter type was explicitly specified or not
- $value : mixed
- The parameter value.
Methods
- __construct() : mixed
- getName() : string
- Retrieves the Parameter name.
- getType() : mixed
- Retrieves the Parameter type.
- getValue() : mixed
- Retrieves the Parameter value.
- normalizeName() : string
- Returns the internal representation of a parameter name.
- setValue() : void
- Defines the Parameter value.
- typeWasSpecified() : bool
Properties
$name
The parameter name.
private
string
$name
$type
The parameter type.
private
mixed
$type
$typeSpecified
Whether the parameter type was explicitly specified or not
private
bool
$typeSpecified
$value
The parameter value.
private
mixed
$value
Methods
__construct()
public
__construct(string|int $name, mixed $value[, mixed $type = null ]) : mixed
Parameters
- $name : string|int
-
Parameter name
- $value : mixed
-
Parameter value
- $type : mixed = null
-
Parameter type
getName()
Retrieves the Parameter name.
public
getName() : string
Return values
stringgetType()
Retrieves the Parameter type.
public
getType() : mixed
getValue()
Retrieves the Parameter value.
public
getValue() : mixed
normalizeName()
Returns the internal representation of a parameter name.
public
static normalizeName(string|int $name) : string
Parameters
- $name : string|int
-
The parameter name or position.
Return values
string —The normalized parameter name.
setValue()
Defines the Parameter value.
public
setValue(mixed $value[, mixed $type = null ]) : void
Parameters
- $value : mixed
-
Parameter value.
- $type : mixed = null
-
Parameter type.
typeWasSpecified()
public
typeWasSpecified() : bool