Inheritance diagram for Statusgruppen:

Collaboration diagram for Statusgruppen:

Public Member Functions
	__construct ($id=null)
	getChildren ()
	getDatafields ()
	setDatafields ($data)
	getFullGenderedPaths ($user_id, $seperator=" > ", $pre="")
	getGenderedName ($user_id)
	hasFolder ()
	updateFolder ($set)
	isMember ($user_id=null)
	getPlaces ()
	removeAllUsers ()
	removeUser ($user_id)
	addUser ($user_id, $check=false)
	userMayJoin ($user_id)
	userHasExclusiveGroup ($user_id)
	sortMembersAlphabetic ()
	hasSpace ()
	moveUser ($user_id, $pos)
	store ()
Public Member Functions inherited from SimpleORMap
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	setData ($data, $reset=false)
	haveData ()
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)

Static Public Member Functions
static	findBySeminar_id ($course_id)
static	getUserRoles ($context, $user)
Static Public Member Functions inherited from SimpleORMap
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($where=1, $params=array())
static	create ($data)
static	import ($data)
static	findBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $where, $params=array())
static	findMany ($pks=array(), $order= '', $order_params=array())
static	findEachMany ($callable, $pks=array(), $order= '', $order_params=array())
static	findAndMapBySQL ($callable, $where, $params=array())
static	findAndMapMany ($callable, $pks=array(), $order= '', $order_params=array())
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Protected Attributes
	$db_table = "statusgruppen"
	$has_many
	$belongs_to
Protected Attributes inherited from SimpleORMap
	$content = array()
	$content_db = array()
	$is_new = true
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$alias_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks
	$known_slots = array()
	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
	$notification_map = array()

Additional Inherited Members
Protected Member Functions inherited from SimpleORMap
	parseRelationOptions ($type, $name, $options)
	getTableScheme ()
	storeRelations ()
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
Static Protected Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
Static Protected Attributes inherited from SimpleORMap
static	$schemes

Constructor & Destructor Documentation

__construct ( $id = null )

constructor, give primary key of record as param to fetch corresponding record from db if available, if not preset primary key with given value. Give null to create new record

Parameters

mixed $id primary key of table

Reimplemented from SimpleORMap.

Member Function Documentation

addUser	(	$user_id,
		$check = `false`
	)

Adds a user to a group

Parameters

string	$user_id	The user id
boolean	$check	if true checks if there is space left in this group

Returns: boolean true if user was added

Here is the call graph for this function:

static findBySeminar_id ( $course_id )

static

Finds all statusgroups by a course id

Parameters

string The course id

Returns: array Statusgroups

Here is the call graph for this function:

Here is the caller graph for this function:

getChildren ( )

Here is the call graph for this function:

getDatafields ( )

Here is the call graph for this function:

Here is the caller graph for this function:

getFullGenderedPaths	(	$user_id,
		$seperator = `" > "`,
		$pre = `""`
	)

Produces an array of all statusgroups a user is in

Parameters

string	$user_id	The user_id
string	$seperator	The sign between the full paths
string	$pre	Preface of the outputted string (used for recursion)

Returns: array Stringarray of full gendered paths

Here is the call graph for this function:

getGenderedName ( $user_id )

Returns the gendered name of a statusgroup

Parameters

string $user_id The user_id

Returns: string The gendered name

Here is the caller graph for this function:

getPlaces ( )

Displayfunction to show the places left in this group

Returns: string displaystring

Here is the call graph for this function:

static getUserRoles	(	$context,
		$user
	)

static

Puts out an array of all gendered userroles for a user in a certain context

Parameters

string	$context	The context
string	$user	The user id

Returns: array All roles

Here is the caller graph for this function:

hasFolder ( )

Checks if a statusgroup has a folder.

Returns: boolean true</> if the statusgroup has a folder, else false

Here is the call graph for this function:

Here is the caller graph for this function:

hasSpace ( )

Checks if there is free space in this group

Returns: true if there is free space

Here is the call graph for this function:

Here is the caller graph for this function:

isMember ( $user_id = null )

Checks if a user is a member of this group

Parameters

string $user_id The user id

Returns: boolean true if user is a member of this group

Here is the caller graph for this function:

moveUser	(	$user_id,
		$pos
	)

Move a user to a position of a group

Parameters

string	$user
type	$pos

Here is the call graph for this function:

removeAllUsers ( )

Remove all users of this group

Here is the call graph for this function:

removeUser ( $user_id )

Remove one user of this group

Parameters

string $user_id The user id

Here is the call graph for this function:

setDatafields ( $data )

Here is the call graph for this function:

sortMembersAlphabetic ( )

Sorts the member of a group alphabetic

store ( )

store entry in database

Exceptions

UnexpectedValueException if there are forbidden NULL values

Returns: number|boolean

Reimplemented from SimpleORMap.

Here is the call graph for this function:

updateFolder ( $set )

Delete or create a filder

Parameters

boolean $set true Create a folder false Delete the folder

Here is the call graph for this function:

userHasExclusiveGroup ( $user_id )

Checks if the user is already in an exclusive group of this range

Parameters

string $user_id The user id

Returns: boolean true if user has already an exclusive group

Here is the call graph for this function:

Here is the caller graph for this function:

userMayJoin ( $user_id )

Checks if a user could join this group

Parameters

string $user_id The user id

Returns: boolean true if user is allowed to join

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$belongs_to

protected

Initial value:

 array('parent' => array('class_name' => 'Statusgruppen',
            'foreign_key' => 'range_id'
    ))

$db_table = "statusgruppen"

protected

$has_many

protected

Initial value:

 array(
        
        'members' => array(
            'class_name' => 'StatusgruppeUser',
            'on_delete' => 'delete',
            'assoc_foreign_key' => 'statusgruppe_id')
    )

The documentation for this class was generated from the following file:

lib/models/Statusgruppen.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation