Abstracted user model for TFA admin view.
Incorporating an alternative seach method.
| inheritDoc | |
|---|---|
| package | Default |
attributeLabels()
behaviors(): array
Below is a list of all behaviors we register:
| see | \PluginEventBehavior\CTimestampBehavior |
|---|---|
array canEdit(integer $loginId): boolean
integer
boolean checkPassword(string $sPassword): boolean
stringThe clear password
boolean checkPasswordStrength( $password)
| todo | document me |
|---|---|
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.
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.
findByUsername(string $sUserName): \User
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.
getAuthTypeDescription(): string
string getButtons(): string
stringTODO: this seems to not be used anymore - see getManagementButtons()
getColumns(): array
| inheritDoc | |
|---|---|
array getColums(): array
array getCommonUID( $surveyid, $postusergroupid): \CDbDataReader
\CDbDataReader getDateFormat(): string
string getDisplayName(): \$string
\$string getFormattedDateCreated()
| todo | Not used? |
|---|---|
getGroupList()
| todo | document me |
|---|---|
getHasAuthSet(): boolean
boolean getLastloginFormatted(): string
string getManagementButtons(): string
string getManagementCheckbox()
getManagementColums(): array
array 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 getParentUserName()
getPasswordHelpText()
| todo | document me |
|---|---|
getRoleList()
getSuperAdmins(): array<mixed,\User>
getSurveysCreated(): string
string insertRecords(array $data): string
| access | public |
|---|---|
| deprecated | : just don't use it |
array
string insertUser(string $new_user,string $new_pass,string $new_full_name,integer $parent_user,string $new_email,string|null $expires = null): integer|boolean
| access | public |
|---|
string
string
string
integer
string
string|null
integer|booleanUser ID if success
isExpired(): boolean
boolean model( $className = __CLASS__): \User
primaryKey()
| inheritdoc | |
|---|---|
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()
| inheritdoc | |
|---|---|
rules()
| inheritdoc | |
|---|---|
search()
| inheritdoc | |
|---|---|
setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string
| Throws |
|
|---|
integer
string
string
string setPassword(string $sPassword, $save = false): \User
setValidationExpiration(): boolean
| Throws |
|
|---|
booleantrue if datetime could be saved, false otherwise
setValidationKey(): boolean
booleantrue if validation_key could be saved in db, false otherwise
tableName()
| inheritdoc | |
|---|---|
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
updatePassword(integer $iUserID,string $sPassword): integer
integerThe User ID
stringThe clear text password
integernumber of rows updated
validateNewPassword( $newPassword, $oldPassword, $repeatPassword): string
stringempty string means everything is ok, otherwise error message is returned
MAX_EXPIRATION_TIME_IN_HOURS
| var | maximum time the validation_key is valid |
|---|
MAX_EXPIRATION_TIME_IN_DAYS
| var | maximum days the validation key is valid |
|---|
MAX_VALIDATION_KEY_LENGTH
| var | maximum length for the validation_key |
|---|
lang :string
| var | Default value for user language |
|---|
string searched_value :
xssFilterAttributes :array<mixed,string>
| var | Array of attributes that should be XSS filtered on mass updates |
|---|
array<mixed,string> bEncryption :
uid :integer
User ID - primary key
integer users_name :string
Users username
string password :string
User's password hash
string full_name :string
User's full name
string parent_id :integer
integer lang :string
User's preferred language: (auto: automatic | languagecodes eg 'en')
string email :string
User's e-mail address
string htmleditormode :string
User's prefferred HTML editor mode:(default|inline|popup|none)
string templateeditormode :string
User's prefferred template editor mode:(default|full|none)
string questionselectormode :string
User's prefferred Question type selector:(default|full|none)
string one_time_pw :string
User's one-time-password hash
string dateformat :integer
Date format type 1-12
integer created :string
Time created Time user was created as 'YYYY-MM-DD hh:mm:ss'
string modified :string
Time modified Time created Time user was modified as 'YYYY-MM-DD hh:mm:ss'
string validation_key :string
used for email link to reset or create a password for a survey participant Link is send when user is created or password has been reset
string validation_key_expiration :string
datetime when the validation key expires
string last_forgot_email_password :string
datetime when user send email for forgot pw the last time (prevent bot)
string parentUser :\User
Parent user
\User parentUserName :string
Parent user's name
string last_login :string
string roles :array<mixed,\Permissiontemplates>
array<mixed,\Permissiontemplates> groups :array<mixed,\UserGroup>
array<mixed,\UserGroup>