Isign\Gateway\Query\Signing\Prepare

Complexity

Total Complexity

6

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getValidationConstraints()	0	11	1
A	getFields()	0	6	1
A	getMethod()	0	3	1
A	createResult()	0	3	1
A	getAction()	0	3	1
A	__construct()	0	8	1

<?php
namespace Dokobit\Gateway\Query\Signing;

use Dokobit\Gateway\Query\QueryInterface;
use Dokobit\Gateway\Result\ResultInterface;
use Dokobit\Gateway\Result\Signing\PrepareResult;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Prepare file for signing via API.
 * @see https://gateway-sandbox.dokobit.com/api/doc#_api_signing_prepare
 */
class Prepare implements QueryInterface
{
    /** @var string signing token */
    private $token;

    /** @var string signer id */
    private $signerId;

    /** @var string base64-encoded certificate */
    private $certificate;

    /**
     * @param string $token signing token
     * @param string $signerId signer id
     * @param string $certificate base64-encoded certificate
     */
    public function __construct(
        string $token,
        string $signerId,
        string $certificate
    ) {
        $this->token = $token;
        $this->signerId = $signerId;
        $this->certificate = $certificate;
    }

    /**
     * Field and values association used in query
     * @return array
     */
    public function getFields(): array
    {
        return [
            'token' => $this->token,
            'signer_id' => $this->signerId,
            'certificate' => $this->certificate,
        ];
    }

    /**
     * Validation constraints for request data validation
     * @return Assert\Collection
     */
    public function getValidationConstraints(): Assert\Collection
    {
        return new Assert\Collection([
            'token' => new Assert\Required([
                new Assert\NotBlank(),
            ]),
            'signer_id' => new Assert\Required([
                new Assert\NotBlank(),
            ]),
            'certificate' => new Assert\Optional([
                new Assert\NotBlank(),
            ]),
        ]);
    }

    /**
     * Result object for this query result
     * @return PrepareResult
     */
    public function createResult(): ResultInterface
    {
        return new PrepareResult();
    }

    /**
     * API action name, part of full API request url
     * @return string
     */
    public function getAction(): string
    {
        return "signing/{$this->token}/prepare";
    }

    /**
     * HTTP method to use
     * @return string
     */
    public function getMethod(): string
    {
        return QueryInterface::POST;
    }
}