Gerrie\API\DataService\BaseDataService

Complexity

Total Complexity

10

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

92.31%

13 Methods

Rating	Name	Duplication	Size	Complexity
A	setName()	0	4	1
A	getName()	0	4	1
A	setConnector()	0	4	1
A	getConnector()	0	4	1
A	setConfig()	0	4	1
A	getConfig()	0	4	1
A	setQueryLimit()	0	4	1
A	getQueryLimit()	0	9	2
A	getHost()	0	6	1
	transformJsonResponse()	0	1	?
	getProjects()	0	1	?
	getChangesets()	0	1	?
	getVersion()	0	1	?

<?php
/**
 * This file is part of the Gerrie package.
 *
 * (c) Andreas Grunwald <andygrunwald@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gerrie\API\DataService;

abstract class BaseDataService implements DataServiceInterface
{

    /**
     * Name of data service
     *
     * @var string
     */
    private $name = '';

    /**
     * API connector like HTTP or SSH
     *
     * @var object
     */
    private $connector = null;

    /**
     * Query limit
     *
     * @var int|null
     */
    private $queryLimit = null;

    /**
     * Configuration
     *
     * @var array
     */
    protected $config = array();

    /**
     * Sets the name of the data service
     *
     * @param string $name Name of data service
     * @return void
     */
    public function setName($name)
    {
        $this->name = (string) $name;
    }

    /**
     * Returns the name of the data service
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Sets the API connector
     *
     * @param \Buzz\Browser|\Gerrie\Component\Connection\SSH $connector API connector like HTTP Client
     * @return void
     */
    public function setConnector($connector)
    {
        $this->connector = $connector;
    }

    /**
     * Returns the API connector
     *
     * @return \stdClass
     */
    public function getConnector()
    {
        return $this->connector;
    }

    /**
     * Sets the configuration
     *
     * @param array $config
     * @return void
     */
    public function setConfig(array $config)
    {
        $this->config = $config;
    }

    /**
     * Gets the configuration
     *
     * @return array
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Sets the query limit
     *
     * @param int $queryLimit The query limit for Gerrit querys
     * @return void
     */
    public function setQueryLimit($queryLimit)
    {
        $this->queryLimit = intval($queryLimit);
    }

    /**
     * Gets the query limit
     *
     * @return int
     */
    public function getQueryLimit()
    {

        if ($this->queryLimit === null) {
            $this->setQueryLimit($this->initQueryLimit());
        }

        return $this->queryLimit;
    }

    /**
     * Gets the Host
     *
     * @return string
     */
    public function getHost()
    {
        $config = $this->getConfig();

        return $config['host'];
    }

    /**
     * Transforms a JSON string into an array.
     * Regular, the json is the content from the response.
     *
     * @param string $json The json string
     * @return array|null
     */
    abstract public function transformJsonResponse($json);

    /**
     * Requests projects at the Gerrit server
     *
     * @return array|null
     */
    abstract public function getProjects();

    /**
     * Requests changesets at the Gerrit server.
     *
     * @param string $projectName The project name
     * @param string $resumeKey The key where the request will be resumed
     * @param integer $start Number of changesets which will be skipped
     * @throws \Exception
     */
    abstract public function getChangesets($projectName, $resumeKey = null, $start = 0);

    /**
     * Returns the version of the Gerrit server
     *
     * @link https://review.typo3.org/Documentation/cmd-version.html
     *
     * @return string
     */
    abstract public function getVersion();
}