Experiments::delete() - Code Metrics - Inspection of "Fixing unit tests" - webmarketingroi/optimizely-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8b1dd2...f2d606 )

by Oleg

created 2018-05-14 07:06 UTC

Experiments::delete() A

↳ Parent: Experiments

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	1
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * @author Oleg Krivtsov <[email protected]>
 * @date 03 October 2016
 * @copyright (c) 2016, Web Marketing ROI
 */
namespace WebMarketingROI\OptimizelyPHP\Service\v2;

use WebMarketingROI\OptimizelyPHP\Exception;
use WebMarketingROI\OptimizelyPHP\Resource\v2\Experiment;
use WebMarketingROI\OptimizelyPHP\Resource\v2\ExperimentResults;

/**
 * Provides methods for working with Optimizely experiments.
 */
class Experiments 
{
    /**
     * Optimizely API Client.
     * @var WebMarketingROI\OptimizelyPHP\OptimizelyApiClient
     */
    private $client;
    
    /**
     * Constructor.
     */
    public function __construct($client)
    {
        $this->client = $client;
    }
    
    /**
     * Get a list of all the experiments by Project or Campaign
     * @param integer $projectId
     * @param integer $campaignId
     * @param boolean $includeClassic
     * @param integer $page
     * @param integer $perPage
     * @return Result
     * @throws Exception
     */
    public function listAll($projectId, $campaignId=null, $includeClassic=false, $page=1, $perPage=25)
    {
        if ($projectId==null && $campaignId==null) {

            throw new Exception('Project ID or Campaign ID must be non-null');
        }
        
        if ($page<0) {
            throw new Exception('Invalid page number passed');
        }
        
        if ($perPage<0 || $perPage>100) {
            throw new Exception('Invalid page size passed');
        }
        
        $result = $this->client->sendApiRequest('/experiments', 
                array(
                    'project_id'=>$projectId, 
                    'campaign_id'=>$campaignId,
                    'include_classic'=>$includeClassic,
                    'page'=>$page,
                    'per_page'=>$perPage
                ));
        
        $experiments = array();
        foreach ($result->getDecodedJsonData() as $experimentInfo) {
            $experiment = new Experiment($experimentInfo);
            $experiments[] = $experiment;
        }
        $result->setPayload($experiments);
        
        return $result;
    }
    
    /**
     * Get metadata for a single Experiment.
     * @param integer $experimentId
     * @return Result
     * @throws Exception
     */
    public function get($experimentId)
    {
        if (!is_int($experimentId)) {
            throw new Exception("Integer experiment ID expected, while got '$experimentId'",
                    Exception::CODE_INVALID_ARG);
        }
        
        if ($experimentId<0) {
            throw new Exception("A positive experiment ID expected");
        }
        
        $result = $this->client->sendApiRequest("/experiments/$experimentId");
        
        $experiment = new Experiment($result->getDecodedJsonData());
        $result->setPayload($experiment);
        
        return $result;
    }
    
    /**
     * Get results for a single experiment
     * @param integer $experimentId The id for the experiment you want results for
     * @param integer $baselineVariationId The id of the variation to use as the baseline to compare against other variations. Defaults to the first variation if not provided.
     * @param string $startTime The earliest time to count events in results. Defaults to the time that the experiment was first activated.
     * @param string $endTime The latest time to count events in results. Defaults to the time the experiment was last active or the current time if the experiment is still running.
     * @return Result
     * @throws Exception
     */
    public function getResults($experimentId, $baselineVariationId = null, $startTime = null, $endTime = null)
    {
        $result = $this->client->sendApiRequest("/experiments/$experimentId/results",
                array(
                    'baseline_variation_id' => $baselineVariationId,
                    'start_time' => $startTime,
                    'end_time' => $endTime
                ));
        
        $experimentResults = new ExperimentResults($result->getDecodedJsonData());
        $result->setPayload($experimentResults);
        
        return $result;
    }
    
