Omines\DirectAdmin\Context\BaseContext

Complexity

Total Complexity

4

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getConnection()	0	4	1
A	invokeApiGet()	0	4	1
A	invokeApiPost()	0	4	1

<?php

/*
 * DirectAdmin API Client
 * (c) Omines Internetbureau B.V. - https://omines.nl/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Omines\DirectAdmin\Context;

use Omines\DirectAdmin\DirectAdmin;

/**
 * Encapsulates a contextual connection to a DirectAdmin server.
 *
 * @author Niels Keurentjes <niels.keurentjes@omines.com>
 */
abstract class BaseContext
{
    /** @var DirectAdmin */
    private $connection;

    /**
     * Constructs the object.
     *
     * @param DirectAdmin $connection A prepared connection
     */
    public function __construct(DirectAdmin $connection)
    {
        $this->connection = $connection;
    }

    /**
     * Returns the internal connection wrapper.
     *
     * @return DirectAdmin
     */
    protected function getConnection()
    {
        return $this->connection;
    }

    /**
     * Invokes the DirectAdmin API via HTTP GET.
     *
     * @param string $command DirectAdmin API command to invoke
     * @param array $query Optional query parameters
     * @return array The parsed and validated response
     */
    public function invokeApiGet($command, $query = [])
    {
        return $this->connection->invokeApi('GET', $command, ['query' => $query]);
    }

    /**
     * Invokes the DirectAdmin API via HTTP POST.
     *
     * @param string $command DirectAdmin API command to invoke
     * @param array $postParameters Optional form parameters
     * @return array The parsed and validated response
     */
    public function invokeApiPost($command, $postParameters = [])
    {
        return $this->connection->invokeApi('POST', $command, ['form_params' => $postParameters]);
    }
}