PHP Class SiteController

Date: 29.12.2015 Time: 22:14
Inheritance: extends Controller
Show file Open project: charlesportwoodii/ciims Class Usage Examples

Public Methods

Method Description
accessRules ( ) Setup access controls to prevent guests from changing their emaila ddress
actionAcceptInvite ( string $id = NULL ) Enables users who have recieved an invitation to setup a new account
actionActivation ( mixed $id = NULL ) Activates a new user's account
actionEmailChange ( string $key = null ) Allows the user to securely change their email address
actionError ( $code = NULL ) This is the action to handle external exceptions.
actionForgot ( ) Handles resetting a users password should they forgot it
actionLogin ( ) Provides functionality to log a user into the system
actionLogout ( ) Provides functionality to log a user out
actionRegister ( ) Handles the registration of new users on the site
actionResetPassword ( string $id = NULL ) Alows a user to reset their password if they initiated a forgot password request
actionSearch ( integer $id = 1 ) Provides basic searching functionality
actionSitemap ( ) Provides basic sitemap functionality via XML
beforeAction ( $action ) beforeAction method, performs operations before an action is presented
filters ( )

Private Methods

Method Description
_getNext ( ) : mixed Returns a sanitized $_GET['next'] URL if it is set.

Method Details

accessRules() public method

Setup access controls to prevent guests from changing their emaila ddress
public accessRules ( )

actionAcceptInvite() public method

Enables users who have recieved an invitation to setup a new account
public actionAcceptInvite ( string $id = NULL )
$id string The activation id the of the user that we want to activate

actionActivation() public method

Activates a new user's account
public actionActivation ( mixed $id = NULL )
$id mixed The activation key

actionEmailChange() public method

Allows the user to securely change their email address
public actionEmailChange ( string $key = null )
$key string the user's secure key

actionError() public method

This is the action to handle external exceptions.
public actionError ( $code = NULL )

actionForgot() public method

Handles resetting a users password should they forgot it
public actionForgot ( )

actionLogin() public method

Provides functionality to log a user into the system
public actionLogin ( )

actionLogout() public method

Provides functionality to log a user out
public actionLogout ( )

actionRegister() public method

Handles the registration of new users on the site
public actionRegister ( )

actionResetPassword() public method

Alows a user to reset their password if they initiated a forgot password request
public actionResetPassword ( string $id = NULL )
$id string

actionSearch() public method

Provides basic searching functionality
public actionSearch ( integer $id = 1 )
$id integer The search pagination id

actionSitemap() public method

Provides basic sitemap functionality via XML
public actionSitemap ( )

beforeAction() public method

beforeAction method, performs operations before an action is presented
See also: http://www.yiiframework.com/doc/api/1.1/CController#beforeAction-detail
public beforeAction ( $action )

filters() public method

public filters ( )