PiiUserController
Package | pii.core.user |
---|---|
Inheritance | class PiiUserController » CController » CBaseController » CComponent |
Since | 2.0 |
Version | $Id$ |
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
action | CAction | the action currently being executed, null if no active action. | CController |
cachingStack | CStack | stack of COutputCache objects | CController |
clips | CMap | Returns the list of clips. | CController |
defaultAction | string | specifies the default action to be 'list'. | PiiUserController |
id | string | ID of the controller | CController |
layout | mixed | the name of the layout to be applied to this controller's views. | CController |
module | CWebModule | the module that this controller belongs to. | CController |
pageTitle | string | the page title. | CController |
uniqueId | string | the controller ID that is prefixed with the module ID (if any). | CController |
viewPath | string | Returns the directory containing view files for this controller. | CController |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | CComponent |
__construct() | CController | |
__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 |
accessRules() | Specifies the access control rules. | PiiUserController |
actionAdmin() | Manages all models. | PiiUserController |
actionCreate() | Creates a new model. | PiiUserController |
actionDelete() | Deletes a particular model. | PiiUserController |
actionForgotpassword() | Display "forgot password" form and send email | PiiUserController |
actionList() | Lists all models. | PiiUserController |
actionRegister() | Show/process registration form | PiiUserController |
actionResetPassword() | Display "reset password" form and update user | PiiUserController |
actionShow() | Shows a particular model. | PiiUserController |
actionUpdate() | Updates a particular model. | PiiUserController |
actionUserupdate() | Show/process form for email/password update | PiiUserController |
actionVerify() | Verifies a user. | PiiUserController |
actionVerifyemail() | Handle email verification | PiiUserController |
actions() | Returns a list of external action classes. | CController |
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 |
beginCache() | Begins fragment caching. | CBaseController |
beginClip() | Begins recording a clip. | CBaseController |
beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController |
beginWidget() | Creates a widget and executes it. | CBaseController |
behaviors() | Returns a list of behaviors that this controller should behave as. | CController |
canGetProperty() | Determines whether a property can be read. | CComponent |
canSetProperty() | Determines whether a property can be set. | CComponent |
clearPageStates() | Removes all page states. | CController |
createAbsoluteUrl() | Creates an absolute URL for the specified action defined in this controller. | CController |
createAction() | Creates the action instance based on the action name. | CController |
createUrl() | Creates a relative URL for the specified action defined in this controller. | CController |
createWidget() | Creates a widget and initializes it. | CBaseController |
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 |
endCache() | Ends fragment caching. | CBaseController |
endClip() | Ends recording a clip. | CBaseController |
endContent() | Ends the rendering of content. | CBaseController |
endWidget() | Ends the execution of the named widget. | CBaseController |
filterAccessControl() | The filter method for 'accessControl' filter. | CController |
filterAjaxOnly() | The filter method for 'ajaxOnly' filter. | CController |
filterPostOnly() | The filter method for 'postOnly' filter. | CController |
filters() | PiiUserController | |
getAction() | CController | |
getCachingStack() | CController | |
getClips() | Returns the list of clips. | CController |
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
getId() | CController | |
getLayoutFile() | Looks for the view script file for a layout. | CController |
getModule() | CController | |
getPageState() | Returns a persistent page state value. | CController |
getPageTitle() | CController | |
getUniqueId() | CController | |
getViewFile() | Looks for the view file according to the given view name. | CController |
getViewPath() | Returns the directory containing view files for this controller. | CController |
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 the controller. | CController |
isCachingStackEmpty() | CController | |
loadPiiUser() | Returns the data model based on the primary key given in the GET variable. | PiiUserController |
missingAction() | Handles the request whose action is not recognized. | CController |
paginate() | Generates pagination information. | CController |
processDynamicOutput() | Postprocesses the dynamic output. | CController |
processOutput() | Postprocesses the output generated by render(). | CController |
raiseEvent() | Raises an event. | CComponent |
recordCachingAction() | Records a method call when an output cache is in effect. | CController |
redirect() | Redirects the browser to the specified URL or route (controller/action). | CController |
refresh() | Refreshes the current page. | CController |
render() | Renders a view with a layout. | CController |
renderDynamic() | Renders dynamic content returned by the specified callback. | CController |
renderDynamicInternal() | This method is internally used. | CController |
renderFile() | Renders a view file. | CBaseController |
renderInternal() | Renders a view file. | CBaseController |
renderPartial() | Renders a view. | CController |
renderText() | Renders a static text string. | CController |
resolveViewFile() | Finds a view file based on its name. | CController |
run() | Runs the named action. | CController |
runAction() | Runs the action after passing through all filters. | CController |
runActionWithFilters() | Runs an action with the specified filters. | CController |
setAction() | CController | |
setPageState() | Saves a persistent page state value. | CController |
setPageTitle() | CController | |
widget() | Creates a widget and executes it. | CBaseController |
Protected Methods
Method | Description | Defined By |
---|---|---|
afterAction() | This method is invoked right after an action is executed. | CController |
beforeAction() | This method is invoked right before an action is to be executed (after all possible filters.) | CController |
createActionFromMap() | Creates the action instance based on the action map. | CController |
loadPageStates() | Loads page states from a hidden input. | CController |
processActivationCommand() | Executes activation | PiiUserController |
processAdminCommand() | Executes any command triggered on the admin page. | PiiUserController |
replaceDynamicOutput() | Replaces the dynamic content placeholders with actual content. | CController |
savePageStates() | Saves page states as a base64 string. | CController |
Property Details
specifies the default action to be 'list'.
Method Details
public array accessRules()
| ||
{return} | array | access control rules |
Specifies the access control rules. This method is used by the 'accessControl' filter.
public void actionAdmin()
|
Manages all models.
public void actionCreate()
|
Creates a new model. If creation is successful, the browser will be redirected to the 'show' page.
public void actionDelete()
|
Deletes a particular model. If deletion is successful, the browser will be redirected to the 'list' page.
public void actionForgotpassword()
| ||
{return} | void |
Display "forgot password" form and send email
public void actionList()
|
Lists all models.
public void actionRegister()
|
Show/process registration form
public void actionResetPassword()
| ||
{return} | void |
Display "reset password" form and update user
public void actionShow()
|
Shows a particular model.
public void actionUpdate()
|
Updates a particular model. If update is successful, the browser will be redirected to the 'show' page.
public void actionUserupdate()
|
Show/process form for email/password update
public void actionVerify()
| ||
{return} | void |
Verifies a user.
public void actionVerifyemail()
|
Handle email verification
public array filters()
| ||
{return} | array | action filters |
public void loadPiiUser(integer $id=NULL)
| ||
$id | integer | the primary key value. Defaults to null, meaning using the 'id' GET variable |
Returns the data model based on the primary key given in the GET variable. If the data model is not found, an HTTP exception will be raised.
protected void processActivationCommand()
|
Executes activation
protected void processAdminCommand()
|
Executes any command triggered on the admin page.