KumbiaPHP/KumbiaPHP

<?php
/**
 * KumbiaPHP web & app Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.
 *
 * @category   Kumbia
 * @package    Validate
 *
 * @copyright  Copyright (c) 2005 - 2023 KumbiaPHP Team (http://www.kumbiaphp.com)
 * @license    https://github.com/KumbiaPHP/KumbiaPHP/blob/master/LICENSE   New BSD License
 */

/**
 * Validate es una Clase que realiza validaciones Lógicas
 *
 * @category   KumbiaPHP
 * @package    validate
 */
require __DIR__.'/validations.php';
class Validate
{
    /**
     * Objeto a validar
     * @var Object
     */
    protected $obj = null;

    /**
     * Mensajes de error almacenados
     * @var array
     */
    protected $messages = array();

    /**
     * Reglas a a seguir para la validación
     * @var array
     */
    protected $rules = array();
    /**
     * Contructor
     * @param Object $obj Objeto a validar
     */

    /**
     * Almacena si la variable a validar es un objeto antes de convertirlo
     * @var boolean
     */
    protected $is_obj = false;

    /**
     * El parametro $rules debe contener esta forma
     *  array(
     *   'user' => //este es el nombre del campo
     *      array(
     *          'alpha' =>  //nombre del filtro
     *          null, //parametros pasados (en array o null si no se requiere)
     *          'lenght' => array('min'=>4, 'max'=>10)
     *      )
     * )
     * @param mixed $obj Objecto o Array a validar
     * @param array $rules Aray de reglas a validar
     */
    public function __construct($obj, Array $rules){
        $this->is_obj = is_object($obj);
        $this->obj = (object)$obj;
        $this->rules = $rules;
    }

    /**
     * Ejecuta las validaciones
     * @return bool Devuelve true si todo es válido
     */
    public function exec(){
        /*Recorrido por todos los campos*/
        foreach ($this->rules as $field => $fRule){
            $value = self::getValue($this->obj, $field);
            /*Regla individual para cada campo*/
            foreach ($fRule as $ruleName => $param) {
                $ruleName = self::getRuleName($ruleName, $param);
                $param =  self::getParams($param);
                /*Ignore the rule is starts with "#"*/
                if($ruleName[0] == '#') continue;
                /*Es una validación de modelo*/
                if($ruleName[0] == '@'){
                    $this->modelRule($ruleName, $param, $field);
                }elseif(!Validations::$ruleName($value, $param, $this->obj)){
                    $this->addError($param, $field, $ruleName);
                }
            }
        }
        /*Si no hay errores devuelve true*/
        return empty($this->messages);
    }

    /**
     * Ejecuta una validación de modelo
     * @param string $rule nombre de la regla
     * @param array $param
     * @param string $field Nombre del campo
     * @return bool
     */
    protected function modelRule($rule, $param, $field){
        if(!$this->is_obj){
            trigger_error('No se puede ejecutar una validacion de modelo en un array', E_USER_WARNING);
            return false;
        }
        $ruleName = ltrim($rule, '@');
        $obj = $this->obj;
        if(!method_exists($obj, $ruleName)){
            trigger_error('El metodo para la validacion no existe', E_USER_WARNING);
            return false;
        }
        if(!$obj->$ruleName($field, $param)){
           $this->addError($param, $field, $ruleName);
        }
        return true;
    }

    /**
     * Agrega un nuevo error
     * @param Array $param parametros
     * @param string $field Nombre del campo
     * @param string $rule Nombre de la regla
     */
    protected function addError(Array $param, $field, $rule){
         $this->messages[$field][] = $param['error'] ?? Validations::getMessage($rule);
    }

    /**
     * Devuelve el nombre de la regla
     * @param string $ruleName
     * @param mixed $param
     * @return string
     */
    protected static function getRuleName($ruleName, $param){
         /*Evita tener que colocar un null cuando no se pasan parametros*/
        return is_integer($ruleName) && is_string($param)?$param:$ruleName;
    }

    /**
     * Devuelve los parametros para la regla
     * @param mixed $param
     * @return array
     */
    protected static function getParams($param){
        return is_array($param)?$param:array();
    }

    /**
     * Devuelve el valor de un campo
     * @param object $obj
     * @param string $field
     * @return mixed
     */
    protected static function getValue($obj, $field){
        return !empty($obj->$field)?$obj->$field:null;//obtengo el valor del campo
    }

    /**
     * Devuelve los mensajes de error
     *
     */
    public function getMessages(){
        return $this->messages;
    }

    /**
     * Version de instancias para flush error
     */
    public function flash(){
        self::errorToFlash($this->getMessages());
    }

    public static function fail($obj, Array $rules){
        $val = new self($obj, $rules);
        return $val->exec() ? false:$val->getMessages();
    }

    /**
     * Envia los mensajes de error via flash
     * @param Array $error
     */
    public static function errorToFlash(Array $error){
        foreach ($error as $value)
            Flash::error($value);
    }
}