mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 11:28:25 +00:00
481 lines
14 KiB
PHP
481 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* ModelValidator.
|
|
*
|
|
* Provides the Model validation logic.
|
|
*
|
|
* PHP versions 5
|
|
*
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
|
* Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
|
* @package Cake.Model
|
|
* @since CakePHP(tm) v 2.2.0
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
|
*/
|
|
App::uses('CakeField', 'Model/Validator');
|
|
App::uses('CakeRule', 'Model/Validator');
|
|
|
|
/**
|
|
* ModelValidator object.
|
|
*
|
|
* @package Cake.Model
|
|
* @link http://book.cakephp.org/2.0/en/data-validation.html
|
|
*/
|
|
class ModelValidator {
|
|
|
|
/**
|
|
* Holds the validationErrors
|
|
*
|
|
* @var array
|
|
*/
|
|
public $validationErrors = array();
|
|
|
|
/**
|
|
* Holds the options
|
|
*
|
|
* @var array
|
|
*/
|
|
public $options = array();
|
|
|
|
/**
|
|
* Holds the CakeField objects array
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_fields = array();
|
|
|
|
/**
|
|
* Holds the reference to the model the Validator is attached to
|
|
*
|
|
* @var Model
|
|
*/
|
|
protected $_model = array();
|
|
|
|
/**
|
|
* The validators $validate property
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_validate = array();
|
|
|
|
/**
|
|
* Holds the available custom callback methods
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_methods = array();
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param Model $Model A reference to the Model the Validator is attached to
|
|
*/
|
|
public function __construct(Model $Model) {
|
|
$this->_model = $Model;
|
|
}
|
|
|
|
/**
|
|
* Returns true if all fields pass validation. Will validate hasAndBelongsToMany associations
|
|
* that use the 'with' key as well. Since _saveMulti is incapable of exiting a save operation.
|
|
*
|
|
* Will validate the currently set data. Use Model::set() or Model::create() to set the active data.
|
|
*
|
|
* @param array $options An optional array of custom options to be made available in the beforeValidate callback
|
|
* @return boolean True if there are no errors
|
|
*/
|
|
public function validates($options = array()) {
|
|
$errors = $this->invalidFields($options);
|
|
if (empty($errors) && $errors !== false) {
|
|
$errors = $this->_validateWithModels($options);
|
|
}
|
|
if (is_array($errors)) {
|
|
return count($errors) === 0;
|
|
}
|
|
return $errors;
|
|
}
|
|
|
|
/**
|
|
* Validates a single record, as well as all its directly associated records.
|
|
*
|
|
* #### Options
|
|
*
|
|
* - atomic: If true (default), returns boolean. If false returns array.
|
|
* - fieldList: Equivalent to the $fieldList parameter in Model::save()
|
|
* - deep: If set to true, not only directly associated data , but deeper nested associated data is validated as well.
|
|
*
|
|
* @param array $data Record data to validate. This should be an array indexed by association name.
|
|
* @param array $options Options to use when validating record data (see above), See also $options of validates().
|
|
* @return array|boolean If atomic: True on success, or false on failure.
|
|
* Otherwise: array similar to the $data array passed, but values are set to true/false
|
|
* depending on whether each record validated successfully.
|
|
*/
|
|
public function validateAssociated($data, $options = array()) {
|
|
$model = $this->getModel();
|
|
|
|
$options = array_merge(array('atomic' => true, 'deep' => false), $options);
|
|
$model->validationErrors = $validationErrors = $return = array();
|
|
if (!($model->create($data) && $model->validates($options))) {
|
|
$validationErrors[$model->alias] = $model->validationErrors;
|
|
$return[$model->alias] = false;
|
|
} else {
|
|
$return[$model->alias] = true;
|
|
}
|
|
$associations = $model->getAssociated();
|
|
foreach ($data as $association => $values) {
|
|
$validates = true;
|
|
if (isset($associations[$association])) {
|
|
if (in_array($associations[$association], array('belongsTo', 'hasOne'))) {
|
|
if ($options['deep']) {
|
|
$validates = $model->{$association}->validateAssociated($values, $options);
|
|
} else {
|
|
$validates = $model->{$association}->create($values) !== null && $model->{$association}->validates($options);
|
|
}
|
|
if (is_array($validates)) {
|
|
if (in_array(false, $validates, true)) {
|
|
$validates = false;
|
|
} else {
|
|
$validates = true;
|
|
}
|
|
}
|
|
$return[$association] = $validates;
|
|
} elseif ($associations[$association] === 'hasMany') {
|
|
$validates = $model->{$association}->validateMany($values, $options);
|
|
$return[$association] = $validates;
|
|
}
|
|
if (!$validates || (is_array($validates) && in_array(false, $validates, true))) {
|
|
$validationErrors[$association] = $model->{$association}->validationErrors;
|
|
}
|
|
}
|
|
}
|
|
|
|
$model->validationErrors = $validationErrors;
|
|
if (isset($validationErrors[$model->alias])) {
|
|
$model->validationErrors = $validationErrors[$model->alias];
|
|
}
|
|
if (!$options['atomic']) {
|
|
return $return;
|
|
}
|
|
if ($return[$model->alias] === false || !empty($model->validationErrors)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Validates multiple individual records for a single model
|
|
*
|
|
* #### Options
|
|
*
|
|
* - atomic: If true (default), returns boolean. If false returns array.
|
|
* - fieldList: Equivalent to the $fieldList parameter in Model::save()
|
|
* - deep: If set to true, all associated data will be validated as well.
|
|
*
|
|
* @param array $data Record data to validate. This should be a numerically-indexed array
|
|
* @param array $options Options to use when validating record data (see above), See also $options of validates().
|
|
* @return boolean True on success, or false on failure.
|
|
* @return mixed If atomic: True on success, or false on failure.
|
|
* Otherwise: array similar to the $data array passed, but values are set to true/false
|
|
* depending on whether each record validated successfully.
|
|
*/
|
|
public function validateMany($data, $options = array()) {
|
|
$model = $this->getModel();
|
|
$options = array_merge(array('atomic' => true, 'deep' => false), $options);
|
|
$model->validationErrors = $validationErrors = $return = array();
|
|
foreach ($data as $key => $record) {
|
|
if ($options['deep']) {
|
|
$validates = $model->validateAssociated($record, $options);
|
|
} else {
|
|
$validates = $model->create($record) && $model->validates($options);
|
|
}
|
|
if ($validates === false || (is_array($validates) && in_array(false, $validates, true))) {
|
|
$validationErrors[$key] = $model->validationErrors;
|
|
$validates = false;
|
|
} else {
|
|
$validates = true;
|
|
}
|
|
$return[$key] = $validates;
|
|
}
|
|
$model->validationErrors = $validationErrors;
|
|
if (!$options['atomic']) {
|
|
return $return;
|
|
}
|
|
if (empty($model->validationErrors)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of fields that have failed validation. On the current model.
|
|
*
|
|
* @param string $options An optional array of custom options to be made available in the beforeValidate callback
|
|
* @return array Array of invalid fields
|
|
* @see Model::validates()
|
|
*/
|
|
public function invalidFields($options = array()) {
|
|
if (!$this->propagateBeforeValidate($options)) {
|
|
return false;
|
|
}
|
|
$model = $this->getModel();
|
|
$this->setOptions($options);
|
|
|
|
if (!$this->_parseRules()) {
|
|
return $model->validationErrors;
|
|
}
|
|
|
|
$exists = $model->exists();
|
|
$methods = $this->getMethods();
|
|
foreach ($this->_fields as $field) {
|
|
$field->setMethods($methods);
|
|
$field->setValidationDomain($model->validationDomain);
|
|
$data = isset($model->data[$model->alias]) ? $model->data[$model->alias] : array();
|
|
$errors = $field->validate($data, $exists);
|
|
foreach ($errors as $error) {
|
|
$this->invalidate($field->field, $error);
|
|
}
|
|
}
|
|
|
|
return $model->validationErrors;
|
|
}
|
|
|
|
/**
|
|
* Marks a field as invalid, optionally setting the name of validation
|
|
* rule (in case of multiple validation for field) that was broken.
|
|
*
|
|
* @param string $field The name of the field to invalidate
|
|
* @param mixed $value Name of validation rule that was not failed, or validation message to
|
|
* be returned. If no validation key is provided, defaults to true.
|
|
* @return void
|
|
*/
|
|
public function invalidate($field, $value = true) {
|
|
if (!is_array($this->validationErrors)) {
|
|
$this->validationErrors = array();
|
|
}
|
|
$this->getModel()->validationErrors[$field][] = $value;
|
|
}
|
|
|
|
/**
|
|
* Gets all possible custom methods from the Model, Behaviors and the Validator.
|
|
* gets the corresponding methods.
|
|
*
|
|
* @return array The requested methods
|
|
*/
|
|
public function getMethods() {
|
|
if (!empty($this->_methods)) {
|
|
return $this->_methods;
|
|
}
|
|
|
|
$methods = array();
|
|
foreach (get_class_methods($this->_model) as $method); {
|
|
$methods[strtolower($method)] = array($this->_model, $method);
|
|
}
|
|
|
|
foreach (array_keys($this->_model->Behaviors->methods()) as $mthod) {
|
|
$methods += array(strtolower($method) => array($this->_model, $method));
|
|
}
|
|
|
|
return $this->_methods = $methods;
|
|
}
|
|
|
|
/**
|
|
* Gets all fields if $name is null (default), or the field for fieldname $name if it's found.
|
|
*
|
|
* @param string $name [optional] The fieldname to fetch. Defaults to null.
|
|
* @return mixed Either array of CakeField objects , single object for $name or false when $name not present in fields
|
|
*/
|
|
public function getFields($name = null) {
|
|
if ($name !== null && !empty($this->_fields[$name])) {
|
|
return $this->_fields[$name];
|
|
} elseif ($name !==null) {
|
|
return false;
|
|
}
|
|
return $this->_fields;
|
|
}
|
|
|
|
/**
|
|
* Sets the CakeField instances from the Model::$validate property after processing the fieldList and whiteList.
|
|
* If Model::$validate is not set or empty, this method returns false. True otherwise.
|
|
*
|
|
* @return boolean True if Model::$validate was processed, false otherwise
|
|
*/
|
|
protected function _parseRules() {
|
|
if (empty($this->_model->validate)) {
|
|
$this->_validate = array();
|
|
$this->_fields = array();
|
|
return false;
|
|
}
|
|
|
|
if (!empty($this->_validate) && $this->_validate === $this->_model->validate) {
|
|
return true;
|
|
}
|
|
|
|
$this->_validate = $this->_model->validate;
|
|
$this->_processWhitelist();
|
|
|
|
$this->_fields = array();
|
|
$methods = $this->getMethods();
|
|
foreach ($this->_validate as $fieldName => $ruleSet) {
|
|
$this->_fields[$fieldName] = new CakeField($fieldName, $ruleSet, $methods);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Sets an options array. If $mergeVars is true, the options will be merged with the existing ones.
|
|
* Otherwise they will get replaced. The default is merging the vars.
|
|
*
|
|
* @param array $options [optional] The options to be set
|
|
* @param boolean $mergeVars [optional] If true, the options will be merged, otherwise they get replaced
|
|
* @return ModelValidator
|
|
*/
|
|
public function setOptions($options = array(), $mergeVars = false) {
|
|
if ($mergeVars === false) {
|
|
$this->options = $options;
|
|
} else {
|
|
$this->options = array_merge($this->options, $options);
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets an option $name with $value. This method is chainable
|
|
*
|
|
* @param string $name The options name to be set
|
|
* @param mixed $value [optional] The value to be set. Defaults to null.
|
|
* @return ModelValidator
|
|
*/
|
|
public function setOption($name, $value = null) {
|
|
$this->options[$name] = $value;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets an options value by $name. If $name is not set or no option has been found, returns null.
|
|
*
|
|
* @param string $name The options name to look up
|
|
* @return mixed Either null or the option value
|
|
*/
|
|
public function getOptions($name = null) {
|
|
if ($name !== null) {
|
|
if (!isset($this->options[$name])) {
|
|
return null;
|
|
}
|
|
return $this->options[$name];
|
|
}
|
|
return $this->options;
|
|
}
|
|
|
|
/**
|
|
* Sets the I18n domain for validation messages. This method is chainable.
|
|
*
|
|
* @param string $validationDomain [optional] The validation domain to be used.
|
|
* @return ModelValidator
|
|
*/
|
|
public function setValidationDomain($validationDomain) {
|
|
$model->validationDomain = $validationDomain;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the parent Model
|
|
*
|
|
* @return Model
|
|
*/
|
|
public function getModel() {
|
|
return $this->_model;
|
|
}
|
|
|
|
/**
|
|
* Processes the Model's whitelist and adjusts the validate array accordingly
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function _processWhitelist() {
|
|
$model = $this->getModel();
|
|
$whitelist = $model->whitelist;
|
|
$fieldList = $this->getOptions('fieldList');
|
|
|
|
if (!empty($fieldList)) {
|
|
if (!empty($fieldList[$model->alias]) && is_array($fieldList[$model->alias])) {
|
|
$whitelist = $fieldList[$model->alias];
|
|
} else {
|
|
$whitelist = $fieldList;
|
|
}
|
|
}
|
|
unset($fieldList);
|
|
|
|
if (!empty($whitelist)) {
|
|
$this->validationErrors = array();
|
|
$validate = array();
|
|
foreach ((array)$whitelist as $f) {
|
|
if (!empty($this->_validate[$f])) {
|
|
$validate[$f] = $this->_validate[$f];
|
|
}
|
|
}
|
|
$this->_validate = $validate;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Runs validation for hasAndBelongsToMany associations that have 'with' keys
|
|
* set. And data in the set() data set.
|
|
*
|
|
* @param array $options Array of options to use on Validation of with models
|
|
* @return boolean Failure of validation on with models.
|
|
* @see Model::validates()
|
|
*/
|
|
protected function _validateWithModels($options) {
|
|
$valid = true;
|
|
$model = $this->getModel();
|
|
|
|
foreach ($model->hasAndBelongsToMany as $assoc => $association) {
|
|
if (empty($association['with']) || !isset($model->data[$assoc])) {
|
|
continue;
|
|
}
|
|
list($join) = $model->joinModel($model->hasAndBelongsToMany[$assoc]['with']);
|
|
$data = $model->data[$assoc];
|
|
|
|
$newData = array();
|
|
foreach ((array)$data as $row) {
|
|
if (isset($row[$model->hasAndBelongsToMany[$assoc]['associationForeignKey']])) {
|
|
$newData[] = $row;
|
|
} elseif (isset($row[$join]) && isset($row[$join][$model->hasAndBelongsToMany[$assoc]['associationForeignKey']])) {
|
|
$newData[] = $row[$join];
|
|
}
|
|
}
|
|
if (empty($newData)) {
|
|
continue;
|
|
}
|
|
foreach ($newData as $data) {
|
|
$data[$model->hasAndBelongsToMany[$assoc]['foreignKey']] = $model->id;
|
|
$model->{$join}->create($data);
|
|
$valid = ($valid && $model->{$join}->validator()->validates($options));
|
|
}
|
|
}
|
|
return $valid;
|
|
}
|
|
|
|
/**
|
|
* Propagates the beforeValidate event
|
|
*
|
|
* @param array $options
|
|
* @return boolean
|
|
*/
|
|
public function propagateBeforeValidate($options = array()) {
|
|
$model = $this->getModel();
|
|
$event = new CakeEvent('Model.beforeValidate', $model, array($options));
|
|
list($event->break, $event->breakOn) = array(true, false);
|
|
$model->getEventManager()->dispatch($event);
|
|
if ($event->isStopped()) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
}
|