Docs For Class User

Class Overview

User Class

Located in /blogs/b2evocore/_class_user.php [line 23]

DataObject
   |
   --User

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() DataObject::dbinsert() DataObject::dbupdate() 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::ID() Template function: Displays object ID DataObject::set_param() Set param value

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::dbchange()

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

DataObject::dbdelete()

DataObject::dbinsert()

DataObject::dbupdate()

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::ID()

Template function: Displays object ID

DataObject::set_param()

Set param value

[ Top ]

Property Summary

mixed	$aim
mixed	$blog_post_statuses
mixed	$browser
mixed	$datecreated
mixed	$domain
mixed	$email
mixed	$firstname
mixed	$Group
mixed	$icq
mixed	$idmode
mixed	$ip
mixed	$lastname
mixed	$level
mixed	$locale
mixed	$login
mixed	$msn
mixed	$nickname
mixed	$notify
mixed	$pass
mixed	$url
mixed	$yim

[ Top ]

Method Summary

User	User()	Constructor
boolean	check_perm()	Check permission for this user
boolean	check_perm_blogusers()	Check permission for this user on a specified blog
boolean	check_perm_catsusers()	Check permission for this user on a set of specified categories
void	dbdelete()	Delete user and dependencies from database
void	get()	Get a param
void	level()	Template function: display user's level
void	login()	Template function: display user's login
void	prefered_name()	Template function: display user's prefered name
void	set()
void	setGroup()
void	set_datecreated()
void	url()	Template function: display user's URL

[ Top ]

Properties

mixed $aim [line 35]

[ Top ]

mixed $blog_post_statuses = array() [line 48]

[ Top ]

mixed $browser [line 40]

[ Top ]

mixed $datecreated [line 41]

[ Top ]

mixed $domain [line 39]

[ Top ]

mixed $email [line 32]

[ Top ]

mixed $firstname [line 27]

[ Top ]

mixed $Group [line 45]

[ Top ]

mixed $icq [line 34]

[ Top ]

mixed $idmode [line 30]

[ Top ]

mixed $ip [line 38]

[ Top ]

mixed $lastname [line 28]

[ Top ]

mixed $level [line 42]

[ Top ]

mixed $locale [line 31]

[ Top ]

mixed $login [line 25]

[ Top ]

mixed $msn [line 36]

[ Top ]

mixed $nickname [line 29]

[ Top ]

mixed $notify [line 43]

[ Top ]

mixed $pass [line 26]

[ Top ]

mixed $url [line 33]

[ Top ]

mixed $yim [line 37]

[ Top ]

Methods

Constructor User [line 57]

User User(
[array
$userdata = NULL] 
)

Constructor

Parameters:

array

$userdata:

existing userdata get_userdata()}

[ Top ]

check_perm [line 211]

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

Check permission for this user

Parameters:

string	$permname:	Permission name, can be one of: 'upload' 'edit_timestamp' 'cats_post_statuses', see User::check_perm_catsusers() either group permission names, see Group::check_perm() either blogusers permission names, see User::check_perm_blogusers()
string	$permlevel:	Permission level
boolean	$assert:	Execution will halt if this is !0 and permission is denied
mixed	$perm_target:	Permission target (blog ID, array of cat IDs...)

API Tags:

Return:

0 if permission denied

[ Top ]

check_perm_blogusers [line 342]

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

Check permission for this user on a specified blog

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

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_catsusers [line 289]

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

Check permission for this user 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 ]

dbdelete [line 419]

void dbdelete(
[boolean
$echo = false] 
)

Delete user and dependencies from database

Includes WAY TOO MANY requests because we try to be compatible with mySQL 3.23, bleh!

Parameters:

boolean

$echo:

true if you want to echo progress

Information Tags:

Todo:

delete comments on user's posts

Redefinition of:

DataObject::dbdelete()

[ Top ]

get [line 123]

void get(

$parname 
)

Get a param

Parameters:

$parname:

Redefinition of:

DataObject::get(): Get a member param by its name

[ Top ]

level [line 488]

void level(
)

Template function: display user's level

[ Top ]

login [line 501]

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

Template function: display user's login

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

prefered_name [line 514]

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

Template function: display user's prefered name

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

set [line 155]

void set(

$parname, 
$parvalue 
)

Parameters:

	$parname:
	$parvalue:

[ Top ]

setGroup [line 188]

void setGroup(

&$Group 
)

Parameters:

&$Group:

[ Top ]

set_datecreated [line 175]

void set_datecreated(

$datecreated 
)

Parameters:

$datecreated:

[ Top ]

url [line 528]

void url(
[string
$before = ''], [string
$after = ''], [string
$format = 'htmlbody'] 
)

Template function: display user's URL

Parameters:

string	$before:	string to display before the date (if changed)
string	$after:	string to display after the date (if changed)
string	$format:	Output format, see format_to_output()

[ Top ]

Multilingual multiuser multiblog engine

Class: User

Class User

Packages

Classes

Files