SlotManager::query() - Code Metrics - Inspection of "Adding goals support to the PHP SDK" - acquia/lift-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Nick

created 2016-10-26 10:22 UTC

SlotManager::query() B

↳ Parent: SlotManager

Complexity

Conditions	4
Paths	8

Size

Total Lines	23
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	8.7972
c	0
b	0
f	0
cc	4
eloc	13
nc	8
nop	1

<?php

namespace Acquia\LiftClient\Manager;

use Acquia\LiftClient\Entity\Slot;
use GuzzleHttp\Psr7\Request;

class SlotManager extends ManagerBase
{
    /**
     * Get a list of slots.
     *
     * Example of how to structure the $options parameter:
     * <code>
     * $options = [
     *     'visible_on_page'  => 'http://localhost/blog/*',
     *     'status' => 'enabled',
     * ];
     * </code>
     *
     * @see http://docs.decision-api.acquia.com/#slots_get
     *
     * @param array $options
     *
     * @return \Acquia\LiftClient\Entity\Slot[]
     *
     * @throws \GuzzleHttp\Exception\RequestException
     */
    public function query($options = [])
    {
        $variables = $options + [
            'limit' => 1000,
            'start' => 0,
          ];

        $url = '/slots';
        $url .= isset($variables['visible_on_page']) ? "&visible_on_page={$variables['visible_on_page']}" : '';
        $url .= isset($variables['status']) ? "&status={$variables['status']}" : '';

        // Now make the request.
        $request = new Request('GET', $url);
        $data = $this->client->getResponseJson($request);

        // Get them as Slot objects
        $slots = [];
        foreach ($data as $dataItem) {
            $slots[] = new Slot($dataItem);
        }

        return $slots;
    }

    /**
     * Get a specific slot.
     *
     * Example of how to structure the $options parameter:
     *
     * @see http://docs.decision-api.acquia.com/#slots__slotId__get
     *
     * @param array $options
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Acquia\LiftClient\Entity\Slot
     *
     * @throws \GuzzleHttp\Exception\RequestException
     */
    public function get(

      $slotId
    ) {
        $url = "/slots/{$slotId}";

        // Now make the request.
        $request = new Request('GET', $url);
        $data = $this->client->getResponseJson($request);

        return new Slot($data);
    }

    /**
     * Add a slot.
     *
     * @param \Acquia\LiftClient\Entity\Slot $slot
     *
     * @return \Acquia\LiftClient\Entity\Slot
     *
     * @throws \GuzzleHttp\Exception\RequestException
     */
    public function add(

      Slot $slot
    ) {
        $body = $slot->json();
        $url = '/slots';
        $request = new Request('POST', $url, [], $body);
        $data = $this->client->getResponseJson($request);

        return new Slot($data);
    }

    /**
     * Deletes a slot by ID.
     *
     * @param string $id
     *
     * @return bool
     *              returns TRUE if successful
     *
     * @throws \GuzzleHttp\Exception\RequestException
     */
    public function delete(
      $id
    ) {
        $url = "/slots/{$id}";
        $this->client->delete($url);

        return true;
    }
}


1		<?php
2
3		namespace Acquia\LiftClient\Manager;
4
5		use Acquia\LiftClient\Entity\Slot;
6		use GuzzleHttp\Psr7\Request;
7
8		class SlotManager extends ManagerBase
9		{
10		/**
11		* Get a list of slots.
12		*
13		* Example of how to structure the $options parameter:
14		* <code>
15		* $options = [
16		* 'visible_on_page' => 'http://localhost/blog/*',
17		* 'status' => 'enabled',
18		* ];
19		* </code>
20		*
21		* @see http://docs.decision-api.acquia.com/#slots_get
22		*
23		* @param array $options
24		*
25		* @return \Acquia\LiftClient\Entity\Slot[]
26		*
27		* @throws \GuzzleHttp\Exception\RequestException
28		*/
29		public function query($options = [])
30		{
31		$variables = $options + [
32		'limit' => 1000,
33		'start' => 0,
34		];
35
36		$url = '/slots';
37		$url .= isset($variables['visible_on_page']) ? "&visible_on_page={$variables['visible_on_page']}" : '';
38		$url .= isset($variables['status']) ? "&status={$variables['status']}" : '';
39
40		// Now make the request.
41		$request = new Request('GET', $url);
42		$data = $this->client->getResponseJson($request);
43
44		// Get them as Slot objects
45		$slots = [];
46		foreach ($data as $dataItem) {
47		$slots[] = new Slot($dataItem);
48		}
49
50		return $slots;
51		}
52
53		/**
54		* Get a specific slot.
55		*
56		* Example of how to structure the $options parameter:
57		*
58		* @see http://docs.decision-api.acquia.com/#slots__slotId__get
59		*
60		* @param array $options
		0 ignored issues – show Bug introduced 2016-08-22 13:20 UTC by Report Bug Copy Issue Report There is no parameter named `$options`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
61		*
62		* @return \Acquia\LiftClient\Entity\Slot
63		*
64		* @throws \GuzzleHttp\Exception\RequestException
65		*/
66	View Code Duplication	public function get(
		1 ignored issue – show Duplication introduced 2016-08-22 13:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		$slotId
68		) {
69		$url = "/slots/{$slotId}";
70
71		// Now make the request.
72		$request = new Request('GET', $url);
73		$data = $this->client->getResponseJson($request);
74
75		return new Slot($data);
76		}
77
78		/**
79		* Add a slot.
80		*
81		* @param \Acquia\LiftClient\Entity\Slot $slot
82		*
83		* @return \Acquia\LiftClient\Entity\Slot
84		*
85		* @throws \GuzzleHttp\Exception\RequestException
86		*/
87	View Code Duplication	public function add(
		1 ignored issue – show Duplication introduced 2016-08-22 13:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
88		Slot $slot
89		) {
90		$body = $slot->json();
91		$url = '/slots';
92		$request = new Request('POST', $url, [], $body);
93		$data = $this->client->getResponseJson($request);
94
95		return new Slot($data);
96		}
97
98		/**
99		* Deletes a slot by ID.
100		*
101		* @param string $id
102		*
103		* @return bool
104		* returns TRUE if successful
105		*
106		* @throws \GuzzleHttp\Exception\RequestException
107		*/
108		public function delete(
109		$id
110		) {
111		$url = "/slots/{$id}";
112		$this->client->delete($url);
113
114		return true;
115		}
116		}
117

acquia / lift-sdk-php

Pull Request — master (#4)

SlotManager::query() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like