Class LoginForm

Form model for logging into the app.

CComponent

CModel implements IteratorAggregate, ArrayAccess

CFormModel

X2FormModel

LoginForm

Package: application\models
Propoerty: User $user The user model corresponding to the current login; null if no match for username/alias was found.
Located at x2engine/protected/models/LoginForm.php

Methods summary
`public array`	# `rules( )` Validation rules for logins. Validation rules for logins. Returns `array` Overrides `CModel::rules()`
`public array`	# `attributeLabels( )` Declares attribute labels. Declares attribute labels. Returns `array` Overrides `CModel::attributeLabels()`
`public`	# `authenticate( string $attribute, array $params )` Authenticates the password. Authenticates the password. This is the 'authenticate' validator as declared in rules(). Parameters `$attribute` `string` $attribute Attribute name `$params` `array` $params validation parameters
`public boolean`	# `login( boolean $google = false )` Logs in the user using the given username and password in the model. Logs in the user using the given username and password in the model. Parameters `$google` `boolean` $google Whether or not Google is being used for the login Returns `boolean` whether login is successful
`public UserIdentity`	# `getIdentity( )` User identity component. User identity component. Returns `UserIdentity`
`public User`	# `getUser( )` Returns the user model corresponding to the identity for the login Returns the user model corresponding to the identity for the login Returns `User`
`public type`	# `getSessionUserName( )` Resolves the correct username to use for login form security and sessions Resolves the correct username to use for login form security and sessions Returns `type`

Methods inherited from X2FormModel
`getAllErrorMessages(), validate()`

Methods inherited from CFormModel
`__construct(), attributeNames(), init()`

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

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

Properties summary
`public mixed`	`$username`	#
`public mixed`	`$password`	#
`public mixed`	`$rememberMe`	#
`public mixed`	`$verifyCode`	#
`public mixed`	`$useCaptcha`	#

Properties inherited from X2FormModel
`$exceptionClass, $throwExceptions`

Magic properties summary
`public UserIdentity`	`$identity`	# The user identity component for the current login. The user identity component for the current login.

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

Packages

Classes

Class LoginForm

Returns

Overrides

Returns

Overrides

Parameters

Parameters

Returns

Returns

Returns

Returns