Properties

$VALIDATE_BOOLEAN

$VALIDATE_BOOLEAN : 

Check for a boolean value

Type

$VALIDATE_NUMBER

$VALIDATE_NUMBER : 

Check for a numeric value

Type

$VALIDATE_DATETIME

$VALIDATE_DATETIME : 

Check for a date/time value

Type

$VALIDATE_EMAIL

$VALIDATE_EMAIL : 

Check for an E-Mail

Type

$VALIDATE_WEB

$VALIDATE_WEB : 

Check for an URL

Type

$VALIDATE_STRING

$VALIDATE_STRING : 

Check for a generic string

Type

$VALIDATE_EXTERN

$VALIDATE_EXTERN : 

Check using external function

Type

$VALIDATE_UPLOAD

$VALIDATE_UPLOAD : 

Check for upload file

Type

$ERROR_NOTBOOL

$ERROR_NOTBOOL : 

Error not boolean

Type

$ERROR_NOTDATETIME

$ERROR_NOTDATETIME : 

Error not date/time

Type

$ERROR_NOTEMAIL

$ERROR_NOTEMAIL : 

Error not E-Mail

Type

$ERROR_NOTNUMBER

$ERROR_NOTNUMBER : 

Error not numeric

Type

$ERROR_NOTSTRING

$ERROR_NOTSTRING : 

Error not string

Type

$ERROR_NOTWEB

$ERROR_NOTWEB : 

Error not URL

Type

$ERROR_MAX

$ERROR_MAX : 

Error greater than given maximum

Type

$ERROR_MIN

$ERROR_MIN : 

Error lesser than given minimum

Type

$ERROR_MAXLEN

$ERROR_MAXLEN : 

Error longer than given maximum

Type

$ERROR_MINLEN

$ERROR_MINLEN : 

Error smaller than given minimum

Type

$ERROR_EMPTY

$ERROR_EMPTY : 

Error empty

Type

$ERROR_RANGE

$ERROR_RANGE : 

Error not in given range

Type

$ERROR_REGEXP

$ERROR_REGEXP : 

Error not matched in regular expression

Type

$ERROR_COMPAREDB

$ERROR_COMPAREDB : 

Error not matched in compare database

Type

$ERROR_COMPAREFIELD

$ERROR_COMPAREFIELD : 

Error not matched in compare fields

Type

$ERROR_INVALID

$ERROR_INVALID : 

Error invalid (generic)

Type

$ERROR_INVALIDTYPE

$ERROR_INVALIDTYPE : 

Error invalid type for upload

Type

$ERROR_UPLOADERROR

$ERROR_UPLOADERROR : 

Generic error for upload

Type

$renderEngine

$renderEngine : 

Type

$request

$request : 

Type

$session

$session : 

Type

$checkFunctionAll

$checkFunctionAll : 

Type

$checkFunctionPost

$checkFunctionPost : 

Type

$checkFunctionGet

$checkFunctionGet : 

Type

$checkFunctionAjax

$checkFunctionAjax : 

Type

Methods

__construct()

__construct() 

Constructor.

This function does nothing! This class will not be used, but just derived (see myMVC_BaseAction and myMVC_BaseView)

saveRenderEngine()

saveRenderEngine(\Class  $renderEngine) 

Save the current used render engine.

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

Parameters

\Class $renderEngine

The render engine

getActionToken()

getActionToken() : string

Returns the token used to identify the current Action

Returns

string —

The token

getActionMenuName()

getActionMenuName() : string

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

Only necessary if isMenuAction() returns true

Returns

string —

The menu item

getActionMenuPosition()

getActionMenuPosition() : integer

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

Returns

integer —

The position in the menu (lower is "upper")

hasUserRightForAction()

hasUserRightForAction() : boolean

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

Returns

boolean —

true if the user may call this Action, false otherwise

getCSSClass()

getCSSClass() : string

Returns the CSS class of this action

Returns

string —

The CSS class

isMenuAction()

isMenuAction() : boolean

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

Returns

boolean —

true if the action should appear in menu

validate()

validate() : boolean

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!

Returns

boolean —

true if data are valid, false otherwise

perform()

perform() : \myMVC_HttpResponse

Log out the user and empty the session

Returns

\myMVC_HttpResponse

Response code for the next Action or View

manageInvalidData()

manageInvalidData() : \myMVC_HttpResponse

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

Returns

\myMVC_HttpResponse

Response code for the next Action or View

                               (typically the same view, with error messages)

getRenderEngine()

getRenderEngine() : \Class

Return the current used render engine.

Returns

\Class —

The render engine

setCheckFunction()

setCheckFunction(string  $type, string  $func) 

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

Parameters

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)

isComingFromView()

isComingFromView(  $view) : boolean

Returns whether this action was called from the given view

Parameters

$view

Returns

boolean —

true if the action was called from the given view, false otherwise

isCalledFromMenu()

isCalledFromMenu() : boolean

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

Returns

boolean —

true if the action was called from a menu, false if it was called from a view

validateInput()

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

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

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

Parameters

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

Throws

\myMVC_MVCException

On problems

Returns

boolean —

true if ALL fields are valid, false otherwise

getNumber()

getNumber(string  $value) : \number

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

Parameters

string $value

The number to be converted

Returns

\number —

The converted number

getLoggedUser()

getLoggedUser() : \myMVC_BaseLogin

Returns the current logged user, if any.

This function has to be static, then it will normally called from static functions (eg hasUserRightForAction).

Returns

\myMVC_BaseLogin

The currently logged user, or NULL

                           if no user is logged in, or the user's
                           class is not a subclass of myMVC_BaseLogin

saveParameterForNextPage()

saveParameterForNextPage(string  $key, string  $value) 

Save a variable in the session, to be used by the next page (Action or view).

This variable can be read with the method getParameterFromPreviousPage of the classes BaseAction or BaseView

Parameters

string $key

The name of the variable

string $value

The value

getParameterFromPreviousPage()

getParameterFromPreviousPage(string  $key) 

Returns a variable saved from the previous class with saveParameterForNextPage

Parameters

string $key

The name of the variable

getFromPreviousSubmit()

getFromPreviousSubmit(  $field) 

Returns the value for the given field in the previous submitted form.

WARNING: This function just returns the fields, that passed the validation!!

Parameters

$field

getInvalidFromPreviousSubmit()

getInvalidFromPreviousSubmit(  $field) 

Returns the value for the given field in the previous submitted form.

WARNING: This function just returns the fields, that NOT passed the validation!!

Parameters

$field

isParameterFromPreviousSubmitValid()

isParameterFromPreviousSubmitValid(string  $field) : boolean

Returns whether the given parameter of the previous submitted form passed the validation or not.

Parameters

string $field

The name of the parameter

Returns

boolean —

true if the parameter passed the validation, false otherwise

getParameterErrors()

getParameterErrors() : array

Returns all error messages after the validation of the user's parameters

Returns

array —

An associative array with all the errors in the format

                           'field' => 'error message'

createErrorString()

createErrorString(array  $definitions, array  $names, array  $errorMsgs, string  $field, string  $check, string  $externError = NULL) : string

Create the error string for the given field.

Parameters

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'))
string $field

The checked field

string $check

The check that field does not passed

string $externError

Optional extra error (given from extern parsed check function). Default: NULL

Returns

string —

The formatted error string

checkExtraParameters()

checkExtraParameters(array  $checks, mixed  $userInput, array  $parameters) : string

Check if the given value from user's form comply with the given restrictions (min, max, range, and so on).

It does NOT check for empty value (this must be done before the first check).

Parameters

array $checks

The required checks as numeric array

mixed $userInput

User's input

array $parameters

The parameters to check the field

Returns

string —

The errors for this field (see myMVC_BaseAction::$ERROR_xxx)

                               or false if no errors occoured