Docs For Class user

Methods

Constructor user [line 52]

void user(

&$spunq, object
$spunq 
)

user::user()

// constructor

Parameters:

object	$spunq:	// spunq core object
	&$spunq:

[ Top ]

Constructor __construct [line 39]

void __construct(

&$spunq, object
$spunq 
)

user::__construct()

// constructor for php 5

Parameters:

object	$spunq:	// spunq core object
	&$spunq:

[ Top ]

addGroup [line 355]

void addGroup(
)

user::addGroup()

// inserts a new row into db_group

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

checkPassword [line 191]

void checkPassword(
)

user::checkPassword() // check if a given password is ok and save it to the user ...

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

createChildGroup [line 386]

void createChildGroup(
)

user::createChildGroup()

// creates a child group for a certain parent / used for content permissions

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

delGroup [line 365]

void delGroup(
)

user::delGroup()

// deletes a group from db_group

API Tags:

Return:

(int, object) message_id for display error-message

[ Top ]

delGroupChild [line 413]

void delGroupChild(
int
$id 
)

user::delGroupchild()

// deletes a group from db_group

Parameters:

int

$id:

// contentgroup id stored in database

API Tags:

Return:

(int, object) message id or pear-db error message

[ Top ]

delUserData [line 171]

void delUserData(
int
$uid 
)

user::delUserData() // check if a given password is ok and save it to the user ...

Parameters:

int

$uid:

// userid stored in database

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

getAllCGroups [line 503]

void getAllCGroups(
)

user::getAllCGroups()

// returns content groups

[ Top ]

getAllGroups [line 486]

void getAllGroups(
)

user::getAllGroups()

// returns all systemgroups with content groups as childs

API Tags:

Return:

(int, array) parents and childs for group-tree

[ Top ]

getGroupChildData [line 425]

void getGroupChildData(
int
$id 
)

user::getGroupChildData()

// deletes a group from db_group

Parameters:

int

$id:

// contentgroup id stored in database

API Tags:

Return:

(object, TRUE) TRUE or pear-db error message

[ Top ]

getGroupChilds [line 401]

void getGroupChilds(
)

user::getGroupChildData()

// deletes a group from db_group

API Tags:

Return:

(content groups) list of c_groups or pear-db message on error

[ Top ]

getGroupData [line 346]

void getGroupData(
int
$gid 
)

user::getGroupData()

// returns data for group

Parameters:

int

$gid:

// groupid stored in database

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

getGroupList [line 336]

void getGroupList(
)

user::getGroupList()

// returns list of all groups

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

getRelatedUsers [line 436]

array getRelatedUsers(
int
$group_id, int
$class 
)

user::getRelatedUsers()

// deletes a group from db_group

Parameters:

int	$group_id:	// id for system groups stored in database
int	$class:	// classid for relation

API Tags:

Return:

users for the given group

[ Top ]

getUserContentGroupRelation [line 258]

array getUserContentGroupRelation(
[int
$uid = 0] 
)

user::getUserContentGroupRelation()

// get relations for user and groups

Parameters:

int

$uid:

// userid stored in database

API Tags:

Return:

list of groups and users

[ Top ]

getUserData [line 64]

void getUserData(
[int
$uid = 0] 
)

user::getUserData()

// returns row of userdata

Parameters:

int

$uid:

// userid stored in database

API Tags:

Return:

// userdata

[ Top ]

getUserGroupRelation [line 225]

array getUserGroupRelation(
[int
$uid = 0] 
)

user::getUserGroupRelation()

// get relations for user and groups

Parameters:

int

$uid:

// userid stored in database

API Tags:

Return:

list of groups and users

[ Top ]

getUserList [line 77]

void getUserList(
)

user::getUserList()

// returns all users

API Tags:

Return:

data of all users

[ Top ]

insertUserData [line 133]

void insertUserData(
)

user::insertUserData()

// write row of userdata to database

API Tags:

Return:

// object, TRUE return value from pear-db

[ Top ]

savePassword [line 209]

void savePassword(
[int
$uid = 0] 
)

user::savePassword() // encrypt and save password for user ...

Parameters:

int

$uid:

// userid stored in database

API Tags:

Return:

(object, TRUE) // return value from pear-db

[ Top ]

updateGroupMembers [line 460]

void updateGroupMembers(
)

user::updateGroupMembers()

// updates group/user relations

[ Top ]

updateUserContentGroupRelation [line 311]

void updateUserContentGroupRelation(
[int
$uid = 0], array
$newgroups 
)

user::udpateUserGroupRelation()

// get relations for user and groups

Parameters:

int	$uid:	// userid stored in database
array	$newgroups:	// systemgroups

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

updateUserData [line 94]

void updateUserData(
[int
$uid = 0] 
)

user::updateUserData()

// write row of userdata to database

Parameters:

int

$uid:

// userid stored in database

API Tags:

Return:

// TRUE or object return value from pear-db

[ Top ]

updateUserGroupRelation [line 293]

void updateUserGroupRelation(
[int
$uid = 0], 
$s_group, array
$newgroups 
)

user::udpateUserGroupRelation()

// get relations for user and groups

Parameters:

int	$uid:	// userid stored in database
array	$newgroups:	// systemgroups
	$s_group:

API Tags:

Return:

(object, TRUE) return value from pear-db

[ Top ]

	spunq-backend

[ class tree: spunq-backend ] [ index: spunq-backend ] [ all elements ]

Class: user

Class user