Error.php

<?php

namespace EasySwoole\Validate;

/**
 * 错误消息
 * Class Error
 * @revise : 2018-11-15 by eValor
 */
class Error
{
    private $field;

    private $fieldData;

    private $fieldAlias;

    private $errorRule;

    private $errorRuleMsg;

    private $errorRuleArg;

    /**
     * @var null|Validate
     */
    private $validate;

    private $ruleMsgMapping = [
        'activeUrl' => ':fieldName必须是可访问的网址',
        'alpha' => ':fieldName只能是字母',
        'alphaNum' => ':fieldName只能是字母和数字',
        'alphaDash' => ':fieldName只能是字母数字下划线和破折号',
        'between' => ':fieldName只能在 :arg0 - :arg1 之间',
        'bool' => ':fieldName只能是布尔值',
        'decimal' => ':fieldName只能是小数',
        'dateBefore' => ':fieldName必须在日期 :arg0 之前',
        'dateAfter' => ':fieldName必须在日期 :arg0 之后',
        'equal' => ':fieldName必须等于:arg0',
        'different' => ':fieldName必须不等于:arg0',
        'equalWithColumn' => ':fieldName必须等于:arg0的值',
        'differentWithColumn' => ':fieldName必须不等于:arg0的值',
        'float' => ':fieldName只能是浮点数',
        'func' => ':fieldName自定义验证失败',
        'inArray' => ':fieldName必须在 :arg0 范围内',
        'integer' => ':fieldName只能是整数',
        'isIp' => ':fieldName不是有效的IP地址',
        'notEmpty' => ':fieldName不能为空',
        'numeric' => ':fieldName只能是数字类型',
        'notInArray' => ':fieldName不能在 :arg0 范围内',
        'length' => ':fieldName的长度必须是:arg0',
        'mbLength' => ':fieldName的长度必须是:arg0',
        'lengthMax' => ':fieldName长度不能超过:arg0',
        'mbLengthMax' => ':fieldName长度不能超过:arg0',
        'lengthMin' => ':fieldName长度不能小于:arg0',
        'mbLengthMin' => ':fieldName长度不能小于:arg0',
        'betweenLen' => ':fieldName的长度只能在 :arg0 - :arg1 之间',
        'betweenMbLen' => ':fieldName的长度只能在 :arg0 - :arg1 之间',
        'money' => ':fieldName必须是合法的金额',
        'max' => ':fieldName的值不能大于:arg0',
        'min' => ':fieldName的值不能小于:arg0',
        'regex' => ':fieldName不符合指定规则',
        'allDigital' => ':fieldName只能由数字构成',
        'required' => ':fieldName必须填写',
        'timestamp' => ':fieldName必须是一个有效的时间戳',
        'timestampBeforeDate' => ':fieldName必须在:arg0之前',
        'timestampAfterDate' => ':fieldName必须在:arg0之后',
        'timestampBefore' => ':fieldName必须在:arg0之前',
        'timestampAfter' => ':fieldName必须在:arg0之后',
        'url' => ':fieldName必须是合法的网址',
        'allowFile' => ':fieldName文件扩展名必须在:arg0内',
        'allowFileType' => ':fieldName文件类型必须在:arg0内',
        'isArray' => ':fieldName类型必须为数组',
        'lessThanWithColumn' => ':fieldName必须小于:arg0的值',
        'greaterThanWithColumn' => ':fieldName必须大于:arg0的值',
        'isEmail' => ':fieldName必须是合法的邮箱',
    ];

    /**
     * Error constructor.
     * @param array $args
     */
    public function __construct(...$args)
    {
        $this->field = array_shift($args); // 字段名称
        $this->fieldData = array_shift($args); // 字段数据
        $this->fieldAlias = array_shift($args); // 字段别名
        $this->errorRule = array_shift($args); // 触发规则名
        $this->errorRuleMsg = array_shift($args); // 触发规则信息
        $this->errorRuleArg = array_shift($args); // 触发规则参数
        $this->validate = array_shift($args); // validate 实例
    }

    /**
     * 获取字段名称
     */
    public function getField(): string
    {
        return $this->field;
    }

    /**
     * 设置字段名称
     */
    public function setField(string $field): void
    {
        $this->field = $field;
    }

