Docs For Class Group

Class Overview

User Group

Group of users with specific permissions.

Located in /blogs/inc/MODEL/users/_group.class.php [line 43]

DataObject
   |
   --Group

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::check_delete() Check relations for restrictions before deleting DataObject::check_relations() Check relations for restrictions or cascades DataObject::confirm_delete() Displays form to confirm deletion of this object DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() Delete object from DB. DataObject::dbinsert() Insert object into DB based on previously recorded changes. DataObject::dbsave() Inserts or Updates depending on object state. DataObject::dbupdate() Update the DB based on previously recorded changes DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::history_info_icon() Create icon with dataobject history DataObject::ID() Template function: Displays object ID. DataObject::set() Set param value DataObject::set_from_Request() Set a parameter from a Request form value. DataObject::set_param() Set param value.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::check_delete()

Check relations for restrictions before deleting

DataObject::check_relations()

Check relations for restrictions or cascades

DataObject::confirm_delete()

Displays form to confirm deletion of this object

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

Delete object from DB.

DataObject::dbinsert()

Insert object into DB based on previously recorded changes.

DataObject::dbsave()

Inserts or Updates depending on object state.

DataObject::dbupdate()

Update the DB based on previously recorded changes

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::history_info_icon()

Create icon with dataobject history

DataObject::ID()

Template function: Displays object ID.

DataObject::set()

Set param value

DataObject::set_from_Request()

Set a parameter from a Request form value.

DataObject::set_param()

Set param value.

[ Top ]

Property Summary

mixed	$blog_post_statuses	Blog posts statuses permissions
string	$name	Name of group

[ Top ]

Method Summary

Group	Group()	Constructor
boolean	check_perm()	Check a permission for this group.
boolean	check_perm_bloggroups()	Check permission for this group on a specified blog
boolean	check_perm_catsgroups()	Check permission for this group on a set of specified categories
void	name()	Template function: display name of blog
void	name_return()	Template function: return name of group
boolean	set()	Set param value

[ Top ]

Properties

mixed $blog_post_statuses = array() [line 58]

Blog posts statuses permissions

[ Top ]

string $name [line 53]

Name of group

Please use get/set functions to read or write this param

API Tags:

Access:

protected

[ Top ]

Methods

Constructor Group [line 66]

Group Group(
[object DB
$db_row = NULL] 
)

Constructor

Parameters:

object DB

$db_row:

row

[ Top ]

check_perm [line 143]

boolean check_perm(
string
$permname, [string
$permlevel = 'any'], [mixed
$perm_target = NULL] 
)

Check a permission for this group.

Parameters:

string	$permname:	Permission name: templates stats spamblacklist options users blogs admin (levels "visible", "hidden")
string	$permlevel:	Requested permission level
mixed	$perm_target:	Permission target (blog ID, array of cat IDs...)

API Tags:

Return:

True on success (permission is granted), false if permission is not granted

[ Top ]

check_perm_bloggroups [line 324]

boolean check_perm_bloggroups(
string
$permname, string
$permlevel, integer
$perm_target_blog 
)

Check permission for this group on a specified blog

This is not for direct use, please call User::check_perm() instead user is checked for privileges first, group lookup only performed on a false result

Parameters:

string	$permname:	Permission name, can be one of the following: blog_ismember blog_post_statuses blog_del_post blog_comments blog_cats blog_properties blog_genstatic
string	$permlevel:	Permission level
integer	$perm_target_blog:	Permission target blog ID

API Tags:

Return:	0 if permission denied
See:	User::check_perm()

[ Top ]

check_perm_catsgroups [line 272]

boolean check_perm_catsgroups(
string
$permname, string
$permlevel, array
&$perm_target_cats 
)

Check permission for this group on a set of specified categories

This is not for direct use, please call User::check_perm() instead

Parameters:

string	$permname:	Permission name, can be one of the following: cat_post_statuses more to come later...
string	$permlevel:	Permission level
array	&$perm_target_cats:	Array of target cat IDs

API Tags:

Return:	0 if permission denied
See:	User::check_perm()

[ Top ]

name [line 396]

void name(
[string
$format = 'htmlbody'], [
$disp = true] 
)

Template function: display name of blog

Parameters:

string	$format:	Output format, see format_to_output()
	$disp:

[ Top ]

name_return [line 414]

void name_return(
[string
$format = 'htmlbody'] 
)

Template function: return name of group

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

set [line 115]

boolean set(
string
$parname, mixed
$parvalue 
)

Set param value

Parameters:

string	$parname:	Parameter name
mixed	$parvalue:	Parameter value

API Tags:

Return:

true, if a value has been set; false if it has not changed

Redefinition of:

DataObject::set(): Set param value

[ Top ]

Multilingual multiuser multiblog engine

Class: Group

Class Group

Packages

Classes

Files