FondBot\Contracts\Channels\Driver

Complexity

Total Complexity

6

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

86.67%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	fill()	0	6	1
A	getRequest()	0	4	1
A	hasRequest()	0	4	1
A	getHeader()	0	4	1
A	getParameter()	0	4	1
	getConfig()	0	1	?
	verifyRequest()	0	1	?
	getUser()	0	1	?
	getMessage()	0	1	?
	sendMessage()	0	1	?
A	getHeaders()	0	4	1

<?php

declare(strict_types=1);

namespace FondBot\Contracts\Channels;

use FondBot\Helpers\Arr;
use FondBot\Traits\Loggable;
use FondBot\Contracts\Conversation\Keyboard;
use FondBot\Channels\Exceptions\InvalidChannelRequest;

abstract class Driver
{
    use Loggable;

    /** @var array */
    private $request = [];

    /** @var array */
    private $headers = [];

    /** @var array */
    private $parameters;

    /**
     * Set driver data.
     *
     * @param array $parameters
     * @param array $request
     * @param array $headers
     */
    public function fill(array $parameters, array $request = [], array $headers = []): void
    {
        $this->parameters = $parameters;
        $this->request = $request;
        $this->headers = $headers;
    }

    /**
     * Get request value.
     *
     * @param string|null $key
     *
     * @return mixed
     */
    public function getRequest(string $key = null)
    {
        return Arr::get($this->request, $key);
    }

    /**
     * If request has key.
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasRequest(string $key): bool
    {
        return Arr::has($this->request, [$key]);
    }

    /**
     * Get all headers.
     *
     * @return array
     */
    public function getHeaders(): array
    {
        return $this->headers;
    }

    /**
     * Get header.
     *
     * @param string $name
     *
     * @return mixed
     */
    public function getHeader(string $name)
    {
        return Arr::get($this->headers, $name);
    }

    /**
     * Get parameter value.
     *
     * @param string $name
     *
     * @return mixed
     */
    public function getParameter(string $name)
    {
        return Arr::get($this->parameters, $name);
    }

    /**
     * Configuration parameters.
     *
     * @return array
     */
    abstract public function getConfig(): array;

    /**
     * Verify incoming request data.
     *
     * @throws InvalidChannelRequest
     */
    abstract public function verifyRequest(): void;

    /**
     * Get user.
     *
     * @return User
     */
    abstract public function getUser(): User;

    /**
     * Get message received from sender.
     *
     * @return ReceivedMessage
     */
    abstract public function getMessage(): ReceivedMessage;

    /**
     * Send reply to participant.
     *
     * @param User          $sender
     * @param string        $text
     * @param Keyboard|null $keyboard
     *
     * @return OutgoingMessage
     */
    abstract public function sendMessage(User $sender, string $text, Keyboard $keyboard = null): OutgoingMessage;
}