Class PasswordReset

Password recovery active record model.

CComponent

Extended by

CModel implements IteratorAggregate, ArrayAccess

Extended by

CActiveRecord

Extended by

PasswordReset

Package: application\modules\users\models
Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/modules/users/models/PasswordReset.php

Methods summary
`public string`	# `tableName( )` Returns the name of the associated database table. By default this method returns the class name as the table name. You may override this method if the table is not named after this convention. Returns the name of the associated database table. By default this method returns the class name as the table name. You may override this method if the table is not named after this convention. Returns `string` the table name Overrides `CActiveRecord::tableName()`
`public static static`	# `model( string $className = __CLASS__ )` Returns the static model of the specified AR class. The model returned is a static instance of the AR class. It is provided for invoking class-level methods (something similar to static class methods.) Returns the static model of the specified AR class. The model returned is a static instance of the AR class. It is provided for invoking class-level methods (something similar to static class methods.) EVERY derived AR class must override this method as follows, public static function model($className=__CLASS__) { return parent::model($className); } Parameters `$className` `string` $className active record class name. Returns `static` active record model instance. Overrides `CActiveRecord::model()`
`public array`	# `relations( )` This method should be overridden to declare related objects. This method should be overridden to declare related objects. There are four types of relations that may exist between two active record objects: BELONGS_TO: e.g. a member belongs to a team; HAS_ONE: e.g. a member has at most one profile; HAS_MANY: e.g. a team has many members; MANY_MANY: e.g. a member has many skills and a skill belongs to a member. Besides the above relation types, a special relation called STAT is also supported that can be used to perform statistical query (or aggregational query). It retrieves the aggregational information about the related objects, such as the number of comments for each post, the average rating for each product, etc. Each kind of related objects is defined in this method as an array with the following elements: 'varName'=>array('relationType', 'className', 'foreignKey', ...additional options) where 'varName' refers to the name of the variable/property that the related object(s) can be accessed through; 'relationType' refers to the type of the relation, which can be one of the following four constants: self::BELONGS_TO, self::HAS_ONE, self::HAS_MANY and self::MANY_MANY; 'className' refers to the name of the active record class that the related object(s) is of; and 'foreignKey' states the foreign key that relates the two kinds of active record. Note, for composite foreign keys, they can be either listed together, separated by commas or specified as an array in format of array('key1','key2'). In case you need to specify custom PK->FK association you can define it as array('fk'=>'pk'). For composite keys it will be array('fk_c1'=>'pk_с1','fk_c2'=>'pk_c2'). For foreign keys used in MANY_MANY relation, the joining table must be declared as well (e.g. 'join_table(fk1, fk2)'). Additional options may be specified as name-value pairs in the rest array elements: 'select': string\|array, a list of columns to be selected. Defaults to '*', meaning all columns. Column names should be disambiguated if they appear in an expression (e.g. COUNT(relationName.name) AS name_count). 'condition': string, the WHERE clause. Defaults to empty. Note, column references need to be disambiguated with prefix 'relationName.' (e.g. relationName.age>20) 'order': string, the ORDER BY clause. Defaults to empty. Note, column references need to be disambiguated with prefix 'relationName.' (e.g. relationName.age DESC) 'with': string\|array, a list of child related objects that should be loaded together with this object. Note, this is only honored by lazy loading, not eager loading. 'joinType': type of join. Defaults to 'LEFT OUTER JOIN'. 'alias': the alias for the table associated with this relationship. It defaults to null, meaning the table alias is the same as the relation name. 'params': the parameters to be bound to the generated SQL statement. This should be given as an array of name-value pairs. 'on': the ON clause. The condition specified here will be appended to the joining condition using the AND operator. 'index': the name of the column whose values should be used as keys of the array that stores related objects. This option is only available to HAS_MANY and MANY_MANY relations. 'scopes': scopes to apply. In case of a single scope can be used like 'scopes'=>'scopeName', in case of multiple scopes can be used like 'scopes'=>array('scopeName1','scopeName2'). This option has been available since version 1.1.9. The following options are available for certain relations when lazy loading: 'group': string, the GROUP BY clause. Defaults to empty. Note, column references need to be disambiguated with prefix 'relationName.' (e.g. relationName.age). This option only applies to HAS_MANY and MANY_MANY relations. 'having': string, the HAVING clause. Defaults to empty. Note, column references need to be disambiguated with prefix 'relationName.' (e.g. relationName.age). This option only applies to HAS_MANY and MANY_MANY relations. 'limit': limit of the rows to be selected. This option does not apply to BELONGS_TO relation. 'offset': offset of the rows to be selected. This option does not apply to BELONGS_TO relation. 'through': name of the model's relation that will be used as a bridge when getting related data. Can be set only for HAS_ONE and HAS_MANY. This option has been available since version 1.1.7. Below is an example declaring related objects for 'Post' active record class: return array( 'author'=>array(self::BELONGS_TO, 'User', 'author_id'), 'comments'=>array(self::HAS_MANY, 'Comment', 'post_id', 'with'=>'author', 'order'=>'create_time DESC'), 'tags'=>array(self::MANY_MANY, 'Tag', 'post_tag(post_id, tag_id)', 'order'=>'name'), ); Returns `array` list of related object declarations. Defaults to empty array. Overrides `CActiveRecord::relations()`
`public`	# `getIpAddr( )`
`public`	# `getIsExpired( )`
`public type`	# `getLimitReached( )` Returns whether the maximum number of requests for the current IP address has already been reached. Returns whether the maximum number of requests for the current IP address has already been reached. Returns `type`
`public boolean`	# `beforeSave( )` Creates a password reset request. Creates a password reset request. Assigns a secure/unique ID to the request. Returns `boolean` whether the saving should be executed. Defaults to true. Overrides `CActiveRecord::beforeSave()`
`public boolean`	# `insert( array $attributes = null )` Inserts a row into the table based on this active record attributes. If the table's primary key is auto-incremental and is null before insertion, it will be populated with the actual value after insertion. Note, validation is not performed in this method. You may call `CModel::validate()` to perform the validation. After the record is inserted to DB successfully, its isNewRecord property will be set false, and its scenario property will be set to be 'update'. Inserts a row into the table based on this active record attributes. If the table's primary key is auto-incremental and is null before insertion, it will be populated with the actual value after insertion. Note, validation is not performed in this method. You may call `CModel::validate()` to perform the validation. After the record is inserted to DB successfully, its isNewRecord property will be set false, and its scenario property will be set to be 'update'. Parameters `$attributes` `array` $attributes list of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved. Returns `boolean` whether the attributes are valid and the record is inserted successfully. Throws `CDbException` if the record is not new Overrides `CActiveRecord::insert()`
`public array`	# `rules( )` Returns the validation rules for attributes. Returns the validation rules for attributes. This method should be overridden to declare validation rules. Each rule is an array with the following structure: array('attribute list', 'validator name', 'on'=>'scenario name', ...validation parameters...) where attribute list: specifies the attributes (separated by commas) to be validated; validator name: specifies the validator to be used. It can be the name of a model class method, the name of a built-in validator, or a validator class (or its path alias). A validation method must have the following signature: // $params refers to validation parameters given in the rule function validatorName($attribute,$params) A built-in validator refers to one of the validators declared in CValidator::builtInValidators. And a validator class is a class extending CValidator. on: this specifies the scenarios when the validation rule should be performed. Separate different scenarios with commas. If this option is not set, the rule will be applied in any scenario that is not listed in "except". Please see scenario for more details about this option. except: this specifies the scenarios when the validation rule should not be performed. Separate different scenarios with commas. Please see scenario for more details about this option. additional parameters are used to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties. The following are some examples: array( array('username', 'required'), array('username', 'length', 'min'=>3, 'max'=>12), array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'), array('password', 'authenticate', 'on'=>'login'), ); Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions like array_merge(). Returns `array` validation rules to be applied when `CModel::validate()` is called. See scenario Overrides `CModel::rules()`
`public`	# `validUserId( type $attribute, type $params = array() )` Validator for checking if a user was found Validator for checking if a user was found Parameters `$attribute` `type` $attribute `$params` `type` $params
`public type`	# `resolveUser( )` Finds the user either by user or profile record (this is a sort of kludge y safeguard that can be removed when those tables are merged) Finds the user either by user or profile record (this is a sort of kludge y safeguard that can be removed when those tables are merged) Returns `type`

