SurveysGroups

Extends\LSActiveRecord Implements\PermissionInterface

This is the model class for table "{{surveys_groups}}".

The followings are the available columns in table '{{surveys_groups}}':

package

Default

Methods

afterFind

afterFind()
inheritdoc

Set public for default group (gsid == 1)

attributeLabels

attributeLabels(): array

Response

array

customized attribute labels (name=>label)

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 = '')
inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

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.

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 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

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.

getAllParents

getAllParents( $bOnlyGsid = false)

Arguments

$bOnlyGsid

getButtons

getButtons(): string

Response

string

getColumns

getColumns()

Returns true if survey group has child survey groups

getHasChildGroups(): boolean

Response

boolean

Returns true if survey group has surveys

getHasSurveys(): boolean

Response

boolean

Retrieve if current user have update rights on this SurveysGroups Used for buttons

getHasViewSurveyGroupRight(): boolean

Response

boolean

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

Get minimal permission name (for read value)

getMinimalPermissionRead(): null|string
inheritedstatic

Response

null|string

getNextOrderPosition

getNextOrderPosition()

Get the owner id of this record Used for Permission, to be extendable for each model with owner

getOwnerId(): integer|null
inherited

Response

integer|null

getParentGroupOptions

getParentGroupOptions( $gsid = null)

Arguments

$gsid

getParentTitle

getParentTitle()

get criteria from Permission

getPermissionCriteria(): \CDbCriteria
static

Response

\CDbCriteria

Get Permission data for Permission object

getPermissionData(): array
inheritedstatic

Response

array

Get the group list for current user

getSurveyGroupsList(): array
static

Response

array

Get the permission of current model

hasPermission(string $sPermission,string $sCRUD = 'read',integer $iUserID = null): boolean
inherited

Arguments

$sPermission

string

Name of the permission

$sCRUD

string

The permission detail you want to check on: 'create','read','update','delete','import' or 'export'

$iUserID

integer

User ID - if not given the one of the current user is used

Response

boolean

Returns the static model of the specified AR class.

model(string $className = __CLASS__): \SurveysGroups
static

Please note that you should have this exact method in all your CActiveRecord descendants!

Arguments

$className

string

active record class name.

Response

\SurveysGroups

the static model class

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

Response

array

relational rules.

rules

rules(): array

Response

array

validation rules for model attributes.

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

Response

string

the associated database table name

Properties

alwaysavailable

alwaysavailable :

Type(s)

bEncryption

bEncryption :
inherited

Type(s)

gsid

gsid :integer

Type(s)

integer

name

name :string

Type(s)

string

title

title :string

Type(s)

string

description

description :string

Type(s)

string

sortorder

sortorder :integer

Type(s)

integer

owner_id

owner_id :integer

Type(s)

integer

parent_id

parent_id :integer

Type(s)

integer

alwaysavailable

alwaysavailable :boolean|integer

Type(s)

boolean|integer

created

created :string

Type(s)

string

modified

modified :string

Type(s)

string

created_by

created_by :integer

Type(s)

integer

parentgroup

parentgroup :object

Type(s)

object

hasSurveys

hasSurveys :boolean

Type(s)

boolean