1. class
  2. PhpMyAdmin
  3. \
  4. SqlParser
  5. \
  6. Components
  7. \
  8. OptionsArray

OptionsArray

final class OptionsArray implements Component (View source)

Methods

__construct(array $options = [])

No description

string
build()

Builds the string representation of a component of this type.

bool
has(string $key)

No description

Expression
get(string $key, bool $getExpr = false)

Checks if it has the specified option and returns its value.

bool
remove(string $key)

Removes the option from the array.

void
merge(OptionsArray $options)

Merges the specified options with these ones. Values with same ID will be replaced.

bool
isEmpty()

Checks tf there are no options set.

string
__toString()

No description

Details

at line 26
__construct(array $options = [])

No description

Parameters

array $options

$options The array of options. Options that have a value must be an array with at least two keys name and expr or value.

at line 30
string build()

Builds the string representation of a component of this type.

In other words, this function represents the inverse function of {\PhpMyAdmin\SqlParser\Component::parse()}.

Return Value

string

at line 50
bool has(string $key)

No description

Parameters

string $key

Return Value

bool

at line 72
Expression get(string $key, bool $getExpr = false)

Checks if it has the specified option and returns its value.

Parameters

string $key

the key to be checked
bool $getExpr

Gets the expression instead of the value. The value is the processed form of the expression.

Return Value

Expression

at line 94
bool remove(string $key)

Removes the option from the array.

Parameters

string $key

the key to be removed

Return Value

bool

whether the key was found and deleted or not

at line 117
void merge(OptionsArray $options)

Merges the specified options with these ones. Values with same ID will be replaced.

Parameters

OptionsArray $options

Return Value

void

at line 125
bool isEmpty()

Checks tf there are no options set.

Return Value

bool

at line 130
string __toString()

No description

Return Value

string