phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: Group

Source Location: /qp_inc/users/model/_group.class.php

Class Group

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.

[ Top ]
Property Summary
mixed   $blog_post_statuses   Blog posts statuses permissions
string   $name   Name of group
mixed   $perm_admin  
mixed   $perm_blogs  
mixed   $perm_bypass_antispam  
mixed   $perm_files  
mixed   $perm_options  
mixed   $perm_security  
mixed   $perm_spamblacklist  
mixed   $perm_stats  
mixed   $perm_templates  
mixed   $perm_users  
mixed   $perm_xhtmlvalidation  
mixed   $perm_xhtmlvalidation_xmlrpc  
mixed   $perm_xhtml_css_tweaks  
mixed   $perm_xhtml_iframes  
mixed   $perm_xhtml_javascript  
mixed   $perm_xhtml_objects  

[ 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
string   get_name()   Get name of the Group
boolean   set()   Set param value

[ Top ]
Properties
mixed   $blog_post_statuses = array() [line 54]

Blog posts statuses permissions


[ Top ]
string   $name [line 49]

Name of group

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

API Tags:
Access:  protected


[ Top ]
mixed   $perm_admin [line 56]

[ Top ]
mixed   $perm_blogs [line 57]

[ Top ]
mixed   $perm_bypass_antispam = false [line 59]

[ Top ]
mixed   $perm_files [line 69]

[ Top ]
mixed   $perm_options [line 70]

[ Top ]
mixed   $perm_security [line 58]

[ Top ]
mixed   $perm_spamblacklist [line 66]

[ Top ]
mixed   $perm_stats [line 68]

[ Top ]
mixed   $perm_templates [line 67]

[ Top ]
mixed   $perm_users [line 71]

[ Top ]
mixed   $perm_xhtmlvalidation = 'always' [line 60]

[ Top ]
mixed   $perm_xhtmlvalidation_xmlrpc = 'always' [line 61]

[ Top ]
mixed   $perm_xhtml_css_tweaks = false [line 62]

[ Top ]
mixed   $perm_xhtml_iframes = false [line 63]

[ Top ]
mixed   $perm_xhtml_javascript = false [line 64]

[ Top ]
mixed   $perm_xhtml_objects = false [line 65]

[ Top ]
Methods
Constructor Group  [line 79]

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

Constructor

Parameters:
object DB   $db_row:  row


[ Top ]
check_perm  [line 161]

  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 343]

  boolean check_perm_bloggroups( string $permname, string $permlevel, integer $perm_target_blog, [Item $Item = NULL], [ $User = NULL]  )

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
string   $permlevel:  Permission level
integer   $perm_target_blog:  Permission target blog ID
Item   $Item:  post that we want to edit
   $User: 

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


[ Top ]
get_name  [line 480]

  string get_name( )

Get name of the Group



[ Top ]
set  [line 133]

  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 ]