Documentation

paramStore
in package

A class that stores parameters.

Table of Contents

$case_sensitive  : string|array<string|int, mixed>|object|null
Declaring a private variable called `$case_sensitive` that can be of any type.
$data  : array<string|int, mixed>
Declaring a private variable called `$data` that is an array.
__construct()  : mixed
A constructor.
__toString()  : mixed
Returning the `$data` variable as a JSON string.
all()  : array<string|int, mixed>
Returning the `$data` variable.
clear()  : void
Clearing the data in the `$data` variable.
get()  : mixed
Getting the value of the `$key` parameter from the `$data` variable. If the `$key` parameter is not in the `$data` variable, it will return the `$default` parameter.
has()  : bool
Checking if the `$key` parameter is in the `$data` variable.
remove()  : void
Removing the `$key` parameter from the `$data` variable.
replace()  : void
Replacing the data in the `$data` variable with the data in the `$data` parameter.
set()  : void
Setting the value of the `$key` parameter to the `$value` parameter.
normalizeKey()  : mixed
Normalizing the key.

Properties

$case_sensitive

Declaring a private variable called `$case_sensitive` that can be of any type.

private string|array<string|int, mixed>|object|null $case_sensitive

$data

Declaring a private variable called `$data` that is an array.

private array<string|int, mixed> $data

Methods

__construct()

A constructor.

public __construct([mixed $parameters = array() ], mixed $case_sensitive) : mixed
Parameters
$parameters : mixed = array()
$case_sensitive : mixed
Return values
mixed

__toString()

Returning the `$data` variable as a JSON string.

public __toString() : mixed
Return values
mixed

all()

Returning the `$data` variable.

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

clear()

Clearing the data in the `$data` variable.

public clear() : void
Return values
void

get()

Getting the value of the `$key` parameter from the `$data` variable. If the `$key` parameter is not in the `$data` variable, it will return the `$default` parameter.

public get(mixed $key[, mixed $default = null ]) : mixed
Parameters
$key : mixed
$default : mixed = null
Return values
mixed

has()

Checking if the `$key` parameter is in the `$data` variable.

public has(mixed $key) : bool
Parameters
$key : mixed
Return values
bool

remove()

Removing the `$key` parameter from the `$data` variable.

public remove(mixed $key) : void
Parameters
$key : mixed
Return values
void

replace()

Replacing the data in the `$data` variable with the data in the `$data` parameter.

public replace(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void

set()

Setting the value of the `$key` parameter to the `$value` parameter.

public set(mixed $key, mixed $value[, mixed $replace = true ]) : void
Parameters
$key : mixed
$value : mixed
$replace : mixed = true
Return values
void

normalizeKey()

Normalizing the key.

private normalizeKey(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

Search results