LimeSurvey API - Master branch »\UserGroup

package	Default

addGroup

addGroup(string $group_name,string $group_description): integer

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

Arguments

$group_name

string

$group_description

string

Response

integer

Checks whether the specified UID is part of that group

addUser(integer $uid): boolean

Arguments

$uid

integer

Response

boolean

Lists the behaviors of this model

behaviors(): array

inherited

Below is a list of all behaviors we register:

see	\PluginEventBehavior\CTimestampBehavior

Response

array

Decrypt values from database

decrypt( $value = '')

inherited

Arguments

$value

Encrypt/decrypt values

decryptEncryptAttributes( $action = 'decrypt')

inherited

Arguments

$action

Decrypt single value

decryptSingle(string $value = ''): string

inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

Response

string

the decrypted string

Decrypt single value

decryptSingleOld(string $value = ''): string

inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

Response

string

the decrypted string

{@inheritdoc}

delete()

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.

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

deprecated	since 2018-04-21 use $this->delete and do the permissions check in controller!!

Arguments

$ugId

integer

$ownerId

integer

Response

boolean

dispatchPluginModelEvent

dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = []): \PluginEvent

inherited

Arguments

$sEventName

string

$criteria

\CDbCriteria

$eventParams

array

Response

\PluginEvent

Encrypt values

encrypt()

inherited

Attribute values are encrypted ( if needed )to be used for searching purposes

encryptAttributeValues(array $attributes = null, $bEncryptedOnly = false, $bReplaceValues = true): array

inherited

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.

$bEncryptedOnly

$bReplaceValues

Response

array

attributes array with encrypted atrribute values is returned

Encrypt values before saving to the database

encryptSave( $runValidation = false)

inherited

Arguments

$runValidation

Enrypt single value

encryptSingle(string $value = '')

inheritedstatic

Arguments

$value

string

String value which needs to be encrypted

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

findAllAsArray(mixed $condition = '',array $params = array()): array

inherited

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

Arguments

$condition

mixed

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.

Overriding of Yii's findAllByAttributes method to provide encrypted attribute value search

findAllByAttributes(array $attributes,mixed $condition = '',array $params = array()): array<mixed,static>

inherited

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

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array<mixed,static>

the records found. An empty array is returned if none is found.

Overriding of Yii's findByAttributes method to provide encrypted attribute value search

findByAttributes(array $attributes,mixed $condition = '',array $params = array()): static|null

inherited

Arguments

$attributes

array

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

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

static|null

the record found. Null if none is found.

getAllEncryptedAttributes

getAllEncryptedAttributes(integer $iSurveyId,string $sClassName): array

inherited

Arguments

$iSurveyId

integer

$sClassName

string

Response

array

TODO: Should be split into seperate functions in the appropiate model or helper class TODO: Make an interface for records that support encryption.

Returns the buttons for grid view

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): mixed

deprecated	at 2018-02-03 use $model->attributes = $data && $model->save()

Arguments

$data

Response

mixed

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( $className = __CLASS__): \UserGroup

static

inheritdoc

Arguments

$className

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

rules

rules()

inheritdoc

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

Sending emails to all users of a specific group.

sendUserEmails( $ugid, $subject, $body, $copy): string

Returns information about success/errors for sending emails to all single users

Throws	\PHPMailer\PHPMailer\Exception

Arguments

$ugid

integer

$subject

string subject of email

$body

string body of email

$copy

integer 1->send copy to user

Response

string

Function to show encryption symbol in gridview attribute header if value ois encrypted

setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string

inherited

Throws	\CException

Arguments

$surveyId

integer

$className

string

$attributeName

string

Response

string

tableName

tableName()

inheritdoc

Updates records with the specified condition.

updateAll(array $attributes,mixed $condition = '',array $params = array()): integer

inherited

XSS filtering is enforced for attributes listed in model's $xssFilterAttributes property. See \find() for detailed explanation about $condition and $params. Note, the attributes are not checked for safety and no validation is done.

Arguments

$attributes

array

list of attributes (name=>$value) to be updated

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

the number of rows being updated

TODO should be in controller

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

Arguments

$name

string

$description

string

$ugId

integer

Response

boolean

member_count

member_count :integer

var

Type(s)

integer

Array of attributes that should be XSS filtered on mass updates

xssFilterAttributes :array<mixed,string>

inherited

var	Array of attributes that should be XSS filtered on mass updates

Type(s)

array<mixed,string>

bEncryption

bEncryption :

inherited

Type(s)

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

UserGroup

Methods

addGroup

Arguments

$group_name

$group_description

Response

Checks whether the specified UID is part of that group

Arguments

$uid

Response

Lists the behaviors of this model

Response

Decrypt values from database

Arguments

$value

Encrypt/decrypt values

Arguments

$action

Decrypt single value

Arguments

$value

Response

Decrypt single value

Arguments

$value

Response

{@inheritdoc}

deleteAllByAttributes

Arguments

$attributes

$condition

$params

Response

deleteGroup

Arguments

$ugId

$ownerId

Response

dispatchPluginModelEvent

Arguments

$sEventName

$criteria

$eventParams

Response

Encrypt values

Attribute values are encrypted ( if needed )to be used for searching purposes

Arguments

$attributes

$bEncryptedOnly

$bReplaceValues

Response

Encrypt values before saving to the database

Arguments

$runValidation

Enrypt single value

Arguments

$value

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

Arguments

$condition

$params

Response

Overriding of Yii's findAllByAttributes method to provide encrypted attribute value search

Arguments

$attributes

$condition

$params

Response

Overriding of Yii's findByAttributes method to provide encrypted attribute value search

Arguments

$attributes

$condition

$params

Response

getAllEncryptedAttributes

Arguments

$iSurveyId

$sClassName

Response