\myMVC_BaseAction

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:

$definition['field on form'] = array('type' => myMVC_BaseAction::$VALIDATE_xxx, params);

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.

public function construct($request, $session) { parent::construct($request, $session); $this->setCheckFunction('POST', 'myValidateFunction'); }

public function myValidateFunction() { $definitions = array( 'testBoolean' => array('type' => myMVC_BaseAction::$VALIDATE_BOOLEAN), 'testBooleanNull' => array('type' => myMVC_BaseAction::$VALIDATE_BOOLEAN, 'empty' => true), 'testNumber' => array('type' => myMVC_BaseAction::$VALIDATE_NUMBER), 'testNumberNull' => array('type' => myMVC_BaseAction::$VALIDATE_NUMBER, 'empty' => true), 'testNumberRange1' => array('type' => myMVC_BaseAction::$VALIDATE_NUMBER, 'min' => 2, 'max' => 10), 'testNumberRange2' => array('type' => myMVC_BaseAction::$VALIDATE_NUMBER, 'range' => array(1, 3, 5, 7, 9)), 'testNumberRangeSQL' => array('type' => myMVC_BaseAction::$VALIDATE_NUMBER, 'rangesql' => 'SELECT id FROM test'), 'testDate' => array('type' => myMVC_BaseAction::$VALIDATEDATETIME, 'format' => ('%m/%d/%Y')), 'testDateNull' => array('type' => myMVC_BaseAction::$VALIDATEDATETIME, 'format' => ('%m/%d/%Y'), 'empty' => true), // see strftime for format 'testDateTime' => array('type' => myMVC_BaseAction::$VALIDATEDATETIME, 'format' => ('%m/%d/%Y %H:%M:%S')), 'testDateTimeNull' => array('type' => myMVC_BaseAction::$VALIDATEDATETIME, 'format' => ('%m/%d/%Y %H:%M:%S'), 'empty' => true), 'testEMail' => array('type' => myMVC_BaseAction::$VALIDATE_EMAIL), 'testEMailNull' => array('type' => myMVC_BaseAction::$VALIDATE_EMAIL, 'empty' => true), 'testEMailRange' => array('type' => myMVC_BaseAction::$VALIDATE_EMAIL, 'range' => array('test@test.de', 'test@test.com')), 'testEMailRangeSQL' => array('type' => myMVC_BaseAction::$VALIDATE_EMAIL, 'rangesql' => 'SELECT email FROM user WHERE active = 1'), 'testWeb' => array('type' => myMVC_BaseAction::$VALIDATE_WEB), 'testWebNull' => array('type' => myMVC_BaseAction::$VALIDATE_WEB, 'empty' => true), 'testWebRange' => array('type' => myMVC_BaseAction::$VALIDATE_WEB, 'range' => array('www.test.de', 'www.test.com')), 'testWebRangeSQL' => array('type' => myMVC_BaseAction::$VALIDATE_WEB, 'rangesql' => 'SELECT name FROM domain WHERE active = 1'), 'testDomain' => array('type' => myMVC_BaseAction::$VALIDATE_WEB, 'justdomain' => true), 'testString1' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'maxlen' => 20), 'testString2' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'maxlen' => 20, 'minlen' => 5), 'testString3' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'maxlen' => 20, 'empty' => false), 'testStringRange' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'range' => array('A', 'B', 'C')), 'testStringRangeSQL' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'rangesql' => 'SELECT name FROM test'), 'testStringRegExp' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'regexp' => '/^x.=3$/'), 'testExtraFunction' => array('type' => myMVC_BaseAction::$VALIDATE_EXTERN, 'checkFunction' => 'MyClass::checkValue'), 'testNewLogin' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'maxlen' => 20, 'minlen' => 5, 'empty' => false, 'comparedb' => array('query' => "SELECT COUNT() FROM user WHERE login = {checkValue}", 'compareType' => '==', 'compareValue' => 0)), 'testPass1' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'maxlen' => 20, 'minlen' => 5, 'empty' => true), 'testPass2' => array('type' => myMVC_BaseAction::$VALIDATE_STRING, 'maxlen' => 20, 'minlen' => 5, 'empty' => true, 'comparefield' => array('field' => 'testPass1', 'compareType' => '==')), 'testFile' => array('type' => myMVC_BaseAction::$VALIDATE_UPLOAD, 'minlen' => 1024, 'maxlen' => 65535, 'allowedtypes' = array('text/plain', 'text/html'), 'empty' => false), ); $names = array( 'field1' => ('Field ONE'), 'field2' => _('Field TWO') ); $errorMsgs = array( 'field1' => array(myMVC_BaseAction::$ERROREMPTY => sprintf(("%s cannot be empty'"), '{field}'), myMVC_BaseAction::$ERRORMIN => sprintf(("%s must be at least %s char long'"), '{field}', '{checkValue}'), ); return parent::validateInput($definitions, $names, $errorMsgs); } It is possible to use an external function to validate input:

public static function checkValue($request, $value, &$errMsg) { if($value != 'abcdef') { $errMsg = sprintf(_("Invalid value: %s", $value)); return false; } else return true; }

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

Properties

Methods