UserGroup

Extends \LSActiveRecord

Class UserGroup

package

Default

Methods

addGroup

addGroup(string $group_name, string $group_description) : boolean
todo

should use save() and afterSave() methods!!

Arguments

$group_name

string

$group_description

string

Response

boolean

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

deleteAllByAttributes

deleteAllByAttributes(array $attributes, string $condition = '', array $params = array()) : integer
inherited
todo

This should also be moved to the behavior at some point. This method overrides the parent in order to raise PluginEvents for Bulk delete operations.

Filter Criteria are wrapped into a CDBCriteria instance so we have a single instance responsible for holding the filter criteria to be passed to the PluginEvent, this also enables us to pass the fully configured CDBCriteria instead of the original Parameters.

See {@link find()} for detailed explanation about $condition and $params.

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.

$condition

string

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

number of rows affected by the execution.

deleteGroup

deleteGroup(integer $ugId, integer $ownerId) : boolean

Arguments

$ugId

integer

$ownerId

integer

Response

boolean

Finds all active records satisfying the specified condition but returns them as array

findAllAsArray(\CDbCriteria $condition = '', array $params = array()) : array
inherited

See \find() for detailed explanation about $condition and $params.

Arguments

$condition

\CDbCriteria

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array

list of active records satisfying the specified condition. An empty array is returned if none is found.

getAllRecords

getAllRecords(mixed|boolean $condition = false) : mixed

Arguments

$condition

mixed|boolean

Response

mixed

TODO should be removed and replaced by yii's options

getButtons

getButtons() : string

Response

string

getColumns

getColumns() 

getCountUsers

getCountUsers() : integer

Response

integer

Return the max value for a field

getMaxId(string $field = null, boolean $forceRefresh = false) : false|integer
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Throws
\Exception

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|integer

Return the min value for a field

getMinId(string $field = null, boolean $forceRefresh = false) : false|integer
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Throws
\Exception

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|integer

Checks whether the specified UID is part of that group

hasUser(integer $uid) : boolean

Arguments

$uid

integer

Response

boolean

insertRecords

insertRecords( $data) 

Arguments

$data

join

join(array<mixed,string> $fields, string $from,  $condition = false,  $join = false,  $order = false) 

Arguments

$fields

array<mixed,string>

$from

string

$condition

$join

$order

model

model( $class = __CLASS__) : \UserGroup
static
inheritdoc

Arguments

$class

Response

\UserGroup

primaryKey

primaryKey() 
inheritdoc

Modified version that default to do the same as the original, but allows via a third parameter to retrieve the result as array instead of active records. This solves a joining problem. Usage via findAllAsArray method

query(\CDbCriteria $criteria, boolean $all = false, boolean $asAR = true) : mixed
inherited

Performs the actual DB query and populates the AR objects with the query result. This method is mainly internally used by other AR query methods.

since 1.1.7

Arguments

$criteria

\CDbCriteria

the query criteria

$all

boolean

whether to return all data

$asAR

boolean

Response

mixed

the AR objects populated with the query result

relations

relations() 
inheritdoc

requestEditGroup

requestEditGroup(integer $ugId, integer $ownerId) : static

Arguments

$ugId

integer

$ownerId

integer

Response

static

requestViewGroup

requestViewGroup(integer $ugId, integer $userId) : array

Arguments

$ugId

integer

$userId

integer

Response

array

This function search usergroups for a user If $isMine = true then usergroups are those that have been created by the current user else this function provides usergroups which contain the current user

searchMine(boolean $isMine) : \CActiveDataProvider

The object \CActiveDataProvider returned is used to generate the view in application/views/admin/usergroup/usergroups_view.php

Arguments

$isMine

boolean

Response

\CActiveDataProvider

tableName

tableName() 
inheritdoc

TODO should be in controller

updateGroup(string $name, string $description, integer $ugId) : boolean

Arguments

$name

string

$description

string

$ugId

integer

Response

boolean

Properties

member_count

member_count : integer
var

Type(s)

integer

ugid

ugid : integer

Model ID (primary key)

Type(s)

integer

name

name : string

Group name (max 20 chars)

Type(s)

string

description

description : string

Group description

Type(s)

string

owner_id

owner_id : integer

Group owner user ID

Type(s)

integer

users

users : array<mixed,\User>

Users of this group

Type(s)

array<mixed,\User>

owner

owner : \User

Group ownre user

Type(s)

\User

countUsers

countUsers : integer

Count of users in this group

Type(s)

integer