mirror of
https://github.com/elyby/php-tempmailbuster.git
synced 2024-11-08 13:42:37 +05:30
README translation
This commit is contained in:
parent
77b6d84c41
commit
33c1b6e3df
27
README.md
27
README.md
@ -4,10 +4,10 @@
|
|||||||
[![Software License][ico-license]](LICENSE.md)
|
[![Software License][ico-license]](LICENSE.md)
|
||||||
[![Total Downloads][ico-downloads]][link-downloads]
|
[![Total Downloads][ico-downloads]][link-downloads]
|
||||||
|
|
||||||
Расширяемый класс для блокировки E-mail адресов определённых доменов или организации белого списка допустимых доменов.
|
A package to protect your application from users with temp emails. Uses [Anti Tempmail Repo](https://github.com/elyby/anti-tempmail-repo) as a default blacklist source.
|
||||||
Реализует лоадер для загрузки и валидации по списку из [Anti Tempmail Repo](https://github.com/elyby/anti-tempmail-repo).
|
Provides an extendable class for E-mail validation based on black- or whitelist.
|
||||||
|
|
||||||
## Установка
|
## Intallation
|
||||||
|
|
||||||
Install the latest version with
|
Install the latest version with
|
||||||
|
|
||||||
@ -15,35 +15,34 @@ Install the latest version with
|
|||||||
$ composer require ely/php-tempmailbuster
|
$ composer require ely/php-tempmailbuster
|
||||||
```
|
```
|
||||||
|
|
||||||
## Использование
|
## Usage
|
||||||
|
|
||||||
Пример использования с применением стандартного лоадера:
|
Validation example using default loader:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
use Ely\TempMailBuster\Loader\AntiTempmailRepo;
|
use Ely\TempMailBuster\Loader\AntiTempmailRepo;
|
||||||
use Ely\TempMailBuster\Storage;
|
use Ely\TempMailBuster\Storage;
|
||||||
use Ely\TempMailBuster\Validator;
|
use Ely\TempMailBuster\Validator;
|
||||||
|
|
||||||
// Создаём класс лоадера
|
|
||||||
$loader = new AntiTempmailRepo();
|
$loader = new AntiTempmailRepo();
|
||||||
// Загружаем из него данные и передаём их в объект хранилища
|
// A storage can be instantiated by feeding it with an array of patterns:
|
||||||
$storage = new Storage($loader->load();
|
$storage = new Storage($loader->load());
|
||||||
// или используем статичный метод для работы с лоадерами
|
// or created from loader instance
|
||||||
$storage = Storage::fromLoader($loader);
|
$storage = Storage::fromLoader($loader);
|
||||||
// Создаём класс-валидатор
|
|
||||||
$validator = new Validator($storage);
|
$validator = new Validator($storage);
|
||||||
$validator->validate('team@ely.by'); // = true
|
$validator->validate('team@ely.by'); // = true
|
||||||
$validator->validate('hy42k@sendspamhere.com'); // = false
|
$validator->validate('hy42k@sendspamhere.com'); // = false
|
||||||
|
|
||||||
// Включаем режим белого списка
|
// Enable whitelisting mode
|
||||||
$validator->whitelistMode();
|
$validator->whitelistMode();
|
||||||
$validator->validate('team@ely.by'); // = false
|
$validator->validate('team@ely.by'); // = false
|
||||||
$validator->validate('hy42k@sendspamhere.com'); // = true
|
$validator->validate('hy42k@sendspamhere.com'); // = true
|
||||||
```
|
```
|
||||||
|
|
||||||
Конструктор принимает 2 аргумента: первичное и вторичное хранилище. Первичное хранилище работает в соответствии с
|
Validator constructor accepts 2 arguments: primary and secondary storages. Primary storage is used for validation based on current mode (whitelist/blacklist). Secondary storage (if provided) allows you to add exceptions from primary storage rules.
|
||||||
выбранным режимом работы библиотеки, а вторичное (если указано) позволяет добавить исключение из правил. Смотрите
|
|
||||||
больше примеров вызова метода `validate()` в [тестах](tests/ValidatorTest.php).
|
For more usage examples please take a look on [tests](tests/ValidatorTest.php).
|
||||||
|
|
||||||
## Change log
|
## Change log
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user