WebMarketingROI\OptimizelyPHP\Service\v2\Experiments

Complexity

Total Complexity

23

Size/Duplication

Total Lines	197
Duplicated Lines	14.21 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

88.31%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
C	listAll()	0	32	7
A	getResults()	0	19	2
A	get()	0	18	3
B	create()	0	25	5
B	update()	28	28	4
A	delete()	0	7	1

<?php
/**
 * @author Oleg Krivtsov <oleg@webmarketingroi.com.au>
 * @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) {

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.

            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)
    {
        if (!is_int($experimentId)) {
            throw new Exception("Integer experiment ID expected, while got '$experimentId'",
                    Exception::CODE_INVALID_ARG);
        }
        
        $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)) {

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.

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

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.

        
        $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) 

This method seems to be duplicated in your project.

    {
        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(
            '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;
    }
}