Class QueryPathOptions

(line 3835)

Description


Located in File: /src/QueryPath/QueryPath.php

Manage default 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 QueryPathOptions (this class) have the next highest priority.
  • If the option is not specified elsewhere, QueryPath will use its own defaults.



Class Variables

Summary:
static mixed $options

static $options = array() (line 3843)

Data type : mixed

This is the static options array.

Use the set(), get(), and merge() to modify this array.

Class Constants

Summary:

Method Detail

Summary:
static array get ()
static void has (string $key)
static void merge (array $array)
static void set (array $array)

Static Method get (line 3867)

array get( )

Get the default options.

Get all options currently set as default.

Info

  • return - An array of options. Note that only explicitly set options are returned. QueryPath defines default options which are not stored in this object.

Static Method has (line 3890)

void has( string $key)

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

Parameters

  • string $key: The key to search for.

Info

Static Method merge (line 3880)

void merge( array $array)

Merge the provided array with existing options.

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

Parameters

  • array $array: Associative array of options to merge into the existing options.

Info

Static Method set (line 3853)

void set( array $array)

Set the default options.

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

Parameters

  • array $array: An associative array of options.

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Sun, 25 Jul 2010 16:09:11 -0500 by phpDocumentor 1.4.3