Class: Base_User_SettingsCommon

Source Location: /modules/Base/User/Settings/SettingsCommon_0.php

Class Base_User_SettingsCommon

Class Overview

User_Settings class.

Located in /modules/Base/User/Settings/SettingsCommon_0.php [line 14]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_User_SettingsCommon

Author(s):

Arkadiusz Bisaga <abisaga@telaxus.com> and Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2008, Telaxus LLC
License:	MIT

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static void	admin_access()
static void	admin_caption()
static void	body_access()
static mixed	get()	Returns user setting.
static mixed	get_admin()	Returns admin setting.
static mixed	get_default()	Returns default setting.
static void	menu()
static bool	save()	Sets user setting to given value for currently logged in user.
static bool	save_admin()	Sets admin setting to given value for currently logged in user.

[ Top ]

Methods

static method admin_access [line 27]

static void admin_access(
)

API Tags:

Access:

public

[ Top ]

static method admin_caption [line 31]

static void admin_caption(
)

API Tags:

Access:

public

[ Top ]

static method body_access [line 23]

static void body_access(
)

API Tags:

Access:

public

[ Top ]

static method get [line 113]

static mixed get(
string
$module, string
$name, [
$user = null] 
)

Returns user setting.

If user is logged in, returns user prefered setting, otherwise returns default value.

Parameters:

string	$module:	module name
string	$name:	variable name
	$user:

API Tags:

Return:	user value
Access:	public

[ Top ]

static method get_admin [line 89]

static mixed get_admin(
string
$module, string
$name 
)

Returns admin setting.

Parameters:

string	$module:	module name
string	$name:	variable name

API Tags:

Return:	user value
Access:	public

[ Top ]

static method get_default [line 42]

static mixed get_default(
string
$module, string
$name 
)

Returns default setting.

Parameters:

string	$module:	module name
string	$name:	variable name

API Tags:

Return:	variable value
Access:	public

[ Top ]

static method menu [line 18]

static void menu(
)

API Tags:

Access:

public

[ Top ]

static method save [line 139]

static bool save(
string
$module, string
$name, mixed
$value 
)

Sets user setting to given value for currently logged in user.

Returns false if no user is logged in.

Parameters:

string	$module:	module name
string	$name:	variable name
mixed	$value:	value

API Tags:

Return:	true on success, false otherwise
Access:	public

[ Top ]

static method save_admin [line 169]

static bool save_admin(
string
$module, string
$name, mixed
$value 
)

Sets admin setting to given value for currently logged in user.

Returns false on permission denied.

Parameters:

string	$module:	module name
string	$name:	variable name
mixed	$value:	value

API Tags:

Return:	true on success, false otherwise
Access:	public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:45:59 -0500 by phpDocumentor 1.4.2

	epesi-base user-settings

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]