    /**
     * Create an experiment in a Project.
     * @param Experiment $experiment
     * @param string $action Action to change the state of the Experiment. 
     * @return Result
     * @throw Exception
     */
    public function create($experiment, $action = null)
    {
        if (!($experiment instanceOf Experiment)) {
            throw new Exception("Expected argument of type Experiment",
                    Exception::CODE_INVALID_ARG);
        }
        
        if ($action!=null && !is_string($action)) {

            throw new Exception("Expected string or null action argument",
                    Exception::CODE_INVALID_ARG);
        }
        
        $queryParams = array();
        if ($action!=null) $queryParams['action'] = $action;

        
        $postData = $experiment->toArray();
        
        $result = $this->client->sendApiRequest("/experiments", $queryParams, 'POST', 
                $postData);
        
        $experiment = new Experiment($result->getDecodedJsonData());
        $result->setPayload($experiment);
        
        return $result;
    }
    
    /**
     * Update an Experiment by ID
     * @param integer $experimentId
     * @param Experiment $experiment
     * @param string $action Action to change the state of the Experiment. 
     * @return Result
     * @throws Exception
     */
    public function update($experimentId, $experiment, $action) 
    {
        if ($experimentId<0) {
            throw new Exception("Expected positive experiment ID argument");
        }
        
        if (!($experiment instanceOf Experiment)) {
            throw new Exception("Expected argument of type Experiment");
        }
        
        $queryParams = array(
            'action' => $action
        );
        
        $postData = $experiment->toArray();
              
        $result = $this->client->sendApiRequest("/experiments/$experimentId", $queryParams, 'PATCH', 
                $postData);
        
        $experiment = new Experiment($result->getDecodedJsonData());
        $result->setPayload($experiment);
        
        return $result;
    }
    
    /**
     * Delete Experiment by ID
     * @param integer $experimentId
     * @return Result
     * @throws Exception
     */
    public function delete($experimentId) 
    {
        $result = $this->client->sendApiRequest("/experiments/$experimentId", array(), 'DELETE', 
                array());
        
        return $result;
    }
}



