PiiForgotPassword
| Package | pii.core.user |
|---|---|
| Inheritance | class PiiForgotPassword » CFormModel » CModel » CComponent |
| Implements | IteratorAggregate, Traversable, ArrayAccess |
| Since | 2.0 |
| Version | $Id$ |
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| attributes | array | Returns all attribute values. | CModel |
| mixed | user's email address | PiiForgotPassword | |
| errors | array | Returns the errors for all attribute or a single attribute. | CModel |
| iterator | CMapIterator | Returns an iterator for traversing the attributes in the model. | CModel |
| name | mixed | the user name | PiiForgotPassword |
| safeAttributeNames | array | Returns the attribute names that are safe to be massively assigned. | CModel |
| scenario | string | Returns the scenario that this model is used in. | CModel |
| user | mixed | the PiiUser object matching these form values or null if not existant | PiiForgotPassword |
| validators | array | Returns the validators applicable to the current scenario. | CModel |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CFormModel |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| addError() | Adds a new error to the specified attribute. | CModel |
| addErrors() | Adds a list of errors. | CModel |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| attributeLabels() | Returns the attribute labels. | CModel |
| attributeNames() | Returns the list of attribute names. | CFormModel |
| beforeValidate() | Verifies that at least one field is not empty | PiiForgotPassword |
| behaviors() | Returns a list of behaviors that this model should behave as. | CModel |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| clearErrors() | Removes errors for all attributes or a single attribute. | CModel |
| createValidators() | Creates validator objects based on the specification in rules. | CModel |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| generateAttributeLabel() | Generates a user friendly attribute label. | CModel |
| getAttributeLabel() | Returns the text label for the specified attribute. | CModel |
| getAttributes() | Returns all attribute values. | CModel |
| getError() | Returns the first error of the specified attribute. | CModel |
| getErrors() | Returns the errors for all attribute or a single attribute. | CModel |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIterator() | Returns an iterator for traversing the attributes in the model. | CModel |
| getSafeAttributeNames() | Returns the attribute names that are safe to be massively assigned. | CModel |
| getScenario() | Returns the scenario that this model is used in. | CModel |
| getUser() | PiiForgotPassword | |
| getValidators() | Returns the validators applicable to the current scenario. | CModel |
| hasErrors() | Returns a value indicating whether there is any validation error. | CModel |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes this model. | CFormModel |
| isAttributeRequired() | Returns a value indicating whether the attribute is required. | CModel |
| isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | CModel |
| offsetExists() | Returns whether there is an element at the specified offset. | CModel |
| offsetGet() | Returns the element at the specified offset. | CModel |
| offsetSet() | Sets the element at the specified offset. | CModel |
| offsetUnset() | Unsets the element at the specified offset. | CModel |
| onAfterValidate() | This event is raised after the validation is performed. | CModel |
| onBeforeValidate() | This event is raised before the validation is performed. | CModel |
| raiseEvent() | Raises an event. | CComponent |
| rules() | PiiForgotPassword | |
| setAttributes() | Sets the attribute values in a massive way. | CModel |
| setScenario() | CModel | |
| validate() | Performs the validation. | CModel |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| afterValidate() | This method is invoked after validation ends. | CModel |
Events
| Event | Description | Defined By |
|---|---|---|
| onBeforeValidate | This event is raised before the validation is performed. | CModel |
| onAfterValidate | This event is raised after the validation is performed. | CModel |
Property Details
eMail
property
public mixed $eMail;
user's email address
name
property
public mixed $name;
the user name
user
property
read-only
public mixed getUser()
the PiiUser object matching these form values or null if not existant
Method Details
beforeValidate()
method
|
public void beforeValidate()
|
Verifies that at least one field is not empty
getUser()
method
|
public mixed getUser()
| ||
| {return} | mixed | the PiiUser object matching these form values or null if not existant |
rules()
method
|
public array rules()
| ||
| {return} | array | rules for this form |