Dokobit\Gateway\Query\Signing\CreateBatch

Complexity

Total Complexity

6

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	createResult()	0	3	1
A	__construct()	0	3	1
A	getValidationConstraints()	0	10	1
A	getFields()	0	7	1
A	getMethod()	0	3	1
A	getAction()	0	3	1

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

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

/**
 * Create a batch signing.
 * @see https://gateway-sandbox.dokobit.com/api/doc#_api_signing_createbatch
 */
class CreateBatch implements QueryInterface
{
    /** @var array an array of associative arrays of signing and signer tokens */
    private $signings;

    /**
     * @param array $signings an array of associative arrays of signing and signer tokens. Format:
     *       [
     *           ['token' => 'signingToken1', 'signer_token' => 'signerToken1'],
     *           ['token' => 'signingToken2', 'signer_token' => 'signerToken2'],
     *           ...
     *       ]
     */
    public function __construct(array $signings)
    {
        $this->signings = $signings;
    }

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

        return $return;
    }

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

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

    /**
     * API action name, part of full API request url
     * @return string
     */
    public function getAction(): string
    {
        return 'signing/createbatch';
    }

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