Tvi\MonitorBundle\Check\etcd\Etcd\Check

Complexity

Total Complexity

5

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

90.91%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	createClient()	0	8	1
A	__construct()	0	14	1
A	getVersion()	0	5	1
A	check()	0	7	2

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Check\etcd\Etcd;

use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use JMS\Serializer\Annotation as JMS;
use Tvi\MonitorBundle\Check\CheckAbstract;
use ZendDiagnostics\Result\Failure;
use ZendDiagnostics\Result\Success;

/**

Missing short description in doc comment

 * @JMS\ExclusionPolicy("all")
 *
 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Check extends CheckAbstract
{
    /**

Missing short description in doc comment

     * @var string
     */
    protected $uri;

    /**

Missing short description in doc comment

     * @var string
     */
    protected $cert;

    /**

Missing short description in doc comment

     * @var string
     */
    protected $sslKey;

    /**

Missing short description in doc comment

     * @var string
     */
    protected $ca;

    /**

Missing short description in doc comment

     * @var boolean
     */
    protected $verify;

    /**

Missing short description in doc comment

     * @var ClientInterface
     */
    protected $client;

    /**

Missing short description in doc comment

Parameter $url should have a doc-comment as per coding-style.

     * @param string $uri

Missing parameter comment

Doc comment for parameter $uri does not match actual variable name $url

     * @param bool   $verify

Missing parameter comment

     * @param string $cert

Missing parameter comment

     * @param string $sslKey

Missing parameter comment

     * @param string $ca

Missing parameter comment

     *
     * @throws \Exception
     */
    public function __construct(
        $url = 'https://localhost:2379',
        $verify = false,
        $cert = '/etc/etcd/cert/client-etcd.crt',
        $sslKey = '/etc/etcd/cert/client-etcd.key',
        $ca = '/etc/etcd/cert/ca.crt')

The closing parenthesis of a multi-line function declaration must be on a new line

    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        $this->url = $url;

The property url does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->verify = $verify;
        $this->cert = $cert;
        $this->sslKey = $sslKey;
        $this->ca = $ca;

        $this->client = $this->createClient();
    }

    /**
     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function check()
    {
        try {
            $version = $this->getVersion();
            return new Success(null, json_decode($version, true));
        } catch (\Exception $e) {
            return new Failure($e->getMessage());
        }
    }

    /**

Missing short description in doc comment

     * @return ClientInterface
     * @throws \Exception
     */
    private function createClient()

Private method name "Check::createClient" must be prefixed with an underscore

    {
        return new Client([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'base_uri'   => $this->url,
            'verify'     => $this->verify,
            'exceptions' => true,
            'cert'       => $this->cert,
            'ssl_key'    => $this->sslKey,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**

Missing short description in doc comment

     * @return string
     */
    private function getVersion()

Private method name "Check::getVersion" must be prefixed with an underscore

    {
        $response = $this->client->get('/version');

        return $response->getBody().'';
    }
}