yoomoney / yookassa-sdk-validator
This is a developer tool for validating with YooMoney.
1.0.2
2024-10-17 09:43 UTC
Requires
- php: >=8.0.0
- ext-mbstring: *
Requires (Dev)
- ext-xml: *
- phpunit/phpunit: ^9.6
This package is auto-updated.
Last update: 2024-10-17 09:46:07 UTC
README
Библиотека для валидирования значений, присваиваемых полям объекта, через чтение атрибутов этих полей. Предназначена для использования в составе YooKassa API PHP Client Library
Требования
PHP 8.0 (и выше)
Установка
В консоли с помощью Composer
- Установите менеджер пакетов Composer.
- В консоли выполните команду:
composer require yoomoney/yookassa-sdk-validator
В файле composer.json своего проекта
- Добавьте строку
"yoomoney/yookassa-sdk-validator": "^1.0"
в список зависимостей вашего проекта в файле composer.json:... "require": { "php": ">=8.0", "yoomoney/yookassa-sdk-validator": "^1.0" ...
- Обновите зависимости проекта. В консоли перейдите в каталог, где лежит composer.json, и выполните команду:
composer install
- В коде вашего проекта подключите автозагрузку файлов валидатора:
require __DIR__ . '/vendor/autoload.php';
Начало работы
- Импортируйте нужные классы валидатора:
use YooKassa\Validator\Validator; use YooKassa\Validator\Constraints as Assert;
- Добавьте нужные правила для валидации полей класса через атрибуты:
#[Assert\NotBlank] #[Assert\Length(min: 2)] private string $title;
- Создайте экземпляр валидатора, передав в конструктор экземпляр класса, поля которого необходимо валидировать:
$validator = new Validator($this);
- Вызовите функцию validatePropertyValue(), передав в нее название валидируемого поля и значение:
$validator->validatePropertyValue('title', $title);
- Если значение не будет соответствовать правилам, заданным через атрибуты, валидатор выбросит исключение.
Чтобы пропустить проверку по какому-либо правилу или списку правил, заданному для поля класса, передайте массив с именами классов-правил в качестве параметра в функцию validatePropertyValue:
$validator->validatePropertyValue('title', $title, [Assert\Length::class]);
Чтобы получить список правил для конкретного поля, вызовите функцию getRulesByPropName(), передав в качестве параметра название поля:
$constraintsList = $validator->getRulesByPropName('title');
Example
<?php
require_once './vendor/autoload.php';
use YooKassa\Validator\Constraints as Assert;
use YooKassa\Validator\Validator;
class PaymentItemModel
{
#[Assert\Length(min: 5)]
private ?string $title;
private Validator $validator;
public function __construct()
{
$this->validator = new Validator($this);
}
public function setTitle(?string $title): PaymentItemModel
{
$this->validator->validatePropertyValue('title', $title);
$this->title = $title;
return $this;
}
}
$paymentItem = new PaymentItemModel();
try {
// Валидатор не выбросит исключение
$paymentItem->setTitle('title');
echo 'success!';
} catch (Exception $exception) {
var_dump($exception->getMessage());
}
try {
// Валидатор выбросит исключение
$paymentItem->setTitle('titl');
} catch (Exception $exception) {
echo 'fail!';
var_dump($exception->getMessage());
}