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

Class: Auth_PrefManager2_Container_Mock

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

Class Overview

Auth_PrefManager2_Container
   |
   --Auth_PrefManager2_Container_Mock



Methods


Inherited Variables

Inherited Methods

Class: Auth_PrefManager2_Container

Auth_PrefManager2_Container::Auth_PrefManager2_Container()
Constructor
Auth_PrefManager2_Container::deletePref()
Deletes a preference for the specified owner and application.
Auth_PrefManager2_Container::getPref()
Gets a preference for the specified owner and application.
Auth_PrefManager2_Container::setPref()
Sets a preference for the specified owner and application.
Auth_PrefManager2_Container::_decodeValue()
Reverts any preparation that was done to store the value.
Auth_PrefManager2_Container::_delete()
Deletes a value from the container.
Auth_PrefManager2_Container::_encodeValue()
Prepares a value for saving in the data container.
Auth_PrefManager2_Container::_exists()
Checks if the specified preference exists in the data container.
Auth_PrefManager2_Container::_get()
Gets a value from the container.
Auth_PrefManager2_Container::_parseOptions()
Reads the options array, and sets default values for anything which isn't set.
Auth_PrefManager2_Container::_set()
Sets a value with the container.
Auth_PrefManager2_Container::_throwError()
Throws an error, using the current locale if it exists, or en if it doesn't.

Class Details

[line 4]


[ Top ]


Method Detail

_delete   [line 64]

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

Overrides Auth_PrefManager2_Container::_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 ]

_exists   [line 88]

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

Overrides Auth_PrefManager2_Container::_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 ]

_get   [line 42]

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

Overrides Auth_PrefManager2_Container::_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 ]

_set   [line 20]

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

Overrides Auth_PrefManager2_Container::_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 ]


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