1		<?php
2		/**
3		* @author Oleg Krivtsov <[email protected]>
4		* @date 03 October 2016
5		* @copyright (c) 2016, Web Marketing ROI
6		*/
7		namespace WebMarketingROI\OptimizelyPHP\Service\v2;
8
9		use WebMarketingROI\OptimizelyPHP\Exception;
10		use WebMarketingROI\OptimizelyPHP\Resource\v2\Experiment;
11		use WebMarketingROI\OptimizelyPHP\Resource\v2\ExperimentResults;
12
13		/**
14		* Provides methods for working with Optimizely experiments.
15		*/
16		class Experiments
17		{
18		/**
19		* Optimizely API Client.
20		* @var WebMarketingROI\OptimizelyPHP\OptimizelyApiClient
21		*/
22		private $client;
23
24		/**
25		* Constructor.
26		*/
27	12	public function __construct($client)
28		{
29	12	$this->client = $client;
30	12	}
31
32		/**
33		* Get a list of all the experiments by Project or Campaign
34		* @param integer $projectId
35		* @param integer $campaignId
36		* @param boolean $includeClassic
37		* @param integer $page
38		* @param integer $perPage
39		* @return Result
40		* @throws Exception
41		*/
42	4	public function listAll($projectId, $campaignId=null, $includeClassic=false, $page=1, $perPage=25)
43		{
44	4	if ($projectId==null && $campaignId==null) {
		0 ignored issues – show Bug Best Practice introduced 2016-11-16 06:35 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$campaignId` of type `integer\|null` against `null`; this is ambiguous if the integer can be zero. Consider using a strict comparison `===` instead. Loading history...
45	1	throw new Exception('Project ID or Campaign ID must be non-null');
46		}
47
48	3	if ($page<0) {
49	1	throw new Exception('Invalid page number passed');
50		}
51
52	2	if ($perPage<0 \|\| $perPage>100) {
53	1	throw new Exception('Invalid page size passed');
54		}
55
56	1	$result = $this->client->sendApiRequest('/experiments',
57		array(
58	1	'project_id'=>$projectId,
59	1	'campaign_id'=>$campaignId,
60	1	'include_classic'=>$includeClassic,
61	1	'page'=>$page,
62	1	'per_page'=>$perPage
63		));
64
65	1	$experiments = array();
66	1	foreach ($result->getDecodedJsonData() as $experimentInfo) {
67	1	$experiment = new Experiment($experimentInfo);
68	1	$experiments[] = $experiment;
69		}
70	1	$result->setPayload($experiments);
71
72	1	return $result;
73		}
74
75		/**
76		* Get metadata for a single Experiment.
77		* @param integer $experimentId
78		* @return Result
79		* @throws Exception
80		*/
81	3	public function get($experimentId)
82		{
83	3	if (!is_int($experimentId)) {
84	1	throw new Exception("Integer experiment ID expected, while got '$experimentId'",
85	1	Exception::CODE_INVALID_ARG);
86		}
87
88	2	if ($experimentId<0) {
89	1	throw new Exception("A positive experiment ID expected");
90		}
91
92	1	$result = $this->client->sendApiRequest("/experiments/$experimentId");
93
94	1	$experiment = new Experiment($result->getDecodedJsonData());
95	1	$result->setPayload($experiment);
96
97	1	return $result;
98		}
99
100		/**
101		* Get results for a single experiment
102		* @param integer $experimentId The id for the experiment you want results for
103		* @param integer $baselineVariationId The id of the variation to use as the baseline to compare against other variations. Defaults to the first variation if not provided.
104		* @param string $startTime The earliest time to count events in results. Defaults to the time that the experiment was first activated.
105		* @param string $endTime The latest time to count events in results. Defaults to the time the experiment was last active or the current time if the experiment is still running.
106		* @return Result
107		* @throws Exception
108		*/
109	1	public function getResults($experimentId, $baselineVariationId = null, $startTime = null, $endTime = null)
110		{
111	1	$result = $this->client->sendApiRequest("/experiments/$experimentId/results",
112		array(
113	1	'baseline_variation_id' => $baselineVariationId,
114	1	'start_time' => $startTime,
115	1	'end_time' => $endTime
116		));
117
118	1	$experimentResults = new ExperimentResults($result->getDecodedJsonData());
119	1	$result->setPayload($experimentResults);
120
121	1	return $result;
122		}
123
124		/**
125		* Create an experiment in a Project.
126		* @param Experiment $experiment
127		* @param string $action Action to change the state of the Experiment.
128		* @return Result
129		* @throw Exception
130		*/
131	1	public function create($experiment, $action = null)
132		{
133	1	if (!($experiment instanceOf Experiment)) {
134		throw new Exception("Expected argument of type Experiment",
135		Exception::CODE_INVALID_ARG);
136		}
137
138	1	if ($action!=null && !is_string($action)) {
		0 ignored issues – show Bug introduced 2017-05-08 05:41 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$action` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
139		throw new Exception("Expected string or null action argument",
140		Exception::CODE_INVALID_ARG);
141		}
142
143	1	$queryParams = array();
144	1	if ($action!=null) $queryParams['action'] = $action;
		0 ignored issues – show Bug introduced 2017-05-08 05:41 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$action` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
145
146	1	$postData = $experiment->toArray();
147
148	1	$result = $this->client->sendApiRequest("/experiments", $queryParams, 'POST',
149	1	$postData);
150
151	1	$experiment = new Experiment($result->getDecodedJsonData());
152	1	$result->setPayload($experiment);
153
154	1	return $result;
155		}
156
157		/**
158		* Update an Experiment by ID
159		* @param integer $experimentId
160		* @param Experiment $experiment
161		* @param string $action Action to change the state of the Experiment.
162		* @return Result
163		* @throws Exception
164		*/
165	1	public function update($experimentId, $experiment, $action)
166		{
167	1	if ($experimentId<0) {
168		throw new Exception("Expected positive experiment ID argument");
169		}
170
171	1	if (!($experiment instanceOf Experiment)) {
172		throw new Exception("Expected argument of type Experiment");
173		}
174
175		$queryParams = array(
176	1	'action' => $action
177		);
178
179	1	$postData = $experiment->toArray();
180
181	1	$result = $this->client->sendApiRequest("/experiments/$experimentId", $queryParams, 'PATCH',
182	1	$postData);
183
184	1	$experiment = new Experiment($result->getDecodedJsonData());
185	1	$result->setPayload($experiment);
186
187	1	return $result;
188		}
189
190		/**
191		* Delete Experiment by ID
192		* @param integer $experimentId
193		* @return Result
194		* @throws Exception
195		*/
196	1	public function delete($experimentId)
197		{
198	1	$result = $this->client->sendApiRequest("/experiments/$experimentId", array(), 'DELETE',
199	1	array());
200
201	1	return $result;
202		}
203		}
204
205

webmarketingroi / optimizely-php

Push — master ( 8b1dd2...f2d606 )

Experiments::delete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like