1. class
  2. Windwalker
  3. Console
  4. Option
  5. OptionSet

OptionSet

class OptionSet implements IteratorAggregate, ArrayAccess, Countable, Serializable (View source)

Option set to store options and resolve aliases.

Methods

OptionSet
addOption(Option $option)

Add a new option.

Traversable
getIterator()

Retrieve an external iterator

boolean
offsetExists(mixed $name)

Is a option exists?

Option|null
offsetGet(mixed $name)

Get an option by name.

void
offsetSet(string $name, Option $option)

Set a new option.

void
offsetUnset(string $name)

Remove an option.

integer
count()

Count options.

string
serialize()

Serialize this object

void
unserialize(string $data)

Un serialize this object.

Option[]
toArray()

Convert to array.

Details

at line line 34
OptionSet addOption(Option $option)

Add a new option.

Parameters

Option $option Option object.

Return Value

OptionSet Return self to support chaining.

at line line 48
Traversable getIterator()

Retrieve an external iterator

Return Value

Traversable An instance of an object implementing Iterator or Traversable

at line line 84
boolean offsetExists(mixed $name)

Is a option exists?

Parameters

mixed $name Option name.

Return Value

boolean True if option exists.

at line line 98
Option|null offsetGet(mixed $name)

Get an option by name.

Parameters

mixed $name Option name to get option.

Return Value

Option|null Return option object if exists.

at line line 113
void offsetSet(string $name, Option $option)

Set a new option.

Parameters

string $name No use here, we use option name.
Option $option The option object to set in this set.

Return Value

void

at line line 129
void offsetUnset(string $name)

Remove an option.

Parameters

string $name Option name to remove from this set.

Return Value

void

at line line 146
integer count()

Count options.

Return Value

integer Number of options.

at line line 158
string serialize()

Serialize this object

Return Value

string

at line line 172
void unserialize(string $data)

Un serialize this object.

Parameters

string $data Serialized data.

Return Value

void

at line line 184
Option[] toArray()

Convert to array.

Return Value

Option[]