retailcrm/url-validator

URL validator for RetailCRM

v1.1.0 2023-10-05 20:15 UTC

Requires

• php: >=7.3
• ext-json: *
• symfony/validator: ^3 || ^4 || ^5 || ^6

Requires (Dev)

• phpmd/phpmd: ^2.10
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.5.7
• squizlabs/php_codesniffer: 3.*

MIT

• RetailCRM

• validator
• retailCRM

README

RetailCRM URL Validator

This validator will help you validate system URLs in your project using symfony/validator.

Table of contents

• Requirements
• Installation
• Usage

Requirements

• PHP 7.3 and above
• PHP's JSON support
• symfony/validator

Installation

Follow those steps to install the library:

1. Download and install Composer package manager.
2. Install the library from the Packagist by executing this command:

composer require retailcrm/url-validator:"^1"

1. Include the autoloader if it's not included, or you didn't use Composer before.

require 'path/to/vendor/autoload.php';

Replace path/to/vendor/autoload.php with the correct path to Composer's autoload.php.

Usage

You have to use Symfony Validator to work with this library. Please refer to the official documentation for the symfony/validator to learn how to use it. If you want to use symfony/validator with Symfony framework - you should use this documentation.

After ensuring that you're using symfony/validator you can just append the @CrmUrl() annotation to the DTO entity field that contains system URL.

After that validator's validate call on this DTO will generate the proper violation messages for incorrect URLs.

Here's an example of the DTO (note: @Assert\Url() is optional):

<?php

namespace App\Dto;

use Symfony\Component\Validator\Constraints as Assert;
use RetailCrm\Validator\CrmUrl;

class Connection
{
    /**
     * @var string
     * 
     * @Assert\NotBlank()
     * @Assert\Url()
     * @CrmUrl()
     */
    public $apiUrl;
}

And below you can find a complete example of usage (note: it requires doctrine/annotations and symfony/cache to work properly).

Connection.php

<?php

namespace App;

use Symfony\Component\Validator\Constraints as Assert;
use RetailCrm\Validator\CrmUrl;

class Connection
{
    /**
     * @var string
     *
     * @Assert\NotBlank()
     * @Assert\Url()
     * @CrmUrl()
     */
    public $apiUrl;

    public function __construct(string $apiUrl)
    {
        $this->apiUrl = $apiUrl;
    }
}

app.php

namespace App;

// We assume that `app.php` is stored within a directory that is being autoloaded by Composer.
require __DIR__ . '/../vendor/autoload.php';

use Symfony\Component\Validator\Validation;

$validator = Validation::createValidatorBuilder()
    ->enableAnnotationMapping(true)
    ->addDefaultDoctrineAnnotationReader()
    ->getValidator();
$violations = $validator->validate(new Connection('https://test.retailcrm.pro'));

if (0 !== count($violations)) {
    foreach ($violations as $violation) {
        echo $violation->getMessage();
    }
}