PHPXRef 0.7 : MantisBT : Detail view of options.php

File containing the ezcBaseOptions class.

Copyright:	Copyright (C) 2005-2009 eZ Systems AS. All rights reserved.
License:	http://ez.no/licenses/new_bsd New BSD License
Version:	1.8
File Size:	174 lines (5 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 8 functions

  __construct()
  merge()
  __get()
  __isset()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()

Functions

Functions that are not part of a class:

__construct( array $options = array() X-Ref

Construct a new options object.
Options are constructed from an option array by default. The constructor
automatically passes the given options to the __set() method to set them
in the class.

param: array(string=>mixed) $options The initial options to set.

merge( array $newOptions ) X-Ref

Merge an array into the actual options object.
This method merges an array of new options into the actual options object.

param: array(string=>mixed) $newOptions The new options.

__get( $propertyName ) X-Ref

Property get access.
Simply returns a given option.

param: string $propertyName The name of the option to get.
return: mixed The option value.

__isset( $propertyName ) X-Ref

Returns if a option exists.

param: string $propertyName Option name to check for.
return: bool Whether the option exists.

offsetExists( $propertyName ) X-Ref

Returns if an option exists.
Allows isset() using ArrayAccess.

param: string $propertyName The name of the option to get.
return: bool Whether the option exists.

offsetGet( $propertyName ) X-Ref

Returns an option value.
Get an option value by ArrayAccess.

param: string $propertyName The name of the option to get.
return: mixed The option value.

offsetSet( $propertyName, $propertyValue ) X-Ref

Set an option.
Sets an option using ArrayAccess.

param: string $propertyName The name of the option to set.
param: mixed $propertyValue The value for the option.

offsetUnset( $propertyName ) X-Ref

Unset an option.
Unsets an option using ArrayAccess.

param: string $propertyName The name of the option to unset.

PHP Cross Reference of MantisBT

/library/ezc/Base/src/ -> options.php (summary)

Defines 8 functions