Class myMVC_BaseLogoutAction

Description

Action-class to manage a login system.

User can derive this class to implement an own logout system. It can be used directly, too.

Located in /myMVC/BaseLogoutAction.php (line 29)

myMVC_BasePage
   |
   --myMVC_BaseAction
      |
      --myMVC_BaseLogoutAction
Method Summary
 static string getActionMenuName ()
 static int getActionMenuPosition ()
 static string getActionToken ()
 static boolean hasUserRightForAction ()
 static boolean isMenuAction ()
 void perform ()
Variables
Methods
static getActionMenuName (line 68)

Returns the string to be displayed in the menu to identify the current action.

Only necessary if isMenuAction() returns true

  • return: The menu item
  • access: public
string getActionMenuName ()

Redefinition of:
myMVC_BaseAction::getActionMenuName()
Returns the string to be displayed in the menu to identify the current action.
static getActionMenuPosition (line 57)

Returns the position of this action in the menu (created by controller) This action is always on bottom

  • return: The position in the menu (lower is "upper")
  • access: public
int getActionMenuPosition ()

Redefinition of:
myMVC_BaseAction::getActionMenuPosition()
Returns the position of this action in the menu (created by controller) Only necessary if isMenuAction() returns true
static getActionToken (line 36)

Returns the token used to identify the current Action

  • return: The token
  • access: public
string getActionToken ()

Redefinition of:
myMVC_BaseAction::getActionToken()
Returns the token used to identify the current Action
static hasUserRightForAction (line 78)

Returns whether the current user is allowed to call the current Action

  • return: true if the user may call this Action, false otherwise
  • access: public
boolean hasUserRightForAction ()

Redefinition of:
myMVC_BaseAction::hasUserRightForAction()
Returns whether the current user is allowed to call the current Action
static isMenuAction (line 46)

Returns whether this action should appear in the menu (created by controller)

  • return: true if the action should appear in menu
  • access: public
boolean isMenuAction ()

Redefinition of:
myMVC_BaseAction::isMenuAction()
Returns whether this action should appear in the menu (created by controller)
perform (line 90)

Log out the user and empty the session

  • access: public
void perform ()

Redefinition of:
myMVC_BaseAction::perform()
Perform the Action

Inherited Methods

Inherited From myMVC_BaseAction

 myMVC_BaseAction::__construct()
 myMVC_BaseAction::getActionMenuName()
 myMVC_BaseAction::getActionMenuPosition()
 myMVC_BaseAction::getActionToken()
 myMVC_BaseAction::getCSSClass()
 myMVC_BaseAction::getNumber()
 myMVC_BaseAction::getRenderEngine()
 myMVC_BaseAction::hasUserRightForAction()
 myMVC_BaseAction::isCalledFromMenu()
 myMVC_BaseAction::isComingFromView()
 myMVC_BaseAction::isMenuAction()
 myMVC_BaseAction::manageInvalidData()
 myMVC_BaseAction::perform()
 myMVC_BaseAction::saveRenderEngine()
 myMVC_BaseAction::setCheckFunction()
 myMVC_BaseAction::validate()
 myMVC_BaseAction::validateInput()

Inherited From myMVC_BasePage

 myMVC_BasePage::__construct()
 myMVC_BasePage::getFromPreviousSubmit()
 myMVC_BasePage::getInvalidFromPreviousSubmit()
 myMVC_BasePage::getLoggedUser()
 myMVC_BasePage::getParameterErrors()
 myMVC_BasePage::getParameterFromPreviousPage()
 myMVC_BasePage::isParameterFromPreviousSubmitValid()
 myMVC_BasePage::saveParameterForNextPage()

Documentation generated on Sat, 25 Apr 2015 21:21:53 +0200 by phpDocumentor 1.4.4