This is the model class for table "{{settings_user}}".
The following are the available columns in table '{{settings_user}}':
| package | Default |
|---|
applyBaseSettings( $iUid)
attributeLabels(): array
arraycustomized attribute labels (name=>label)
behaviors(): array
Below is a list of all behaviors we register:
| see | \PluginEventBehavior\CTimestampBehavior |
|---|---|
array decrypt( $value = '')
decryptEncryptAttributes( $action = 'decrypt')
decryptSingle(string $value = ''): string
stringString value which needs to be decrypted
stringthe decrypted string
decryptSingleOld(string $value = ''): string
stringString value which needs to be decrypted
stringthe decrypted string
deleteAllByAttributes(array $attributes,string $condition = '',array $params = array()): integer
| 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. |
|---|
arraylist 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.
stringquery condition or criteria.
arrayparameters to be bound to an SQL statement.
integernumber of rows affected by the execution.
deleteUserSetting(string $stg_name,integer $uid = null,string $entity = null,integer $entity_id = null): boolean
string
integer| Can be omitted to just take the currently logged in users id
string| optional defaults to 'null'
integer| optional defaults to 'null'
booleanDeleting success/failure
dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = []): \PluginEvent
string
\CDbCriteria
array
\PluginEvent encrypt()
encryptAttributeValues(array $attributes = null, $bEncryptedOnly = false, $bReplaceValues = true): array
arraylist 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.
arrayattributes array with encrypted atrribute values is returned
encryptSave( $runValidation = false)
encryptSingle(string $value = '')
stringString value which needs to be encrypted
findAllAsArray(mixed $condition = '',array $params = array()): array
See \find() for detailed explanation about $condition and $params.
mixedquery condition or criteria.
arrayparameters to be bound to an SQL statement.
arraylist of active records satisfying the specified condition. An empty array is returned if none is found.
findAllByAttributes(array $attributes,mixed $condition = '',array $params = array()): array<mixed,static>
arraylist 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.
mixedquery condition or criteria.
arrayparameters to be bound to an SQL statement.
array<mixed,static>the records found. An empty array is returned if none is found.
findByAttributes(array $attributes,mixed $condition = '',array $params = array()): static|null
arraylist 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.
mixedquery condition or criteria.
arrayparameters to be bound to an SQL statement.
static|nullthe record found. Null if none is found.
getAllEncryptedAttributes(integer $iSurveyId,string $sClassName): array
integer
string
arrayTODO: Should be split into seperate functions in the appropiate model or helper class TODO: Make an interface for records that support encryption.
getMaxId(string $field = null,boolean $forceRefresh = false): false|integer
This is a convenience method, that uses the primary key of the model to retrieve the highest value.
| Throws |
|
|---|
stringThe field that contains the Id, when null primary key is used if it is a single field
booleanDon't use value from static cache but always requery the database
false|integer getMinId(string $field = null,boolean $forceRefresh = false): false|integer
This is a convenience method, that uses the primary key of the model to retrieve the highest value.
| Throws |
|
|---|
stringThe field that contains the Id, when null primary key is used if it is a single field
booleanDon't use value from static cache but always requery the database
false|integer getUserSetting(string $stg_name,integer $uid = null,string $entity = null,integer $entity_id = null): \SettingsUser
string
integer| Can be omitted to just take the currently logged in users id
string| optional defaults to 'null'
integer| optional defaults to 'null'
\SettingsUserThe current settings Object
getUserSettingValue(string $stg_name,integer|null $uid = null,integer|null $entity = null,integer|null $entity_id = null, $default = null): mixed|null
string
integer|null| Can be omitted to just take the currently logged in users id
integer|null| optional defaults to 'null'
integer|null| optional defaults to 'null'
mixed|nullThe current settings value or null id there is no setting
model(string $className = __CLASS__): \SettingsUser
Please note that you should have this exact method in all your CActiveRecord descendants!
stringactive record class name.
\SettingsUserthe static model class
query(\CDbCriteria $criteria,boolean $all = false,boolean $asAR = true): mixed
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 |
|---|
\CDbCriteriathe query criteria
booleanwhether to return all data
boolean
mixedthe AR objects populated with the query result
relations(): array
arrayrelational rules.
rules(): array
arrayvalidation rules for model attributes.
search(): \CActiveDataProvider
Typical usecase:
\CActiveDataProviderthe data provider that can return the models based on the search/filter conditions.
setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string
| Throws |
|
|---|
integer
string
string
string setUserSetting(string $stg_name,integer $stg_value,integer $uid = null,string $entity = null,integer $entity_id = null): boolean
string
integer
integer| Can be omitted to just take the currently logged in users id
string| optional defaults to 'null'
integer| optional defaults to 'null'
booleanSaving success/failure
tableName(): string
stringthe associated database table name
updateAll(array $attributes,mixed $condition = '',array $params = array()): integer
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.
arraylist of attributes (name=>$value) to be updated
mixedquery condition or criteria.
arrayparameters to be bound to an SQL statement.
integerthe number of rows being updated
ENTITY_SURVEY
ENTITY_SURVEYGROUP
ENTITY_THEME
ENTITY_EDITOR
ENTITY_PLUGIN
xssFilterAttributes :array<mixed,string>
| var | Array of attributes that should be XSS filtered on mass updates |
|---|
array<mixed,string> bEncryption :
uid :integer
User id
integer entity :string
Entity name
string entity_id :string
Entity ID
string stg_name :string
Setting name
string stg_value :string
Setting Value
string