SettingsUser

Extends \LSActiveRecord

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

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

package

Default

Methods

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

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.

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

Gets a user setting depending on the given parameters

getUserSetting(string $stg_name, integer $uid = null, string $entity = null, integer $entity_id = null) : \SettingsUser
static

Arguments

$stg_name

string

$uid

integer

| Can be omitted to just take the currently logged in users id

$entity

string

| optional defaults to 'null'

$entity_id

integer

| optional defaults to 'null'

Response

\SettingsUser

The current settings Object

Gets a user settings value depending on the given parameters Shorthand function

getUserSettingValue(string $stg_name, integer|null $uid = null, integer|null $entity = null, integer|null $entity_id = null) : mixed|null
static

Arguments

$stg_name

string

$uid

integer|null

| Can be omitted to just take the currently logged in users id

$entity

integer|null

| optional defaults to 'null'

$entity_id

integer|null

| optional defaults to 'null'

Response

mixed|null

The current settings value or null id there is no setting

Returns the static model of the specified AR class.

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

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

Arguments

$className

string

active record class name.

Response

\SettingsUser

the static model class

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.

Changes or creates a user setting

setUserSetting(string $stg_name, integer $stg_value, integer $uid = null, string $entity = null, integer $entity_id = null) : boolean
static

Arguments

$stg_name

string

$stg_value

integer

$uid

integer

| Can be omitted to just take the currently logged in users id

$entity

string

| optional defaults to 'null'

$entity_id

integer

| optional defaults to 'null'

Response

boolean

Saving success/failure

tableName

tableName() : string

Response

string

the associated database table name

Properties

uid

uid : integer

User id

Type(s)

integer

entity

entity : string

Entity name

Type(s)

string

entity_id

entity_id : string

Entity ID

Type(s)

string

stg_name

stg_name : string

Setting name

Type(s)

string

stg_value

stg_value : string

Setting Value

Type(s)

string