Methods inherited from CActiveRecord
__call(), __construct(), __get(), __isset(), __set(), __sleep(), __unset(), addRelatedRecord(), afterDelete(), afterFind(), afterFindInternal(), afterSave(), applyScopes(), attributeNames(), beforeCount(), beforeDelete(), beforeFind(), beforeFindInternal(), cache(), count(), countByAttributes(), countBySql(), defaultScope(), delete(), deleteAll(), deleteAllByAttributes(), deleteByPk(), equals(), exists(), find(), findAll(), findAllByAttributes(), findAllByPk(), findAllBySql(), findByAttributes(), findByPk(), findBySql(), getActiveFinder(), getActiveRelation(), getAttribute(), getAttributeLabel(), getAttributes(), getCommandBuilder(), getDbConnection(), getDbCriteria(), getIsNewRecord(), getMetaData(), getOldPrimaryKey(), getPrimaryKey(), getRelated(), getTableAlias(), getTableSchema(), hasAttribute(), hasRelated(), init(), instantiate(), offsetExists(), onAfterDelete(), onAfterFind(), onAfterSave(), onBeforeCount(), onBeforeDelete(), onBeforeFind(), onBeforeSave(), populateRecord(), populateRecords(), primaryKey(), query(), refresh(), refreshMetaData(), resetScope(), save(), saveAttributes(), saveCounters(), scopes(), setAttribute(), setDbCriteria(), setIsNewRecord(), setOldPrimaryKey(), setPrimaryKey(), setTableAlias(), together(), update(), updateAll(), updateByPk(), updateCounters(), with()

