Docs For Class GroupSettings

Class Overview

GroupSettings class

This class represents group permissions

Located in /blogs/inc/users/model/_groupsettings.class.php [line 14]

AbstractSettings
   |
   --GroupSettings

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From AbstractSettings AbstractSettings::$all_loaded AbstractSettings::$cache AbstractSettings::$cache_by_col_keys AbstractSettings::$col_key_names AbstractSettings::$col_value_name AbstractSettings::$db_table_name AbstractSettings::$_defaults	Inherited From AbstractSettings AbstractSettings::AbstractSettings() Constructor. AbstractSettings::dbupdate() Commit changed settings to DB. AbstractSettings::delete() Remove a setting. AbstractSettings::delete_array() Delete an array of values. AbstractSettings::get() Get a setting from the DB settings table. AbstractSettings::get_cond() Only set the first variable (passed by reference) if we could retrieve a setting. AbstractSettings::get_default() Get the default for the last key of $col_key_names AbstractSettings::load_all() Load all settings, disregarding the derived classes setting of $cache_by_col_keys useful if you know that you want to get all user settings for example. AbstractSettings::param_Request() Get a param from Request and save it to Settings, or default to previously saved user setting. AbstractSettings::reset() Reset cache (includes settings to be written to DB). AbstractSettings::restore_defaults() Delete values for $_defaults in DB. AbstractSettings::set() Temporarily sets a setting (dbupdate() writes it to DB). AbstractSettings::set_array() Set an array of values. AbstractSettings::_load() Loads the settings. Not meant to be called directly, but gets called when needed.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From AbstractSettings

AbstractSettings::$all_loaded

AbstractSettings::$cache

AbstractSettings::$cache_by_col_keys

AbstractSettings::$col_key_names

AbstractSettings::$col_value_name

AbstractSettings::$db_table_name

AbstractSettings::$_defaults

Inherited From AbstractSettings

AbstractSettings::AbstractSettings()

Constructor.

AbstractSettings::dbupdate()

Commit changed settings to DB.

AbstractSettings::delete()

Remove a setting.

AbstractSettings::delete_array()

Delete an array of values.

AbstractSettings::get()

Get a setting from the DB settings table.

AbstractSettings::get_cond()

Only set the first variable (passed by reference) if we could retrieve a setting.

AbstractSettings::get_default()

Get the default for the last key of $col_key_names

AbstractSettings::load_all()

Load all settings, disregarding the derived classes setting of $cache_by_col_keys
useful if you know that you want to get
all user settings for example.

AbstractSettings::param_Request()

Get a param from Request and save it to Settings, or default to previously saved user setting.

AbstractSettings::reset()

Reset cache (includes settings to be written to DB).

AbstractSettings::restore_defaults()

Delete values for $_defaults in DB.

AbstractSettings::set()

Temporarily sets a setting (dbupdate() writes it to DB).

AbstractSettings::set_array()

Set an array of values.

AbstractSettings::_load()

Loads the settings. Not meant to be called directly, but gets called when needed.

[ Top ]

Property Summary

array	$permission_modules	Permission modules
array	$permission_values	Current or default permission values

[ Top ]

Method Summary

GroupSettings	GroupSettings()	Constructor
void	add()	Add default permission to the group.
void	dbupdate()	Update the DB based on previously recorded changes
void	delete()	Delete all of the group permissions
void	get()	Get a permission from the DB group settings table
void	load()	Load permissions
void	set()	Temporarily sets a group permission (dbupdate() writes it to DB)

[ Top ]

Properties

array $permission_modules = array() [line 26]

Permission modules

[ Top ]

array $permission_values = array() [line 20]

Current or default permission values

[ Top ]

Methods

Constructor GroupSettings [line 39]

GroupSettings GroupSettings(
)

Constructor

[ Top ]

add [line 111]

void add(
string
$module, array
$permissions, integer
$grp_ID 
)

Add default permission to the group.

Each module can define its own default permissions.

Parameters:

string	$module:	module name
array	$permissions:	permissions
integer	$grp_ID:	Group ID

[ Top ]

dbupdate [line 164]

void dbupdate(
integer
$grp_ID 
)

Update the DB based on previously recorded changes

Parameters:

integer

$grp_ID:

Group ID

Redefinition of:

AbstractSettings::dbupdate(): Commit changed settings to DB.

[ Top ]

delete [line 186]

void delete(
@param
$grp_ID 
)

Delete all of the group permissions

Parameters:

@param

$grp_ID:

integer Group ID

Redefinition of:

AbstractSettings::delete(): Remove a setting.

[ Top ]

get [line 130]

void get(
string
$permission, integer
$grp_ID 
)

Get a permission from the DB group settings table

Parameters:

string	$permission:	name of permission
integer	$grp_ID:	Group

Redefinition of:

AbstractSettings::get(): Get a setting from the DB settings table.

[ Top ]

load [line 50]

void load(
integer
$grp_ID 
)

Load permissions

Parameters:

integer

$grp_ID:

Group ID

[ Top ]

set [line 147]

void set(
string
$permission, mixed
$value, integer
$grp_ID 
)

Temporarily sets a group permission (dbupdate() writes it to DB)

Parameters:

string	$permission:	name of permission
mixed	$value:	new value
integer	$grp_ID:	Group ID

Redefinition of:

AbstractSettings::set(): Temporarily sets a setting (dbupdate() writes it to DB).

[ Top ]

Multilingual multiuser multiblog engine

Class: GroupSettings

Class GroupSettings

Packages

Classes

Files