PamiModule\Service\Client

Complexity

Total Complexity

13

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getHost()	0	4	1
A	getConnection()	0	4	1
A	getParams()	0	4	1
A	setParams()	0	6	1
A	connect()	0	13	2
A	disconnect()	0	13	2
A	process()	0	14	2
A	sendAction()	0	21	2

<?php

namespace PamiModule\Service;

use ArrayObject;
use PAMI\Client\Impl\ClientImpl;
use PAMI\Message\OutgoingMessage;
use PAMI\Message\Response\ResponseMessage;
use Zend\EventManager\Event;
use Zend\EventManager\EventManagerAwareTrait;
use Zend\EventManager\EventsCapableInterface;

/**
 * Class Client.
 */
class Client implements EventsCapableInterface
{
    use EventManagerAwareTrait;

    /**
     * PAMI client.
     *
     * @var ClientImpl
     */
    protected $connection;
    /**
     * Custom parameters.
     *
     * @var array
     */
    protected $params = [];
    /**
     * @var string
     */
    protected $host;

    /**
     * Client constructor.
     *
     * @param string     $host
     * @param ClientImpl $pami PAMI client
     */
    public function __construct($host, ClientImpl $pami)
    {
        $this->host = $host;
        $this->connection = $pami;
    }

    /**
     * Return the hostname of the connection.
     *
     * @return string
     */
    public function getHost()
    {
        return $this->host;
    }

    /**
     * Return the PAMI client.
     *
     * @return ClientImpl
     */
    public function getConnection()
    {
        return $this->connection;
    }

    /**
     * Return the custom parameters.
     *
     * @return array
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Set the custom parameters.
     *
     * @param array $params Parameters
     *
     * @return $this
     */
    public function setParams(array $params)
    {
        $this->params = $params;

        return $this;
    }

    /**
     * Connect to the Asterisk Manager Interface.
     *
     * @throws \PAMI\Client\Exception\ClientException
     *
     * @return $this
     */
    public function connect()
    {
        $results = $this->getEventManager()->trigger(__FUNCTION__ . '.pre', $this);
        if ($results->stopped()) {
            return $this;
        }

        $this->connection->open();

        $this->getEventManager()->trigger(__FUNCTION__ . '.post', $this);

        return $this;
    }

    /**
     * Disconnect from the Asterisk Manager Interface.
     *
     * @return $this
     */
    public function disconnect()
    {
        $results = $this->getEventManager()->trigger(__FUNCTION__ . '.pre', $this);
        if ($results->stopped()) {
            return $this;
        }

        $this->connection->close();

        $this->getEventManager()->trigger(__FUNCTION__ . '.post', $this);

        return $this;
    }

    /**
     * Main processing loop. Also called from send(), you should call this in
     * your own application in order to continue reading events and responses
     * from ami.
     *
     * @return $this
     */
    public function process()
    {
        $results = $this->getEventManager()->trigger(__FUNCTION__ . '.pre', $this);

        if ($results->stopped()) {
            return $this;
        }

        $this->connection->process();

        $this->getEventManager()->trigger(__FUNCTION__ . '.post', $this);

        return $this;
    }

    /**
     * Sends a message to AMI.
     *
     * @param OutgoingMessage $action Action to send
     *
     * @throws \PAMI\Client\Exception\ClientException
     *
     * @return \PAMI\Message\Response\ResponseMessage
     */
    public function sendAction(OutgoingMessage $action)
    {
        $params = new ArrayObject(['action' => $action]);
        $event = new Event(__FUNCTION__ . '.pre', $this, $params);
        $results = $this->getEventManager()->triggerEventUntil(
            function ($response) {
                return $response instanceof ResponseMessage;
            },
            $event
        );
        if ($results->stopped()) {
            return $results->last();
        }

        $response = $this->connection->send($action);

        $params['response'] = $response;
        $this->getEventManager()->trigger(__FUNCTION__ . '.post', $this, $params);

        return $response;
    }
}