Base class for all actions.

You must derive your action's classes from this class.

In the constructor you must define one or more function to validate the input.
Use the method setCheckFunction() to do that.

Example to validate input:
Every field (with the name of the form!!) must have an associative array with
the check type and his parameters.

$definitions is an associative array with the description of the checks.
$names is an associative array with the name of the fields, used for the error message.
$errorMsgs is an associative array with the possible errors. For every check of the field, it should contain a description of the error. {field} is a placeholder for the name of the field (see $names). {checkValue} is a placeholder for the given value for the check (for example: 'min' => 2).
If $errorMsg does not contain a message for the current error, it will just return '{field} is not valid' (parsed with GetText)

$definition has to be created as follow:

In myMVC_BaseAction there are many $VALIDATE_xxx defines to validate the different input fields.
Every validate-check can have more parameters.
In the following example-code you can find the validate-checks with their parameters explained.
You can give more than one parameter for every check.

Valid parameters for all checks (but $VALIDATE_EXTERN and $VALIDATE_UPLOAD) are:

empty true or false. It decides wheter an empty field should be accepted.
range array of valid values for the checked field.
rangei same as range, but case insensitive (just for $VALIDATE_STRING, $VALIDATE_EMAIL and $VALIDATE_WEB).
rangesql SQL-query to get the valid values for the checked field.
rangesqli same as rangesql, but case insensitive (just for $VALIDATE_STRING, $VALIDATE_EMAIL and $VALIDATE_WEB).
comparedb Execute an SQL-query and compare the result with the given value.
In the query you can use {checkValue} as placeholder for the user's given input value. See example to use it.
WARNING: the query must return just one record with one column, otherwise it throws an exception.
comparefield like comparedb, but it compares two input fields. Useful for action like "password change", when the user has to give the password twice.

$VALIDATE_NUMBER has 'min' and 'max', too, to restrict the valid numbers into a range.
$VALIDATE_DATETIME has 'format' to give the format of the date (see strftime). This parameter is mandatory!
$VALIDATE_STRING has the parameters 'minlen' and 'maxlen' to restrict the length of the input string, and the parameter 'regexp' to check the string against a given regular expression.
$VALIDATE_EXTERN has just the parameter 'checkFunction'. See the example. $VALIDATE_UPLOAD has the parameters 'minlen' (in KB), 'maxlen' (in KB), 'empty' and 'allowed_types'. See the example. PLEASE REMENBER TO SET 'upload_max_filesize' in your php.ini!!

If a required parameter wasn't given, the Framework generates an Exception.

this function must return true if data are valid, and false otherwise. In this case, $errMsg can contain an error message, that will be parsed with $errorMsgs (placeholder: {externError}).

If you want to call the Action as AJAX, you can (but not must) define the methods performAjax() and manageInvalidDataAjax() with same parameters of perform() and manageInvalidData(). To validate the data, you should pass "AJAX" as first parameter to setCheckFunction(). So you can have an Action that supports normal calls (GET and/or POST) and AJAX

• abstract:

Located in /myMVC/BaseAction.php (line 194)

myMVC_BasePage
   |
   --myMVC_BaseAction

static getActionMenuName (line 394)

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 ()

---

Redefined in descendants as:

• myMVC_BaseLogoutAction::getActionMenuName() : Returns the string to be displayed in the menu to identify the current action.

static getActionMenuPosition (line 405)

Returns the position of this action in the menu (created by controller) Only necessary if isMenuAction() returns true

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

int getActionMenuPosition ()

---

Redefined in descendants as:

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

static getActionToken (line 386)

Returns the token used to identify the current Action

• return: The token
• abstract:
• access: public

string getActionToken ()

---

Redefined in descendants as:

• myMVC_BaseLogoutAction::getActionToken() : Returns the token used to identify the current Action
• myMVC_BaseLoginAction::getActionToken() : Returns the token used to identify the current Action

static getCSSClass (line 422)

Returns the CSS class of this action

• return: The CSS class
• access: public

string getCSSClass ()

static hasUserRightForAction (line 415)

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

• return: true if the user may call this Action, false otherwise
• abstract:
• access: public

boolean hasUserRightForAction ()

---

Redefined in descendants as:

• myMVC_BaseLogoutAction::hasUserRightForAction() : Returns whether the current user is allowed to call the current Action
• myMVC_BaseLoginAction::hasUserRightForAction() : Returns whether the current user is allowed to call the current Action

static isMenuAction (line 432)

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 ()

---

Redefined in descendants as:

• myMVC_BaseLogoutAction::isMenuAction() : Returns whether this action should appear in the menu (created by controller)

Constructor __construct (line 313)

Constructor

• access: public

myMVC_BaseAction __construct (myMVC_HttpRequest $request, myMVC_HttpSession $session)

• myMVC_HttpRequest $request: The current request
• myMVC_HttpSession $session: The current session

---

Redefinition of:

myMVC_BasePage::__construct()

Constructor.

getNumber (line 1114)

Convert a number to the internal PHP-Format, using current user's locale

• return: The converted number
• access: protected

number getNumber (string $value)

• string $value: The number to be converted

getRenderEngine (line 337)

Return the current used render engine.

• return: The render engine
• access: protected

Class getRenderEngine ()

isCalledFromMenu (line 454)

Returns if the current action was called from menu or from a view

• return: true if the action was called from a menu, false if it was called from a view
• access: protected

boolean isCalledFromMenu ()

isComingFromView (line 443)

Returns whether this action was called from the given view

• return: true if the action was called from the given view, false otherwise
• access: protected

boolean isComingFromView ( $view, class $views)

• class $views: The view
• $view

manageInvalidData (line 521)

Called if user data are not valid (check with validate)

• return: Response code for the next Action or View (typically the same view, with error messages)
• access: public

myMVC_HttpResponse manageInvalidData ()

perform (line 510)

Perform the Action

• return: Response code for the next Action or View
• access: public

myMVC_HttpResponse perform ()

---

Redefined in descendants as:

• myMVC_BaseLogoutAction::perform() : Log out the user and empty the session

saveRenderEngine (line 327)

Save the current used render engine.

It can be used to instanciate Mailview to be used in MessageManager

• access: public

void saveRenderEngine (Class $renderEngine)

• Class $renderEngine: The render engine

setCheckFunction (line 350)

Set the functions to be used to validate the user's input.

• access: protected

void setCheckFunction (string $type, string $func)

• string $type: The type of the request (ALL, POST, GET, AJAX)
• string $func: The method of the current class, to validate the input. It must return a boolean value (true: all valid, false: at least one field not validated)

validate (line 468)

Validate the data from user.

It call the proper validate function, depending on the request method (GET or POST), to allow different checks. WARNING: this function should not be overrided! Please create proper validatePost() or validateGet() functions!

• return: true if data are valid, false otherwise
• access: public

boolean validate ()

validateInput (line 765)

Check if the given data (from Request) are valid.

The function save in the session (namespace: validate) an associative array with the invalid fields.

• return: true if ALL fields are valid, false otherwise
• throws: myMVC_MVCException On problems
• access: protected

boolean validateInput (array $definitions, array $names, array $errorMsgs)

• array $definitions: The definition of the fields to validate as associative array ('field' => VALIDATE_TYPE)
• array $names: The names of the fields to be used for displaying errors as associative array ('field' => 'name')
• array $errorMsgs: The error messages for the fields as associative array ('field' => array('error' => 'message'))

Inherited Methods

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()