Auth_PrefManager2
[ class tree: Auth_PrefManager2 ] [ index: Auth_PrefManager2 ] [ all elements ]

Class: Auth_PrefManager2

Source Location: /Auth_PrefManager2-2.0.0dev1/PrefManager2.php

Class Overview


Auth_PrefManager allows you to store and retrieve preferences from data containers, selecting the default value if none exists for the user you have specified.


Author(s):

Version:

  • 0.1.0

Methods


Inherited Variables

Inherited Methods


Class Details

[line 45]
Auth_PrefManager allows you to store and retrieve preferences from data containers, selecting the default value if none exists for the user you have specified.


[ Top ]


Method Detail

factory   [line 62]

Auth_PrefManager2 &factory( string $container, [array $options = array()])

Creates an instance of PrefManager, with the options specified, and data access being done by the specified container.

If your using a custom container you can include it before calling the factory method and it will be used without any further setup.

  • Return: A container, ready to use.
  • Throws: AUTH_PREFMANAGER2_CONTAINER_NOT_FOUND
  • Access: public

Parameters:

string   $container   —  The container to use.
array   $options   —  An associative array of options to pass to the container.

[ Top ]

singleton   [line 109]

Auth_PrefManager2 &singleton( string $container, [array $options = array()])

Returns a concrete PrefManager container, making use of an existing one if available.
  • Return: A container, ready to use.
  • Throws: AUTH_PREFMANAGER2_CONTAINER_NOT_FOUND
  • Access: public

Parameters:

string   $container   —  The container to use.
array   $options   —  An associative array of options to pass to the container.

[ Top ]

_throwError   [line 134]

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 ]


Documentation generated on Mon, 11 Mar 2019 13:54:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.