param

IParameterSet extends ArrayAccess, JsonSerializable
in

Tags
suppress

PhanAccessWrongInheritanceCategoryInternal

extends

Table of Contents

Methods

addAllowedKey()  : void
addAllowedKeys()  : void
addDefault()  : void
addDefaults()  : void
addParameter()  : void
addParameters()  : void
get()  : IParameter|null
getAllowedKeys()  : array<int, string>|null
getEx()  : IParameter
getIgnoredKeys()  : array<int, string>
getValues()  : array<int|string, string|array<int, string>>
has()  : bool
iter()  : Generator
listKeys()  : array<int, string>
offsetExists()  : bool
offsetGet()  : IParameter
offsetSet()  : void
offsetUnset()  : void
setDefault()  : void
setMutable()  : void
setParameter()  : void
subsetByKeyPrefix()  : static
subsetByKeys()  : static
subsetByRegExp()  : static
testKeys()  : array<int, string>
unset()  : void

Methods

addAllowedKey()

public addAllowedKey(string $i_stKey) : void
Parameters
$i_stKey : string

addAllowedKeys()

public addAllowedKeys([iterable<string|int, string>|null $i_itAllowedKeys = null ]) : void
Parameters
$i_itAllowedKeys : iterable<string|int, string>|null = null
Tags
noinspection

PhpDocSignatureInspection iterable is broken in PhpStorm

addDefault()

public addDefault(string $i_stKey[, array<string|int, mixed>|string|IParameter|null $i_xValue = null ]) : void
Parameters
$i_stKey : string
$i_xValue : array<string|int, mixed>|string|IParameter|null = null

addDefaults()

public addDefaults([iterable<string, array<string|int, mixed>|string|IParameter|null>|null $i_itDefaults = null ]) : void
Parameters
$i_itDefaults : iterable<string, array<string|int, mixed>|string|IParameter|null>|null = null
Tags
noinspection

PhpDocSignatureInspection iterable is broken in PhpStorm

addParameter()

public addParameter(string $i_stKey[, array<string|int, mixed>|string|IParameter|null $i_xValue = null ]) : void
Parameters
$i_stKey : string
$i_xValue : array<string|int, mixed>|string|IParameter|null = null

addParameters()

public addParameters([iterable<string, array<string|int, mixed>|string|IParameter|null>|null $i_itParameters = null ]) : void
Parameters
$i_itParameters : iterable<string, array<string|int, mixed>|string|IParameter|null>|null = null
Tags
noinspection

PhpDocSignatureInspection iterable is broken in PhpStorm

get()

public get(string $i_stKey[, mixed $i_xDefault = null ]) : IParameter|null
Parameters
$i_stKey : string
$i_xDefault : mixed = null
Return values
IParameter|null

getAllowedKeys()

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

getIgnoredKeys()

public getIgnoredKeys() : array<int, string>
Return values
array<int, string>

getValues()

public getValues() : array<int|string, string|array<int, string>>
Return values
array<int|string, string|array<int, string>> —

All values, de-parameterized.

Suitable for displaying in debug output or serializing.

has()

public has(string ...$i_rstKeys) : bool
Parameters
$i_rstKeys : string
Return values
bool

listKeys()

public listKeys() : array<int, string>
Return values
array<int, string>

offsetExists()

public offsetExists(array<int, string>|string|null $offset) : bool
Parameters
$offset : array<int, string>|string|null
Return values
bool

offsetSet()

public offsetSet(string|null $offset, array<string|int, mixed>|string|Parameter|null $value) : void
Parameters
$offset : string|null
$value : array<string|int, mixed>|string|Parameter|null

offsetUnset()

public offsetUnset(iterable<string|int, string>|string|null $offset) : void
Parameters
$offset : iterable<string|int, string>|string|null

setDefault()

public setDefault(string $i_stKey, array<string|int, mixed>|string|Parameter|null $i_xValue) : void
Parameters
$i_stKey : string
$i_xValue : array<string|int, mixed>|string|Parameter|null

setMutable()

public setMutable(bool $i_bMutable) : void
Parameters
$i_bMutable : bool

setParameter()

public setParameter(string $i_stKey, array<string|int, mixed>|string|Parameter|null $i_xValue) : void
Parameters
$i_stKey : string
$i_xValue : array<string|int, mixed>|string|Parameter|null

subsetByKeyPrefix()

public subsetByKeyPrefix(string $i_stPrefix) : static
Parameters
$i_stPrefix : string
Return values
static

subsetByKeys()

public subsetByKeys(callable(string): bool $i_fnFilter) : static
Parameters
$i_fnFilter : callable(string): bool
Return values
static

subsetByRegExp()

public subsetByRegExp(string $i_reFilter) : static
Parameters
$i_reFilter : string
Return values
static

testKeys()

public testKeys(string ...$i_rstKeys) : array<int, string>
Parameters
$i_rstKeys : string
Return values
array<int, string>

unset()

public unset(string|iterable<string|int, string> $i_keys[, bool $i_bAlsoDropDefault = false ]) : void
Parameters
$i_keys : string|iterable<string|int, string>

The key (or keys) to remove from the set

$i_bAlsoDropDefault : bool = false

If true, any default value for the key will also be removed.

Tags
noinspection

PhpDocSignatureInspection

Return values
void —

Drops the parameter from the set. If the parameter is not in the set, it does nothing.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results