mirror of
https://github.com/vlucas/valitron.git
synced 2025-12-30 23:01:52 +00:00
Merge pull request #67 from brandonlamb/features/phpdoc
Update docblocks, consistency/missing types, etc
This commit is contained in:
commit
2d111d9204
@ -1,4 +1,5 @@
|
||||
<?php
|
||||
|
||||
namespace Valitron;
|
||||
|
||||
use InvalidArgumentException;
|
||||
@ -14,22 +15,64 @@ use InvalidArgumentException;
|
||||
*/
|
||||
class Validator
|
||||
{
|
||||
protected $_fields = array();
|
||||
protected $_errors = array();
|
||||
protected $_validations = array();
|
||||
protected $_labels = array();
|
||||
|
||||
protected static $_lang;
|
||||
protected static $_langDir;
|
||||
protected static $_rules = array();
|
||||
protected static $_ruleMessages = array();
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
const ERROR_DEFAULT = 'Invalid';
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $_fields = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $_errors = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $_validations = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $_labels = array();
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected static $_lang;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected static $_langDir;
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected static $_rules = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected static $_ruleMessages = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $validUrlPrefixes = array('http://', 'https://', 'ftp://');
|
||||
|
||||
/**
|
||||
* Setup validation
|
||||
*
|
||||
* @param array $data
|
||||
* @param array $fields
|
||||
* @param string $lang
|
||||
* @param string $langDir
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function __construct($data, $fields = array(), $lang = null, $langDir = null)
|
||||
{
|
||||
@ -59,6 +102,9 @@ class Validator
|
||||
|
||||
/**
|
||||
* Get/set language to use for validation messages
|
||||
*
|
||||
* @param string $Lang
|
||||
* @return string
|
||||
*/
|
||||
public static function lang($lang = null)
|
||||
{
|
||||
@ -70,6 +116,9 @@ class Validator
|
||||
|
||||
/**
|
||||
* Get/set language file path
|
||||
*
|
||||
* @param string $dir
|
||||
* @return string
|
||||
*/
|
||||
public static function langDir($dir = null)
|
||||
{
|
||||
@ -82,8 +131,8 @@ class Validator
|
||||
/**
|
||||
* Required field validator
|
||||
*
|
||||
* @param $field
|
||||
* @param $value
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @return bool
|
||||
*/
|
||||
protected function validateRequired($field, $value)
|
||||
@ -170,7 +219,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -191,7 +240,6 @@ class Validator
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param array $params
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
protected function validateLengthBetween($field, $value, $params)
|
||||
@ -247,7 +295,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -261,7 +309,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -275,7 +323,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -293,7 +341,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -422,7 +470,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @return bool
|
||||
*/
|
||||
protected function validateRegex($field, $value, $params)
|
||||
@ -447,7 +495,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -463,7 +511,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -479,7 +527,7 @@ class Validator
|
||||
*
|
||||
* @param string $field
|
||||
* @param mixed $value
|
||||
* @param $params
|
||||
* @param array $params
|
||||
* @internal param array $fields
|
||||
* @return bool
|
||||
*/
|
||||
@ -507,7 +555,7 @@ class Validator
|
||||
* optionally filtered by an array
|
||||
*
|
||||
* @param string $field
|
||||
* @param string $value
|
||||
* @param mixed $value
|
||||
* @param array $params
|
||||
* @return bool
|
||||
*/
|
||||
@ -614,6 +662,8 @@ class Validator
|
||||
|
||||
/**
|
||||
* Get array of fields and data
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function data()
|
||||
{
|
||||
@ -637,8 +687,8 @@ class Validator
|
||||
/**
|
||||
* Add an error to error messages array
|
||||
*
|
||||
* @param $field
|
||||
* @param $msg
|
||||
* @param string $field
|
||||
* @param string $msg
|
||||
* @param array $params
|
||||
*/
|
||||
public function error($field, $msg, array $params = array())
|
||||
@ -743,7 +793,7 @@ class Validator
|
||||
* Register new validation rule callback
|
||||
*
|
||||
* @param string $name
|
||||
* @param $callback
|
||||
* @param mixed $callback
|
||||
* @param string $message
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
@ -759,6 +809,11 @@ class Validator
|
||||
|
||||
/**
|
||||
* Convenience method to add a single validation rule
|
||||
*
|
||||
* @param string $fule
|
||||
* @param array $fields
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function rule($rule, $fields)
|
||||
{
|
||||
@ -785,7 +840,7 @@ class Validator
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $value
|
||||
* @param string $value
|
||||
* @internal param array $labels
|
||||
* @return $this
|
||||
*/
|
||||
@ -799,7 +854,7 @@ class Validator
|
||||
|
||||
/**
|
||||
* @param array $labels
|
||||
* @return $this
|
||||
* @return string
|
||||
*/
|
||||
public function labels($labels = array())
|
||||
{
|
||||
@ -808,9 +863,9 @@ class Validator
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $field
|
||||
* @param $msg
|
||||
* @param $params
|
||||
* @param string $field
|
||||
* @param string $msg
|
||||
* @param array $params
|
||||
* @return array
|
||||
*/
|
||||
private function checkAndSetLabel($field, $msg, $params)
|
||||
@ -836,6 +891,7 @@ class Validator
|
||||
|
||||
/**
|
||||
* Convenience method to add multiple validation rules with an array
|
||||
*
|
||||
* @param array $rules
|
||||
*/
|
||||
public function rules($rules)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user