PHP Class QueryPath\Options

This class stores the default options for QueryPath. When a new QueryPath object is constructed, options specified here will be used. Details This class defines no options of its own. Instead, it provides a central tool for developers to override options set by QueryPath. When a QueryPath object is created, it will evaluate options in the following order: - Options passed into qp() have highest priority. - Options in QueryPath::Options (this class) have the next highest priority. - If the option is not specified elsewhere, QueryPath will use its own defaults.

Public Properties

Property	Type	Description
$options		Use the {@link set()}, {@link get()}, and {@link merge()} to modify this array.

Public Methods

Method	Description
get ( ) : array	Get the default options.
has ( string $key )	Returns true of the specified key is already overridden in this object.
merge ( array $array )	Merge the provided array with existing options.
set ( array $array )	Set the default options.

Method Details

get() public static method

Get all options currently set as default.

public static get ( ) : array
return	array	An array of options. Note that only explicitly set options are returned. {@link QueryPath} defines default options which are not stored in this object.

has() public static method

Returns true of the specified key is already overridden in this object.

public static has ( string $key )
$key	string	The key to search for.

merge() public static method

On duplicate keys, the value in $array will overwrite the value stored in the options.

public static merge ( array $array )
$array	array	Associative array of options to merge into the existing options.

set() public static method

The passed-in array will be used as the default options list.

public static set ( array $array )
$array	array	An associative array of options.

Property Details

$options public_oe static_oe property

Use the {@link set()}, {@link get()}, and {@link merge()} to modify this array.

public static $options