mirror of
https://github.com/yiisoft/yii2.git
synced 2025-10-31 18:47:33 +08:00
87 lines
2.2 KiB
PHP
87 lines
2.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @link https://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license https://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\validators;
|
|
|
|
use yii\helpers\Json;
|
|
|
|
/**
|
|
* This class converts the attribute value(s) to string(s) and strip characters.
|
|
*
|
|
* @since 2.0.46
|
|
*/
|
|
class TrimValidator extends Validator
|
|
{
|
|
/**
|
|
* @var string The list of characters to strip, with `..` can specify a range of characters.
|
|
* For example, set '\/ ' to normalize path or namespace.
|
|
*/
|
|
public $chars;
|
|
/**
|
|
* @var bool Whether the filter should be skipped if an array input is given.
|
|
* If true and an array input is given, the filter will not be applied.
|
|
*/
|
|
public $skipOnArray = false;
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public $skipOnEmpty = false;
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function validateAttribute($model, $attribute)
|
|
{
|
|
$value = $model->$attribute;
|
|
if (!$this->skipOnArray || !is_array($value)) {
|
|
$model->$attribute = is_array($value)
|
|
? array_map([$this, 'trimValue'], $value)
|
|
: $this->trimValue($value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Converts given value to string and strips declared characters.
|
|
*
|
|
* @param mixed $value the value to strip
|
|
* @return string
|
|
*/
|
|
protected function trimValue($value)
|
|
{
|
|
return $this->isEmpty($value) ? '' : trim((string) $value, $this->chars ?: " \n\r\t\v\x00");
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function clientValidateAttribute($model, $attribute, $view)
|
|
{
|
|
if ($this->skipOnArray && is_array($model->$attribute)) {
|
|
return null;
|
|
}
|
|
|
|
ValidationAsset::register($view);
|
|
$options = $this->getClientOptions($model, $attribute);
|
|
|
|
return 'value = yii.validation.trim($form, attribute, ' . Json::htmlEncode($options) . ', value);';
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getClientOptions($model, $attribute)
|
|
{
|
|
return [
|
|
'skipOnArray' => (bool) $this->skipOnArray,
|
|
'skipOnEmpty' => (bool) $this->skipOnEmpty,
|
|
'chars' => $this->chars ?: false,
|
|
];
|
|
}
|
|
}
|