Experiments::create() - Code Metrics - Inspection of "Improved README.md" - webmarketingroi/optimizely-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 6fdb58...dee5cf )

by Oleg

created 2016-10-19 03:45 UTC

Experiments::create() A

↳ Parent: Experiments

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3.072

Importance

Changes

Metric	Value
cc	3
eloc	11
nc	3
nop	2
dl	0
loc	21
ccs	8
cts	10
cp	0.8
crap	3.072
rs	9.3142
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\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 array
     * @throws \Exception
     */
    public function listAll($projectId, $campaignId=null, $includeClassic=false, $page=1, $perPage=10)
    {
        if (empty($projectId) && empty($campaignId)) {
            throw new \Exception('Project ID or Campaign ID must be non-empty');
        }
        
        $response = $this->client->sendApiRequest('/experiments', 
                array(
                    'project_id'=>$projectId, 
                    'campaign_id'=>$campaignId,
                    'include_classic'=>$includeClassic,
                    'page'=>$page,
                    'per_page'=>$perPage
                ));
        
        $experiments = array();
        foreach ($response as $experimentInfo) {
            $experiment = new Experiment($experimentInfo);
            $experiments[] = $experiment;
        }
        
        return $experiments;
    }
    
    /**
     * Get metadata for a single Experiment.
     * @param integer $experimentId
     * @return Experiment 
     * @throws \Exception
     */
    public function get($experimentId)

    {
        if (!is_int($experimentId)) {
            throw new \Exception("Integer experiment ID expected, while got '$experimentId'");
        }
        
        $response = $this->client->sendApiRequest("/experiments/$experimentId");
        
        $experiment = new Experiment($response);
        
        return $experiment;
    }
    
    /**
     * 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.
     * @throws \Exception
     */
    public function getResults($experimentId, $baselineVariationId = null, $startTime = null, $endTime = null)
    {
        if (!is_int($experimentId)) {
            throw new \Exception("Integer experiment ID expected, while got '$experimentId'");
        }
        
        $response = $this->client->sendApiRequest("/experiments/$experimentId/results",
                array(
                    'baseline_variation_id' => $baselineVariationId,
                    'start_time' => $startTime,
                    'end_time' => $endTime
                ));
        
        $results = new ExperimentResults($response);
        
        return $results;
    }
    
    /**
     * Create an experiment in a Project.
     * @param Experiment $experiment
     * @param boolean $publish Set to true to make the the experiment live to the world upon creation.
     */
    public function create($experiment, $publish)
    {
        if (!($experiment instanceOf Experiment)) {
            throw new \Exception("Expected argument of type Experiment");
        }
        
        if (!is_bool($publish)) {
            throw new \Exception("Expected boolean publish argument");
        }
        
        $queryParams = array(
            'publish' => $publish,            
        );
        
        $postData = $experiment->toArray();
        
        $response = $this->client->sendApiRequest("/experiments", $queryParams, 'POST', 
                $postData, array(201));
        
        return new Experiment($response);
    }
    
    /**
     * Update an Experiment by ID
     * @param integer $experimentId
     * @param Experiment $experiment
     * @param boolean $overrideChanges If there are draft changes already in the experiment, you can override those changes by providing this query parameter.
     * @param boolean $publish Whether to publish the changes to the world.
     * @throws \Exception
     */
    public function update($experimentId, $experiment, $overrideChanges, $publish) 

    {
        if (!is_int($experimentId)) {
            throw new \Exception("Expected argument of type Experiment");
        }
        
        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(
            'override_changes' => $overrideChanges,
            'publish' => $publish
        );
        
        $postData = $experiment->toArray();
              
        $response = $this->client->sendApiRequest("/experiments/$experimentId", $queryParams, 'PATCH', 
                $postData, array(200));
        
        return new Experiment($response);
    }
    
    /**
     * Delete Experiment by ID
     * @param integer $experimentId
     * @throws \Exception
     */
    public function delete($experimentId) 
    {
        $response = $this->client->sendApiRequest("/experiments/$experimentId", array(), 'DELETE', 
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                array(), array(204));
    }
}



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\Resource\v2\Experiment;
10			use WebMarketingROI\OptimizelyPHP\Resource\v2\ExperimentResults;
11
12			/**
13			* Provides methods for working with Optimizely experiments.
14			*/
15			class Experiments
16			{
17			/**
18			* Optimizely API Client.
19			* @var WebMarketingROI\OptimizelyPHP\OptimizelyApiClient
20			*/
21			private $client;
22
23			/**
24			* Constructor.
25			*/
26	7		public function __construct($client)
27			{
28	7		$this->client = $client;
29	7		}
30
31			/**
32			* Get a list of all the experiments by Project or Campaign
33			* @param integer $projectId
34			* @param integer $campaignId
35			* @param boolean $includeClassic
36			* @param integer $page
37			* @param integer $perPage
38			* @return array
39			* @throws \Exception
40			*/
41	1		public function listAll($projectId, $campaignId=null, $includeClassic=false, $page=1, $perPage=10)
42			{
43	1		if (empty($projectId) && empty($campaignId)) {
44			throw new \Exception('Project ID or Campaign ID must be non-empty');
45			}
46
47	1		$response = $this->client->sendApiRequest('/experiments',
48			array(
49	1		'project_id'=>$projectId,
50	1		'campaign_id'=>$campaignId,
51	1		'include_classic'=>$includeClassic,
52	1		'page'=>$page,
53	1		'per_page'=>$perPage
54			));
55
56	1		$experiments = array();
57	1		foreach ($response as $experimentInfo) {
58	1		$experiment = new Experiment($experimentInfo);
59	1		$experiments[] = $experiment;
60			}
61
62	1		return $experiments;
63			}
64
65			/**
66			* Get metadata for a single Experiment.
67			* @param integer $experimentId
68			* @return Experiment
69			* @throws \Exception
70			*/
71	1	View Code Duplication	public function get($experimentId)
			0 ignored issues – show Duplication introduced 2016-10-19 01:09 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...
72			{
73	1		if (!is_int($experimentId)) {
74			throw new \Exception("Integer experiment ID expected, while got '$experimentId'");
75			}
76
77	1		$response = $this->client->sendApiRequest("/experiments/$experimentId");
78
79	1		$experiment = new Experiment($response);
80
81	1		return $experiment;
82			}
83
84			/**
85			* Get results for a single experiment
86			* @param integer $experimentId The id for the experiment you want results for
87			* @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.
88			* @param string $startTime The earliest time to count events in results. Defaults to the time that the experiment was first activated.
89			* @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.
90			* @throws \Exception
91			*/
92	1		public function getResults($experimentId, $baselineVariationId = null, $startTime = null, $endTime = null)
93			{
94	1		if (!is_int($experimentId)) {
95			throw new \Exception("Integer experiment ID expected, while got '$experimentId'");
96			}
97
98	1		$response = $this->client->sendApiRequest("/experiments/$experimentId/results",
99			array(
100	1		'baseline_variation_id' => $baselineVariationId,
101	1		'start_time' => $startTime,
102	1		'end_time' => $endTime
103			));
104
105	1		$results = new ExperimentResults($response);
106
107	1		return $results;
108			}
109
110			/**
111			* Create an experiment in a Project.
112			* @param Experiment $experiment
113			* @param boolean $publish Set to true to make the the experiment live to the world upon creation.
114			*/
115	1		public function create($experiment, $publish)
116			{
117	1		if (!($experiment instanceOf Experiment)) {
118			throw new \Exception("Expected argument of type Experiment");
119			}
120
121	1		if (!is_bool($publish)) {
122			throw new \Exception("Expected boolean publish argument");
123			}
124
125			$queryParams = array(
126	1		'publish' => $publish,
127			);
128
129	1		$postData = $experiment->toArray();
130
131	1		$response = $this->client->sendApiRequest("/experiments", $queryParams, 'POST',
132	1		$postData, array(201));
133
134	1		return new Experiment($response);
135			}
136
137			/**
138			* Update an Experiment by ID
139			* @param integer $experimentId
140			* @param Experiment $experiment
141			* @param boolean $overrideChanges If there are draft changes already in the experiment, you can override those changes by providing this query parameter.
142			* @param boolean $publish Whether to publish the changes to the world.
143			* @throws \Exception
144			*/
145	1	View Code Duplication	public function update($experimentId, $experiment, $overrideChanges, $publish)
			0 ignored issues – show Duplication introduced 2016-10-19 01:09 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...
146			{
147	1		if (!is_int($experimentId)) {
148			throw new \Exception("Expected argument of type Experiment");
149			}
150
151	1		if ($experimentId<0) {
152			throw new \Exception("Expected positive experiment ID argument");
153			}
154
155	1		if (!($experiment instanceOf Experiment)) {
156			throw new \Exception("Expected argument of type Experiment");
157			}
158
159			$queryParams = array(
160	1		'override_changes' => $overrideChanges,
161	1		'publish' => $publish
162			);
163
164	1		$postData = $experiment->toArray();
165
166	1		$response = $this->client->sendApiRequest("/experiments/$experimentId", $queryParams, 'PATCH',
167	1		$postData, array(200));
168
169	1		return new Experiment($response);
170			}
171
172			/**
173			* Delete Experiment by ID
174			* @param integer $experimentId
175			* @throws \Exception
176			*/
177	1		public function delete($experimentId)
178			{
179	1		$response = $this->client->sendApiRequest("/experiments/$experimentId", array(), 'DELETE',
			0 ignored issues – show Unused Code introduced 2016-10-19 01:09 UTC by Report Bug Copy Issue Report `$response` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
180	1		array(), array(204));
181	1		}
182			}
183
184

webmarketingroi / optimizely-php

Push — develop ( 6fdb58...dee5cf )

Experiments::create() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like