README

NBD.php - 验证组件

提供易于使用的规则来检查各种数据类型。规则可以单独使用，也可以链接在一起，用于表单验证界面。

用法

快速验证单个数据点

use Behance\NBD\Validation\Rules\IntegerRule;

$rule  = new IntegerRule();

$valid = $rule->isValid( 123 );  // true
$valid = $rule->isValid( 'abc' );  // false

验证类似HTML表单的复杂键值数组“笼中”数据

use Behance\NBD\Validation\Services\ValidatorService;

$validator = new ValidatorService();

// Define a series of rules: field key, field name, and a pipe-separated sequence of validator rules (from list below)
$validator->setRule( 'email',      'E-Mail',          'required|email' )
          ->setRule( 'first_name', 'First Name',      'required|alpha' )
          ->setRule( 'last_name',  'Last Name',       'required|alpha' )
          ->setRule( 'middle_i',   'Middle Initial',  'alpha|nullable|maxLength[1]' );

// Insert data to be validated
$validator->setCageData( $_POST );

// Obtain a single result for whether this data set passes the defined rules
$valid = $validator->run();

if ( !$valid ) {

  // Loop through the failing fields
  $errors = $validator->getAllFieldErrorMessages();

  foreach ( $errors as $field => $message ) {
    // ...
  }

  // Retrieves an error message string for all failed fields
  $error_message = $validator->getAllFieldErrorMessagesString();

  // Retrieves the unrendered error templates for all failed fields
  $error_message = $validator->getAllFieldErrorTemplates();

  // Retrieves the context for a given field error
  $error_context = $validator->getFieldErrorContext( $field );

  // Just retrieve the error message for email field
  $email_message = $validator->getFieldErrorMessage( 'email' );

  // Just retrieve the field keys that failed
  $error_keys    = $validator->getFailedFields();

} // if !valid

else {

  // As a convenience, valid data points are available as magic properties
  $email      = $validator->email;
  $first_name = $validator->first_name;
  $last_name  = $validator->last_name;

  // You can check if a magic property exists using isset() whether or not it has passed validation.
  $has_middle = isset( $validator->middle_i );

  // Or, retrieve valid fields as a key-value array
  $fields = $validator->getValidData(); // ex. [ 'email' => xxx, ... ],  will discard unvalidated/failed fields

  // Triple check that a field is valid
  $email_valid = $validator->isFailed( 'email' );   // false
  $field_name  = $validator->getFieldName( $key );  // E-Mail

} // else (valid)

可用的 '简单' 验证规则（且在增长中）

• alpha
• alphaNumeric
• array
• decimal
• email
• float
• hexColor
• postitiveInteger
• integer
• json
• notEmpty
• phone
• string
• url
• nestedArray

可用的参数化验证规则

参数在规则后面用逗号分隔的方括号内定义

特殊参数化规则

其他特殊规则

示例

• 有效的“有效”情况仍然取决于规则集的其余部分
• 特殊规则不能单独或与其他规则一起单独使用，它们必须与其他规则一起使用。

快速轻松地添加自定义命名验证器

use Behance\NBD\Validation\Services\ValidatorService;

$validator = new ValidatorService();
$rules     = $validator->getRulesProvider();

// Creates a rule that can be used independently, or as part of the validator service
$regex_rule = $rules->setRegexRule( 'myNewRegexRule', '/^abcdefg$/' );
$valid      = $regex_rule->isValid( 'abcdefg' );  // true


// Create a callback rule based on a boolean-returning closure, can also be used in both places
$closure = ( function( $data ) {
  return $data == 'hello';
} );

$callback_rule = $rules->setCallbackRule( 'hello', $closure );

$callback_rule->isValid( 'hello' );  // true

#####递归规则

nestedArray规则接受一个额外的第四个参数，即规则数组

use Behance\NBD\Validation\Services\ValidatorService;

$validator = new ValidatorService();

$validator->setRules( [
    [ 'email', 'E-Mail', 'required|email' ],
    [ 'name',  'Name',   'nestedArray',
        [
            [ 'first_name', 'First Name',      'required|alpha' ],
            [ 'last_name',  'Last Name',       'required|alpha' ],
            [ 'middle_i',   'Middle Initial',  'alpha|nullable|maxLength[10]' ]
        ]
    ]
] );

also can set using setNestedRule:

$validator->setNestedRule( [ 'name',  'Name',   'nestedArray',
    [
        [ 'first_name', 'First Name',      'required|alpha' ],
        [ 'last_name',  'Last Name',       'required|alpha' ],
        [ 'middle_i',   'Middle Initial',  'alpha|nullable|maxLength[10]' ]
    ]
] );

$validator->runStrict();

$validated_data = $validator->getValidatedData();

$email      = $validated_data['email'];
$first_name = $validated_data['name']['first_name'];
$last_name  = $validated_data['name']['last_name'];
$middle_i   = $validated_data['name']['middle_i'];