MethodPluginBase::getHeader() - Code Metrics - Inspection of "Add new methods to get data from the API. Update t..." - drupol/yaroc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f29513...87a330 )

by Pol

created 2016-12-03 22:32 UTC

MethodPluginBase::getHeader() A

↳ Parent: MethodPluginBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	3
cp	0
rs	10
cc	1
eloc	3
nc	1
nop	2
crap	2

<?php

namespace drupol\Yaroc\Plugin;

use Psr\Http\Message\ResponseInterface;

abstract class MethodPluginBase implements MethodPluginInterface {

  /**
   * The method name.
   */
  const METHOD = 'BASE';

  /**
   * The parameters.
   *
   * @var array
   */
  protected $parameters;

  /**
   * The API Key.
   *
   * @var string
   */
  protected $apiKey;

  /**
   * The API Version.
   *
   * @var int
   */
  protected $apiVersion;

  /**
   * {@inheritdoc}
   */
  public function getMethod() {
    return $this::METHOD;
  }

  /**
   * {@inheritdoc}
   */
  public function setParameters(array $parameters = array()) {
    $this->parameters = $parameters;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultParameters() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getParameters() {
    $defaultParameters = $this->getDefaultParameters();

    $params = [];
    foreach ($this->getDefaultParameters() as $key => $parameter) {
      if (in_array($this->getApiVersion(), (array) $defaultParameters[$key]['api'])) {
        if (!is_null($parameter['value'])) {
          $params[$key] = $parameter['value'];
        }
      }
    }

    foreach ((array) $this->parameters as $key => $value) {
      if (array_key_exists($key, $defaultParameters)) {
        if (in_array($this->getApiVersion(), (array) $defaultParameters[$key]['api'])) {
          $params[$key] = $value;
        }
      }
    }

    $this->setParameters($params);

    return array_filter([
      'jsonrpc' => '2.0',
      'id'      => $this->getRandomId(),
      'method'  => $this->getMethod(),
      'params'  => $params,
    ]);
  }

  /**
   * Get a random ID.
   *
   * @return string
   */
  public function getRandomId() {
    return $this->getMethod() . '_' . mt_rand(1, mt_getrandmax()) . '_' . str_replace('.', '', microtime(TRUE));
  }

  /**
   * {@inheritdoc}
   */
  public function setApiVersion($apiVersion) {
    $this->apiVersion = $apiVersion;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getApiVersion() {
    return $this->apiVersion;
  }

  /**
   * {@inheritdoc}
   */
  public function get(ResponseInterface $response, $key = NULL) {
    if ($content = $this->getContent($response)) {
      if (is_array($content)) {
        if ($key && isset($content[$key])) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
          return $content[$key];
        }
        if (is_null($key)) {
          return $content;
        }
      }
    }

    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getContent(ResponseInterface $response) {
    $body = $response->getBody()->__toString();
    if (strpos($response->getHeaderLine('Content-Type'), 'application/json') === 0) {
      $content = json_decode($body, true);
      if (JSON_ERROR_NONE === json_last_error()) {
        return $content;
      }
    }

    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getHeader(ResponseInterface $response, $name) {
    $headers = $response->getHeader($name);
    return array_shift($headers);
  }

}


1		<?php
2
3		namespace drupol\Yaroc\Plugin;
4
5		use Psr\Http\Message\ResponseInterface;
6
7		abstract class MethodPluginBase implements MethodPluginInterface {
8
9		/**
10		* The method name.
11		*/
12		const METHOD = 'BASE';
13
14		/**
15		* The parameters.
16		*
17		* @var array
18		*/
19		protected $parameters;
20
21		/**
22		* The API Key.
23		*
24		* @var string
25		*/
26		protected $apiKey;
27
28		/**
29		* The API Version.
30		*
31		* @var int
32		*/
33		protected $apiVersion;
34
35		/**
36		* {@inheritdoc}
37		*/
38	25	public function getMethod() {
39	25	return $this::METHOD;
40		}
41
42		/**
43		* {@inheritdoc}
44		*/
45	25	public function setParameters(array $parameters = array()) {
46	25	$this->parameters = $parameters;
47
48	25	return $this;
49		}
50
51		/**
52		* {@inheritdoc}
53		*/
54	13	public function getDefaultParameters() {
55	13	return [];
56		}
57
58		/**
59		* {@inheritdoc}
60		*/
61	25	public function getParameters() {
62	25	$defaultParameters = $this->getDefaultParameters();
63
64	25	$params = [];
65	25	foreach ($this->getDefaultParameters() as $key => $parameter) {
66	25	if (in_array($this->getApiVersion(), (array) $defaultParameters[$key]['api'])) {
67	25	if (!is_null($parameter['value'])) {
68	4	$params[$key] = $parameter['value'];
69	4	}
70	25	}
71	25	}
72
73	25	foreach ((array) $this->parameters as $key => $value) {
74	25	if (array_key_exists($key, $defaultParameters)) {
75	25	if (in_array($this->getApiVersion(), (array) $defaultParameters[$key]['api'])) {
76	25	$params[$key] = $value;
77	25	}
78	25	}
79	25	}
80
81	25	$this->setParameters($params);
82
83	25	return array_filter([
84	25	'jsonrpc' => '2.0',
85	25	'id' => $this->getRandomId(),
86	25	'method' => $this->getMethod(),
87	25	'params' => $params,
88	25	]);
89		}
90
91		/**
92		* Get a random ID.
93		*
94		* @return string
95		*/
96	13	public function getRandomId() {
97	13	return $this->getMethod() . '_' . mt_rand(1, mt_getrandmax()) . '_' . str_replace('.', '', microtime(TRUE));
98		}
99
100		/**
101		* {@inheritdoc}
102		*/
103	13	public function setApiVersion($apiVersion) {
104	13	$this->apiVersion = $apiVersion;
105
106	13	return $this;
107		}
108
109		/**
110		* {@inheritdoc}
111		*/
112	13	public function getApiVersion() {
113	13	return $this->apiVersion;
114		}
115
116		/**
117		* {@inheritdoc}
118		*/
119	13	public function get(ResponseInterface $response, $key = NULL) {
120	13	if ($content = $this->getContent($response)) {
121	13	if (is_array($content)) {
122	13	if ($key && isset($content[$key])) {
		0 ignored issues – show Bug Best Practice introduced 2016-12-03 22:35 UTC by Report Bug Copy Issue Report The expression `$key` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
123	13	return $content[$key];
124		}
125	12	if (is_null($key)) {
126	12	return $content;
127		}
128	12	}
129	12	}
130
131	12	return FALSE;
132		}
133
134		/**
135		* {@inheritdoc}
136		*/
137	13	public function getContent(ResponseInterface $response) {
138	13	$body = $response->getBody()->__toString();
139	13	if (strpos($response->getHeaderLine('Content-Type'), 'application/json') === 0) {
140	13	$content = json_decode($body, true);
141	13	if (JSON_ERROR_NONE === json_last_error()) {
142	13	return $content;
143		}
144		}
145
146		return FALSE;
147		}
148
149		/**
150		* {@inheritdoc}
151		*/
152		public function getHeader(ResponseInterface $response, $name) {
153		$headers = $response->getHeader($name);
154		return array_shift($headers);
155		}
156
157		}
158

drupol / yaroc

Push — master ( f29513...87a330 )

MethodPluginBase::getHeader() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like