Datenvalidierung¶

rule¶

Das ‘rule’ Schlüsselwort definiert die Validierungsmethode und erwartet einen einzelnen Wert oder ein Array. Der angegebene Wert für ‘rule’ kann der Name einer Methode des Models sein, eine Methode der Kern-Klasse Validation, oder eine regular expression. Eine komplette Liste aller integrierten Regeln ist im nächsten Kapitel „Mehrere Regeln pro Feld“ dargestellt.

Falls die Regel keine Parameter benötigt, kann ‘rule’ auch ein einzelner Wert sein. z.B.:

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric'
    )
);

Falls die Regel Parameter erwartet (wie z.B. max, min oder range) sollte ‘rule’ als Array ausgezeichnet werden:

var $validate = array(
    'password' => array(
        'rule' => array('minLength', 8)
    )
);

Verigss nicht, das Schlüsselwort ‘rule’ wird für Array-basierte Regeldefinitionen benötigt.

required¶

Dieser Schlüssel sollte ein boolscher Wert sein. Falls ‘required’ TRUE ist, muss das Feld im Daten-Array existieren. Zum Beispiel wenn die Validierungsregel wie folgt definiert ist:

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric',
        'required' => true
    )
);

Die Daten die zur save() Methode des Models gesendet werden, müssen das Feld ‚login‘ enthalten. Wenn das nicht der Fall ist, schlägt die Validierung fehl. Der Standard-Wert dieses Schlüssels ist der boolsche Wert FALSE.

Ist der ‚login‘ Schlüssel enthalten, jedoch leer, wird die Validierung erfolgreich sein. Ist der Schlüssel ‘required’ auf TRUE gesetzt, wird nur überprüft ob der Feldname existiert.

allowEmpty¶

Dem Schlüssel allowEmpty sollte ein boolscher Wert zugewiesen werden. Falls allowEmpty „false“ ist, müssen jene Daten, die an die save()-Methode des Modells übergeben werden, den Feldnamen und einen nicht leeren Wert enthalten. Wird „true“ gesetzt, bewirkt ein leeres Feld, dass die Gültigkeitsprüfung ausgelassen wird.

Der Standardwert von allowEmpty ist „null“. Das bedeutet, dass das Feld immer auf die Gültigkeitsregeln hin überprüft wird und selbst erstellte Gültigkeitsregeln beachtet werden.

on¶

Der Schlüssel ‘on’ kann auf einen der folgenden Werte gesetzt werden: ‘update’ oder ‘create’ (ins Deutsche würde man ‘on’ mit dem umgangssprachlichen ‘beim’ übersetzen). Dies erlaubt Dir zu steuern, dass eine Regel wahlweise bei der Erstellung oder einem Update eines Datensatzes angewandt werden soll.

Wenn eine Regel ‘on’ => ‘create’ beinhaltet, so wird sie nur angewandt, wenn ein neuer Datensatz erstellt werden soll. Andersherum, wenn die Regel ‘on’ => ‘update’ enthält, wird sie nur bei einer Änderung eines Datensatzes beachtet.

Der Standardwert von ‘on’ ist „null“. Wenn ‘on’ „null“ ist wird die entsprechende Regel sowohl bei ‘update’ als auch bei ‘create’ angewandt.

message¶

Der Schlüssel ‘message’ erlaubt es Dir, eine eigene Fehlermeldung bzw. Verletzungsmeldung für diese Regel zu bestimmen:

var $validate = array(
    'password' => array(
        'rule' => array('minLength', 8),
        'message' => 'Password must be at least 8 characters long'
    )
);

alphaNumeric¶

Der Feldwert darf nur Buchstaben und Zahlen enthalten.

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric',
        'message' => 'Benutzernamen dürfen nur Buchstaben und Zahlen enthalten.'
    )
);

between¶

The length of the data for the field must fall within the specified numeric range. Both minimum and maximum values must be supplied. Uses <= not < .

var $validate = array(
    'password' => array(
        'rule' => array('between', 5, 15),
        'message' => 'Passwords must be between 5 and 15 characters long.'
    )
);

The length of data is „the number of bytes in the string representation of the data“. Be careful that it may be larger than the number of characters when handling non-ASCII characters.

blank¶

This rule is used to make sure that the field is left blank or only white space characters are present in its value. White space characters include space, tab, carriage return, and newline.

var $validate = array(
    'id' => array(
        'rule' => 'blank',
        'on' => 'create'
    )
);

boolean¶

Der Inhalt des Feldes muss ein boolscher Wert sein. Gültige Werte sind true oder false, Integer-Werte 0 oder 1 oder Strings ‚0‘ oder ‚1‘.

var $validate = array(
    'myCheckbox' => array(
        'rule' => array('boolean'),
        'message' => 'Falscher Wert für myCheckbox'
    )
);

cc¶

This rule is used to check whether the data is a valid credit card number. It takes three parameters: ‘type’, ‘deep’ and ‘regex’.

The ‘type’ key can be assigned to the values of ‘fast’, ‘all’ or any of the following:

• amex

• bankcard

• diners

• disc

• electron

• enroute

• jcb

• maestro

• mc

• solo

• switch

• visa

• voyager

If ‘type’ is set to ‘fast’, it validates the data against the major credit cards’ numbering formats. Setting ‘type’ to ‘all’ will check with all the credit card types. You can also set ‘type’ to an array of the types you wish to match.

The ‘deep’ key should be set to a boolean value. If it is set to true, the validation will check the Luhn algorithm of the credit card (https://en.wikipedia.org/wiki/Luhn_algorithm). It defaults to false.

The ‘regex’ key allows you to supply your own regular expression that will be used to validate the credit card number.

var $validate = array(
    'ccnumber' => array(
        'rule' => array('cc', array('visa', 'maestro'), false, null),
        'message' => 'The credit card number you supplied was invalid.'
    )
);

Vergleiche¶

Vergleiche werden benutzt um numerische Werte miteinander zu vergleichen. Unterstützt werden „is greater“ (größer als), „is less“ (kleiner als), „greater or equal“ (größer/gleich), „less or equal“ (kleiner/gleich), „equal to“ (gleich) und „not equal“ (ungleich). Es folgen einige Beispiel:

var $validate = array(
    'age' => array(
        'rule' => array('comparison', '>=', 18),
        'message' => 'Man muss mindestens 18 Jahre alt sein, um sich zu qualifizieren.'
    )
);

var $validate = array(
    'age' => array(
        'rule' => array('comparison', 'greater or equal', 18),
        'message' => 'Man muss mindestens 18 Jahre alt sein, um sich zu qualifizieren.'
    )
);

date¶

This rule ensures that data is submitted in valid date formats. A single parameter (which can be an array) can be passed that will be used to check the format of the supplied date. The value of the parameter can be one of the following:

• ‘dmy’ e.g. 27-12-2006 or 27-12-06 (separators can be a space, period, dash, forward slash)

• ‘mdy’ e.g. 12-27-2006 or 12-27-06 (separators can be a space, period, dash, forward slash)

• ‘ymd’ e.g. 2006-12-27 or 06-12-27 (separators can be a space, period, dash, forward slash)

• ‘dMy’ e.g. 27 December 2006 or 27 Dec 2006

• ‘Mdy’ e.g. December 27, 2006 or Dec 27, 2006 (comma is optional)

• ‘My’ e.g. (December 2006 or Dec 2006)

• ‘my’ e.g. 12/2006 or 12/06 (separators can be a space, period, dash, forward slash)

If no keys are supplied, the default key that will be used is ‘ymd’.

var $validate = array(
    'born' => array(
        'rule' => array('date','ymd'),
        'message' => 'Enter a valid date in YY-MM-DD format.',
        'allowEmpty' => true
    )
);

While many data stores require a certain date format, you might consider doing the heavy lifting by accepting a wide-array of date formats and trying to convert them, rather than forcing users to supply a given format. The more work you can do for your users, the better.

decimal¶

This rule ensures that the data is a valid decimal number. A parameter can be passed to specify the number of digits required after the decimal point. If no parameter is passed, the data will be validated as a scientific float, which will cause validation to fail if no digits are found after the decimal point.

var $validate = array(
    'price' => array(
        'rule' => array('decimal', 2)
    )
);

email¶

This checks whether the data is a valid email address. Passing a boolean true as the second parameter for this rule will also attempt to verify that the host for the address is valid.

var $validate = array('email' => array('rule' => 'email'));

var $validate = array(
    'email' => array(
        'rule' => array('email', true),
        'message' => 'Please supply a valid email address.'
    )
);

equalTo¶

This rule will ensure that the value is equal to, and of the same type as the given value.

var $validate = array(
    'food' => array(
        'rule' => array('equalTo', 'cake'),
        'message' => 'This value must be the string cake'
    )
);

extension¶

This rule checks for valid file extensions like .jpg or .png. Allow multiple extensions by passing them in array form.

var $validate = array(
    'image' => array(
        'rule' => array('extension', array('gif', 'jpeg', 'png', 'jpg')),
        'message' => 'Please supply a valid image.'
    )
);

file¶

This rule ensures that the value is a valid file name. This validation rule is currently non-functional.

ip¶

This rule will ensure that a valid IPv4 or IPv6 address has been submitted. Accepts as option ‚both‘ (default), ‚IPv4‘ or ‚IPv6‘.

var $validate = array(
    'clientip' => array(
        'rule' => array('ip', 'IPv4'), // or 'IPv6' or 'both' (default)
        'message' => 'Please supply a valid IP address.'
    )
);

isUnique¶

The data for the field must be unique, it cannot be used by any other rows.

var $validate = array(
    'login' => array(
        'rule' => 'isUnique',
        'message' => 'This username has already been taken.'
    )
);

minLength¶

This rule ensures that the data meets a minimum length requirement.

var $validate = array(
    'login' => array(
        'rule' => array('minLength', 8),
        'message' => 'Usernames must be at least 8 characters long.'
    )
);

The length here is „the number of bytes in the string representation of the data“. Be careful that it may be larger than the number of characters when handling non-ASCII characters.

maxLength¶

This rule ensures that the data stays within a maximum length requirement.

var $validate = array(
    'login' => array(
        'rule' => array('maxLength', 15),
        'message' => 'Usernames must be no larger than 15 characters long.'
    )
);

The length here is „the number of bytes in the string representation of the data“. Be careful that it may be larger than the number of characters when handling non-ASCII characters.

money¶

This rule will ensure that the value is in a valid monetary amount.

Second parameter defines where symbol is located (left/right).

var $validate = array(
    'salary' => array(
        'rule' => array('money', 'left'),
        'message' => 'Please supply a valid monetary amount.'
    )
);

multiple¶

Use this for validating a multiple select input. It supports parameters „in“, „max“ and „min“.

var $validate = array(
    'multiple' => array(
        'rule' => array('multiple', array('in' => array('do', 'ray', 'me', 'fa', 'so', 'la', 'ti'), 'min' => 1, 'max' => 3)),
        'message' => 'Please select one, two or three options'
    )
);

inList¶

This rule will ensure that the value is in a given set. It needs an array of values. The field is valid if the field’s value matches one of the values in the given array.

Example:

var $validate = array(
  'function' => array(
    'allowedChoice' => array(
        'rule' => array('inList', array('Foo', 'Bar')),
        'message' => 'Enter either Foo or Bar.'
    )
  )
);

numeric¶

Checks if the data passed is a valid number.

var $validate = array(
    'cars' => array(
        'rule' => 'numeric',
        'message' => 'Please supply the number of cars.'
    )
);

notEmpty¶

The basic rule to ensure that a field is not empty.

var $validate = array(
    'title' => array(
        'rule' => 'notEmpty',
        'message' => 'This field cannot be left blank'
    )
);

Do not use this for a multiple select input as it will cause an error. Instead, use „multiple“.

phone¶

Phone validates US phone numbers. If you want to validate non-US phone numbers, you can provide a regular expression as the second parameter to cover additional number formats.

var $validate = array(
    'phone' => array(
        'rule' => array('phone', null, 'us')
    )
);

postal¶

Postal is used to validate ZIP codes from the U.S. (us), Canada (ca), U.K (uk), Italy (it), Germany (de) and Belgium (be). For other ZIP code formats, you may provide a regular expression as the second parameter.

var $validate = array(
    'zipcode' => array(
        'rule' => array('postal', null, 'us')
    )
);

range¶

This rule ensures that the value is in a given range. If no range is supplied, the rule will check to ensure the value is a legal finite on the current platform.

var $validate = array(
    'number' => array(
        'rule' => array('range', -1, 11),
        'message' => 'Please enter a number between 0 and 10'
    )
);

The above example will accept any value which is larger than 0 (e.g., 0.01) and less than 10 (e.g., 9.99). Note: The range lower/upper are not inclusive!!!

ssn¶

Ssn validates social security numbers from the U.S. (us), Denmark (dk), and the Netherlands (nl). For other social security number formats, you may provide a regular expression.

var $validate = array(
    'ssn' => array(
        'rule' => array('ssn', null, 'us')
    )
);

url¶

This rule checks for valid URL formats. Supports http(s), ftp(s), file, news, and gopher protocols.

var $validate = array(
    'website' => array(
        'rule' => 'url'
    )
);

To ensure that a protocol is in the url, strict mode can be enabled like so.

var $validate = array(
    'website' => array(
        'rule' => array('url', true)
    )
);

Benutzerdefinierte Validierung mit Regulären Ausdrücken¶

Falls Sie eine Validierungsmethode benötigen, die Sie mit Regulären Ausdrücken erreichen können/wollen, können Sie auch eigene benutzerdefinierte Reguläre Ausdrücke als Validierungsregel für die Daten des zu validierenden Feldes definieren.

var $validate = array(
    'login' => array(
        'rule' => array('custom', '/^[a-z0-9]{3,}$/i'),
        'message' => 'Nur Buchstaben und Zahlen, mindestens 3 Zeichen'
    )
);

Das Beispiel hier überprüft, ob die Daten des login Feldes nur Buchstaben und Zahlen mit einer Mindestlänge von 3 Zeichen enthalten.

Adding your own Validation Methods¶

Sometimes checking data with regular expression patterns is not enough. For example, if you want to ensure that a promotional code can only be used 25 times, you need to add your own validation function, as shown below:

<?php
class User extends AppModel {
    var $name = 'User';

    var $validate = array(
        'promotion_code' => array(
            'rule' => array('limitDuplicates', 25),
            'message' => 'This code has been used too many times.'
        )
    );

    function limitDuplicates($check, $limit){
        //$check will have value: array('promomotion_code' => 'some-value')
        //$limit will have value: 25
        $existing_promo_count = $this->find( 'count', array('conditions' => $check, 'recursive' => -1) );
        return $existing_promo_count < $limit;
    }
}
?>

The current field to be validated is passed into the function as first parameter as an associated array with field name as key and posted data as value.

If you want to pass extra parameters to your validation function, add elements onto the ‘rule’ array, and handle them as extra params (after the main $check param) in your function.

Your validation function can be in the model (as in the example above), or in a behavior that the model implements. This includes mapped methods.

Model/behavior methods are checked first, before looking for a method on the Validation class. This means that you can override existing validation methods (such as alphaNumeric()) at an application level (by adding the method to AppModel), or at model level.

When writing a validation rule which can be used by multiple fields, take care to extract the field value from the $check array. The $check array is passed with the form field name as its key and the field value as its value. The full record being validated is stored in $this->data member variable.

<?php
class Post extends AppModel {
  var $name = 'Post';

  var $validate = array(
    'slug' => array(
      'rule' => 'alphaNumericDashUnderscore',
      'message' => 'Slug can only be letters, numbers, dash and underscore'
      )
    );

    function alphaNumericDashUnderscore($check) {
      // $data array is passed using the form field name as the key
      // have to extract the value to make the function generic
      $value = array_shift($check);

      return preg_match('|^[0-9a-zA-Z_-]*$|', $value);
    }
}
?>

Current rule is always passed as the last method marameter, so you can access it:

<?php
class Message extends AppModel {
  var $name = 'Message ';

 var $validate = array(
    'emails' => array(
      'rule' => 'emails',
      'maxcount' => 20
      )
    );
    function emails($check) {
        $rule = func_get_arg(func_num_args()-1);
        $field = key($check);
        $value = $check[$field];
        $emails = $this->getEmails($value);
        $errors = array();
        $validation =& Validation::getInstance();
        foreach($emails as $email) {
            if (!$validation->email($email))
                $errors []= "Email '$email' is invalid.";
        }
        if (isset($rule['maxcount']) && count($emails)>$rule['maxcount'])
            $errors [] = "Up to {$rule['maxcount']} emails are allowed.";

        if (!empty($errors))
            return implode("\n", $errors);
        return true;
    }