Docs For Class Auth_PrefManager2

void Auth_PrefManager2_Container(
[array
$options = array()])

Constructor

Applications should never call this constructor directly, instead create a container with the factory method.

See: Auth_PrefManager2::&factory()
Access: protected

Parameters:

array $options — An associative array of options.

[ Top ]

bool deletePref(
string
$preference, [string
$owner = null], [string
$application = null])

Deletes a preference for the specified owner and application.

Return: Success/failure
Access: public

Parameters:

string	`$preference`	—	The name of the preference to delete.
string	`$owner`	—	The owner to delete the preference for.
string	`$application`	—	The application to delete from, if left as null the default application will be used.

[ Top ]

mixed|null getPref(
string
$preference, [string
$owner = null], [string
$application = null], [bool
$returnDefaults = true])

Gets a preference for the specified owner and application.

Return: The value, or null of no value was available.
Access: public

Parameters:

string	`$preference`	—	The name of the preference to retrieve.
string	`$owner`	—	The owner to retrieve the preference for.
string	`$application`	—	The application to retrieve from, if left as null the default application will be used.
bool	`$returnDefaults`	—	Should a default value be returned if no user preference is available?

[ Top ]

bool setPref(
string
$preference, mixed
$value, [string
$owner = null], [string
$application = null])

Sets a preference for the specified owner and application.

Return: Success/failure
Access: public

Parameters:

string	`$preference`	—	The name of the preference to retrieve.
mixed	`$value`	—	The value to set the preference to.
string	`$owner`	—	The owner to retrieve the preference for.
string	`$application`	—	The application to retrieve from, if left as null the default application will be used.

[ Top ]

mixed _decodeValue(
mixed
$value)

Reverts any preparation that was done to store the value.

Containers that override this method should always call parent::_decodeValue() to do unserialization.

Return: The unprepared value.
Access: protected

Parameters:

mixed $value — The value to decode.

[ Top ]

bool _delete(
string
$owner, string
$preference, string
$application)

Deletes a value from the container.

This method should be overridden by container classes to do whatever needs doing.

Return: Success/failure
Abstract:
Access: protected

Overridden in child classes as:

Auth_PrefManager2_Container_Mock::_delete(): Deletes a value from the container.

Auth_PrefManager2_Container_DB::_delete(): Deletes a value from the container.

Parameters:

string	`$owner`	—	The owner to delete the preference for.
string	`$preference`	—	The name of the preference to delete.
string	`$application`	—	The application to delete from.

[ Top ]

mixed _encodeValue(
mixed
$value)

Prepares a value for saving in the data container.

Containers that override this method should always call parent::_encodeValue() to do serialization.

Return: The prepared value.
Access: protected

Parameters:

mixed $value — The value to prepare.

[ Top ]

bool _exists(
string
$owner, string
$preference, string
$application)

Checks if the specified preference exists in the data container.

This method should be overridden by container classes to do whatever needs doing.

Returns null if an error occurs.

Return: Does the pref exist?
Abstract:
Access: protected

Overridden in child classes as:

Auth_PrefManager2_Container_Mock::_exists(): Checks if the specified preference exists in the data container.

Auth_PrefManager2_Container_DB::_exists(): Checks if the specified preference exists in the data container.

Parameters:

string	`$owner`	—	The owner to delete the preference for.
string	`$preference`	—	The name of the preference to delete.
string	`$application`	—	The application to delete from.

[ Top ]

bool _get(
string
$owner, string
$preference, string
$application, mixed
$value)

Gets a value from the container.

This method should be overridden by container classes to do whatever needs doing.

Return: Success/failure
Abstract:
Access: protected

Overridden in child classes as:

Auth_PrefManager2_Container_Mock::_get(): Gets a value from the container.

Auth_PrefManager2_Container_DB::_get(): Gets a value from the container.

Parameters:

string	`$owner`	—	The owner to set the preference for.
string	`$preference`	—	The name of the preference to set.
mixed	`$value`	—	The value to set the preference to.
string	`$application`	—	The application to set for.

[ Top ]

void _parseOptions(
array
$options)

Reads the options array, and sets default values for anything which isn't set.

Container classes should override this method, set any defaults that they need, and then pass the options to parent::_parseOptions().

Access: protected

Overridden in child classes as:

Auth_PrefManager2_Container_DB::_parseOptions(): Reads the options array, and sets default values for anything which isn't set.

Parameters:

array $options — An array of options.

[ Top ]

bool _set(
string
$owner, string
$preference, 
$value, string
$application)

Sets a value with the container.

This method should be overridden by container classes to do whatever needs doing.

Return: Success/failure
Abstract:
Access: protected

Overridden in child classes as:

Auth_PrefManager2_Container_Mock::_set(): Sets a value with the container.

Auth_PrefManager2_Container_DB::_set(): Sets a value with the container.

Parameters:

string	`$owner`	—	The owner to set the preference for.
string	`$preference`	—	The name of the preference to set.
string	`$application`	—	The application to set for.
	`$value`	—

[ Top ]

void _throwError(
int
$code, [string
$level = 'error'], [array
$params = array()], [
$repackage = null])

Throws an error, using the current locale if it exists, or en if it doesn't.

Access: protected

Parameters:

int	`$code`	—	The error code.
string	`$level`	—	The level of the error.
array	`$params`	—	Any other information to include with the error.
	`$repackage`	—

[ Top ]

Class: Auth_PrefManager2_Container

Class Overview

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_errorStack = null

$_options = array()

Method Detail

Auth_PrefManager2_Container (Constructor) [line 35]

Parameters:

deletePref [line 106]

Parameters:

getPref [line 53]

Parameters:

setPref [line 83]

Parameters:

_decodeValue [line 221]

Parameters:

_delete [line 168]

Parameters:

_encodeValue [line 203]

Parameters:

_exists [line 188]

Parameters:

_get [line 150]

Parameters:

_parseOptions [line 241]

Parameters:

_set [line 131]

Parameters:

_throwError [line 287]

Parameters: