WebMarketingROI\OptimizelyPHP\Resource\v2\Event

Complexity

Total Complexity

55

Size/Duplication

Total Lines	325
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

91.8%

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
D	__construct()	0	25	18
A	toArray()	0	30	5
A	getApiName()	0	4	1
A	setApiName()	0	4	1
A	getArchived()	0	4	1
A	setArchived()	0	4	1
A	getCategory()	0	4	1
A	setCategory()	0	4	1
A	getCreated()	0	4	1
A	setCreated()	0	4	1
A	getLastModified()	0	4	1
A	setLastModified()	0	4	1
A	getDescription()	0	4	1
A	setDescription()	0	4	1
A	getEventFilter()	0	4	1
A	setEventFilter()	0	4	1
A	getEventType()	0	4	1
A	setEventType()	0	4	1
A	getKey()	0	4	1
A	setKey()	0	4	1
A	getName()	0	4	1
A	setName()	0	4	1
A	getPageId()	0	4	1
A	setPageId()	0	4	1
A	getProjectId()	0	4	1
A	setProjectId()	0	4	1
A	getId()	0	4	1
A	setId()	0	4	1
A	getIsClassic()	0	4	1
A	setIsClassic()	0	4	1
A	getIsEditable()	0	4	1
A	setIsEditable()	0	4	1
A	getConfig()	0	4	1
A	setConfig()	0	4	1

<?php
/**
 * @author Oleg Krivtsov <oleg@webmarketingroi.com.au>
 * @date 07 October 2016
 * @copyright (c) 2016, Web Marketing ROI
 */
namespace WebMarketingROI\OptimizelyPHP\Resource\v2;

use WebMarketingROI\OptimizelyPHP\Exception;
use WebMarketingROI\OptimizelyPHP\Resource\v2\EventFilter;
use WebMarketingROI\OptimizelyPHP\Resource\v2\InPageEventConfig;

/**
 * An Optimizely event.
 */
class Event
{
    /**
     * A machine readable name for this Event
     * @var string
     */
    private $apiName;
    
    /**
     * Whether or not this Event has been archived
     * @var boolean 
     */
    private $archived;
    
    /**
     * A category for this Event. Can be 'add_to_cart', 'save', 'search', 'share', 
     * 'purchase', 'convert', 'sign_up', 'subscribe' or 'other'.
     * @var type 
     */
    private $category;
    
    /**
     * Creation date for this Event
     * @var string 
     */
    private $created;
    
    /**
     * Last modified date.
     * @var string
     */
    private $lastModified;
    
    /**
     * A description for this Event
     * @var string 
     */
    private $description;
    
    /**
     * A filter object for this Event
     * @var EventFilter 
     */
    private $eventFilter;
    
    /**
     * The type of this Event. Can be custom, click, pageview, classic_custom, 
     * classic_click, classic_pageview, classic_engagement, classic_revenue, 
     * classic_mobile_tap, classic_mobile_view, classic_mobile_session, 
     * classic_mobile_session_length or classic_mobile_num_session
     * @var string 
     */
    private $eventType;
    
    /**
     * Unique string identifier for this event within the project.
     * @var string
     */
    private $key;
    
    /**
     * A human readable name for this Event
     * @var string 
     */
    private $name;
    
    /**
     * The Page ID associated with this Event
     * @var integer 
     */
    private $pageId;
    
    /**
     * The parent Project ID of this Event
     * @var integer 
     */
    private $projectId;
    
    /**
     * The unique identifier of the Event
     * @var integer
     */
    private $id;
    
    /**
     * Whether or not this Event is a classic Event
     * @var boolean 
     */
    private $isClassic;
    
    /**
     * Whether this Event may be edited
     * @var boolean 
     */
    private $isEditable;
    
    /**
     * 
     * @var InPageEventConfig
     */
    private $config;
    
    /**
     * Constructor.
     */
    public function __construct($options = array())
    {
        foreach ($options as $name=>$value) {
            switch ($name) {                
                case 'api_name': $this->setApiName($value); break;
                case 'archived': $this->setArchived($value); break;
                case 'category': $this->setCategory($value); break;
                case 'created': $this->setCreated($value); break;
                case 'last_modified': $this->setLastModified($value); break;
                case 'description': $this->setDescription($value); break;
                case 'event_filter': $this->setEventFilter(new EventFilter($value)); break;
                case 'event_type': $this->setEventType($value); break;
                case 'key': $this->setKey($value); break;
                case 'name': $this->setName($value); break;
                case 'page_id': $this->setPageId($value); break;
                case 'project_id': $this->setProjectId($value); break;
                case 'id': $this->setId($value); break;
                case 'is_classic': $this->setIsClassic($value); break;
                case 'is_editable': $this->setIsEditable($value); break;                
                case 'config': $this->setConfig(new InPageEventConfig($value)); break;
                default:
                    throw new Exception('Unknown option found in the Event entity: ' . $name);
            }
        }
    }
    
    /**
     * Returns this object as array.
     */
    public function toArray()
    {
        $options = array(
            'api_name' => $this->getApiName(),
            'archived' => $this->getArchived(),
            'category' => $this->getCategory(),
            'created' => $this->getCreated(),
            'last_modified' => $this->getLastModified(),
            'description' => $this->getDescription(),
            'event_filter' => $this->getEventFilter()?$this->getEventFilter()->toArray():null,
            'event_type' => $this->getEventType(),
            'key' => $this->getKey(),
            'name' => $this->getName(),
            'page_id' => $this->getPageId(),
            'project_id' => $this->getProjectId(),
            'id' => $this->getId(),
            'is_classic' => $this->getIsClassic(),
            'is_editable' => $this->getIsEditable(),            
            'config' => $this->getConfig()?$this->getConfig()->toArray():null,
        );
        
        // Remove options with empty values
        $cleanedOptions = array();
        foreach ($options as $name=>$value) {
            if ($value!==null)
                $cleanedOptions[$name] = $value;
        }
        
        return $cleanedOptions;
    }
    
    public function getApiName()
    {
        return $this->apiName;
    }
    
    public function setApiName($apiName)
    {
        $this->apiName = $apiName;
    }
    
    public function getArchived()
    {
        return $this->archived;
    }
    
    public function setArchived($archived)
    {
        $this->archived = $archived;
    }
    
    public function getCategory()
    {
        return $this->category;
    }
    
    public function setCategory($category)
    {
        $this->category = $category;
    }
    
    public function getCreated()
    {
        return $this->created;
    }
    
    public function setCreated($created)
    {
        $this->created = $created;
    }
    
    public function getLastModified()
    {
        return $this->lastModified;
    }
    
    public function setLastModified($lastModified)
    {
        $this->lastModified = $lastModified;
    }
        
    public function getDescription()
    {
        return $this->description;
    }
    
    public function setDescription($description)
    {
        $this->description = $description;
    }
        
    public function getEventFilter()
    {
        return $this->eventFilter;
    }
    
    public function setEventFilter($eventFilter)
    {
        $this->eventFilter = $eventFilter;
    }
    
    public function getEventType()
    {
        return $this->eventType;
    }
    
    public function setEventType($eventType)
    {
        $this->eventType = $eventType;
    }
    
    public function getKey()
    {
        return $this->key;
    }
    
    public function setKey($key)
    {
        $this->key = $key;
    }
    
    public function getName()
    {
        return $this->name;
    }
    
    public function setName($name)
    {
        $this->name = $name;
    }
    
    public function getPageId()
    {
        return $this->pageId;
    }
    
    public function setPageId($pageId)
    {
        $this->pageId = $pageId;
    }
    
    public function getProjectId()
    {
        return $this->projectId;
    }
    
    public function setProjectId($projectId)
    {
        $this->projectId = $projectId;
    }
    
    public function getId()
    {
        return $this->id;
    }
    
    public function setId($id)
    {
        $this->id = $id;
    }
    
    public function getIsClassic()
    {
        return $this->isClassic;
    }
    
    public function setIsClassic($isClassic)
    {
        $this->isClassic = $isClassic;
    }
    
    public function getIsEditable()
    {
        return $this->isEditable;
    }
    
    public function setIsEditable($isEditable)
    {
        $this->isEditable = $isEditable;
    }  
    
    public function getConfig()
    {
        return $this->config;
    }
    
    public function setConfig($config)
    {
        $this->config = $config;
    }  
}