    /**
     * 获取字段数据
     * @return mixed
     */
    public function getFieldData()
    {
        return $this->fieldData;
    }

    /**
     * 设置字段数据
     * @param mixed $fieldData
     */
    public function setFieldData($fieldData): void
    {
        $this->fieldData = $fieldData;
    }

    /**
     * 获取字段别名
     * @return string
     */
    public function getFieldAlias(): ?string
    {
        return $this->fieldAlias;
    }

    /**
     * 设置字段别名
     */
    public function setFieldAlias(string $fieldAlias): void
    {
        $this->fieldAlias = $fieldAlias;
    }

    /**
     * 获取触发规则名
     */
    public function getErrorRule(): string
    {
        return $this->errorRule;
    }

    /**
     * 设置触发规则名
     */
    public function setErrorRule(string $errorRule): void
    {
        $this->errorRule = $errorRule;
    }

    /**
     * 获取触发规则消息
     */
    public function getErrorRuleMsg(): string
    {
        if (!empty($this->errorRuleMsg)) {
            return $this->errorRuleMsg;
        }

        return $this->parserRuleMsg();
    }

    function setRuleMsgMapping(array $mapping):Error
    {
        $this->ruleMsgMapping = $mapping;
        return $this;
    }

    /**
     * 设置触发规则消息
     */
    public function setErrorRuleMsg(string $errorRuleMsg): void
    {
        $this->errorRuleMsg = $errorRuleMsg;
    }

    /**
     * 获取触发规则参数
     * @return mixed
     */
    public function getErrorRuleArg()
    {
        return $this->errorRuleArg;
    }

    /**
     * 设置触发规则参数
     * @param mixed $errorRuleArg
     */
    public function setErrorRuleArg($errorRuleArg): void
    {
        $this->errorRuleArg = $errorRuleArg;
    }

    public function getValidate(): ?Validate
    {
        return $this->validate;
    }

    public function setValidate(?Validate $validate): void
    {
        $this->validate = $validate;
    }

    /**
     * 组装默认错误消息
     * @return mixed|string
     */
    private function parserRuleMsg()
    {
        $fieldName = empty($this->fieldAlias) ? $this->field : $this->fieldAlias;
        if (!isset($this->ruleMsgMapping[$this->errorRule])) {
            return "{$fieldName}参数错误";
        }
        $defaultErrorTpl = $this->ruleMsgMapping[$this->errorRule];
        $errorMsg = str_replace(':fieldName', $fieldName, $defaultErrorTpl);

        if (in_array($this->errorRule, ['equalWithColumn', 'differentWithColumn', 'lessThanWithColumn', 'greaterThanWithColumn'])) {
            $withFiledName = is_array($this->errorRuleArg) ? array_shift($this->errorRuleArg) : $this->errorRuleArg;
            if ($this->validate instanceof Validate) {
                $withFiledName = $this->validate->getColumn($withFiledName)['alias'] ?? "{$withFiledName}";
            }

            return str_replace(':arg0', $withFiledName, $errorMsg);
        }

        if (is_array($this->errorRuleArg)) {
            $arrayCheckFunc = ['inArray', 'notInArray', 'allowFile', 'allowFileType'];
            if (in_array($this->errorRule, $arrayCheckFunc)) {
                $arrayValue = array_shift($this->errorRuleArg);
                $errorMsg = str_replace(':arg0', '[' . implode(',', $arrayValue) . ']', $errorMsg);
            } else {
                foreach ($this->errorRuleArg as $index => $arg) {
                    $argValue = is_string($arg) ? $arg : json_encode($arg, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
                    $errorMsg = str_replace(":arg{$index}", $argValue, $errorMsg);
                }
            }
        } else {
            if (is_object($this->errorRuleArg)) {
                if (method_exists($this->errorRuleArg, '__toString')) {
                    return str_replace(':arg0', $this->errorRuleArg->__toString(), $errorMsg);
                }

                return str_replace(':arg0', 'OBJECT', $errorMsg);
            }
            $errorMsg = str_replace(':arg0', var_export($this->errorRuleArg, true), $errorMsg);
        }

        return $errorMsg;
    }

    /**
     * 返回错误消息
     */
    public function __toString(): string
    {
        return $this->getErrorRuleMsg();
    }
}