User

Extends \LSActiveRecord

Class User

package

Default

Methods

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

Check if password is OK for current \User

checkPassword(string $sPassword) : boolean

Arguments

$sPassword

string

The clear password

Response

boolean

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.

Deletes onetime password

deleteOTPwd(string $username) 
access

public

Arguments

$username

string

Delete user

deleteUser(string $iUserID) : boolean

Arguments

$iUserID

string

The User ID to delete

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.

Finds user by username

findByUsername(string $sUserName) : \User
static

Arguments

$sUserName

string

Response

\User

Returns all users

getAllRecords(mixed|boolean $condition = false) : array<mixed,\CActiveRecord>
access

public

Arguments

$condition

mixed|boolean

Response

array<mixed,\CActiveRecord>

Gets the buttons for the GridView

getButtons() : string

Response

string

getColums

getColums() : array

Response

array

Returns User ID common in Survey_Permissions and User_in_groups

getCommonUID( $surveyid,  $postusergroupid) : \CDbDataReader

Arguments

$surveyid

$postusergroupid

Response

\CDbDataReader

getDateFormat

getDateFormat() : string

Response

string

getFormattedDateCreated

getFormattedDateCreated() 

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

Returns onetime password

getOTPwd(string $username) : string
access

public

Arguments

$username

string

Response

string

getParentUserName

getParentUserName() 

Return all super admins in the system

getSuperAdmins() : array<mixed,\User>

Response

array<mixed,\User>

getSurveysCreated

getSurveysCreated() : string

Response

string

Adds user record

insertRecords(array $data) : string
access

public

deprecated

: just don't use it

Arguments

$data

array

Response

string

Creates new user

insertUser(string $new_user, string $new_pass, string $new_full_name, string $parent_user, string $new_email) : integer|boolean
static
access

public

Arguments

$new_user

string

$new_pass

string

$new_full_name

string

$parent_user

string

$new_email

string

Response

integer|boolean

User ID if success

model

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

Arguments

$class

Response

\User

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

rules

rules() 
inheritdoc

Set user password with hash

setPassword(string $sPassword,  $save = false) : \User

Arguments

$sPassword

string

The clear text password

$save

Response

\User

tableName

tableName() 
inheritdoc

Updates user password hash

updatePassword(integer $iUserID, string $sPassword) : integer
static

Arguments

$iUserID

integer

The User ID

$sPassword

string

The clear text password

Response

integer

number of rows updated

Properties

Default value for user language

lang : string
var

Default value for user language

Type(s)

string

uid

uid : integer

User ID - primary key

Type(s)

integer

users_name

users_name : string

Users username

Type(s)

string

password

password : string

User's password hash

Type(s)

string

full_name

full_name : string

User's full name

Type(s)

string

parent_id

parent_id : integer

Type(s)

integer

lang

lang : string

User's preferred language: (auto: automatic | languagecodes eg 'en')

Type(s)

string

email

email : string

User's e-mail address

Type(s)

string

htmleditormode

htmleditormode : string

User's prefferred HTML editor mode:(default|inline|popup|none)

Type(s)

string

templateeditormode

templateeditormode : string

User's prefferred template editor mode:(default|full|none)

Type(s)

string

questionselectormode

questionselectormode : string

User's prefferred Question type selector:(default|full|none)

Type(s)

string

one_time_pw

one_time_pw : string

User's one-time-password hash

Type(s)

string

dateformat

dateformat : integer

Date format type 1-12

Type(s)

integer

created

created : string

Time created Time user was created as 'YYYY-MM-DD hh:mm:ss'

Type(s)

string

modified

modified : string

Time modified Time created Time user was modified as 'YYYY-MM-DD hh:mm:ss'

Type(s)

string

permissions

permissions : array<mixed,\Permission>

Type(s)

array<mixed,\Permission>

parentUser

parentUser : \User

Parent user

Type(s)

\User

parentUserName

parentUserName : string

Parent user's name

Type(s)

string