Methods inherited from CModel
addError(), addErrors(), afterConstruct(), afterValidate(), attributeLabels(), beforeValidate(), behaviors(), clearErrors(), createValidators(), generateAttributeLabel(), getError(), getErrors(), getIterator(), getSafeAttributeNames(), getScenario(), getValidatorList(), getValidators(), hasErrors(), isAttributeRequired(), isAttributeSafe(), offsetGet(), offsetSet(), offsetUnset(), onAfterConstruct(), onAfterValidate(), onBeforeValidate(), onUnsafeAttribute(), setAttributes(), setScenario(), unsetAttributes(), validate()

Methods inherited from CComponent
`asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants summary
`integer`	`EXPIRE_S`	`3600`	# Password reset requests expire in one hour: Password reset requests expire in one hour:
`integer`	`MAX_REQUESTS`	`5`	#

Constants inherited from CActiveRecord
`BELONGS_TO, HAS_MANY, HAS_ONE, MANY_MANY, STAT`

Properties inherited from CActiveRecord
`$db`

Magic properties summary
`public boolean`	`$limitReached`	# Whether or not the requests per hour limit was reached Whether or not the requests per hour limit was reached

Magic properties inherited from CActiveRecord
`$attributes, $commandBuilder, $dbConnection, $dbCriteria, $isNewRecord, $metaData, $oldPrimaryKey, $primaryKey, $tableAlias, $tableSchema`

Magic properties inherited from CModel
`$errors, $iterator, $safeAttributeNames, $scenario, $validatorList, $validators`