CustomContextParam
extends AbstractContextParam
in package
Table of Contents
Constants
- TYPE_ARRAY = "array"
- TYPE_SCALAR = "scalar"
Properties
- $NAME : string
- $TYPE : string
- $attributes : array<string|int, ContextParamAttribute>
- $name : string
- $type : string
- $value : string
Methods
- __construct() : mixed
- Constructor for custom context parameter
- addAttribute() : mixed
- getAttributes() : mixed
- getName() : mixed
- getType() : mixed
- getValue() : mixed
- setName() : mixed
- setType() : mixed
- setValue() : mixed
- toArray() : mixed
Constants
TYPE_ARRAY
public
mixed
TYPE_ARRAY
= "array"
TYPE_SCALAR
public
mixed
TYPE_SCALAR
= "scalar"
Properties
$NAME
protected
static string
$NAME
= 'custom'
$TYPE
protected
static string
$TYPE
= self::TYPE_SCALAR
$attributes
private
array<string|int, ContextParamAttribute>
$attributes
$name
private
string
$name
$type
private
string
$type
= self::TYPE_SCALAR
$value
private
string
$value
Methods
__construct()
Constructor for custom context parameter
public
__construct(string $name[, string|null $value = null ][, array<string|int, mixed> $attributes = [] ]) : mixed
Parameters
- $name : string
-
The custom parameter name
- $value : string|null = null
-
The parameter value
- $attributes : array<string|int, mixed> = []
-
Additional attributes
addAttribute()
public
addAttribute(ContextParamAttribute $attribute) : mixed
Parameters
- $attribute : ContextParamAttribute
getAttributes()
public
getAttributes() : mixed
getName()
public
getName() : mixed
getType()
public
getType() : mixed
getValue()
public
getValue() : mixed
setName()
public
setName(string $name) : mixed
Parameters
- $name : string
setType()
public
setType(string $type) : mixed
Parameters
- $type : string
setValue()
public
setValue(string $value) : mixed
Parameters
- $value : string
toArray()
public
toArray() : mixed