AbstractEntryPoint::configureData() - Code Metrics - Inspection of "Fixed Interface Issue I put in" - MichaelJ2324/sugarcrm-restv10-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fd48c6...d6eea8 )

by Mike

created 2016-04-11 14:22 UTC

AbstractEntryPoint::configureData() A

↳ Parent: AbstractEntryPoint

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace SugarAPI\SDK\EntryPoint\Abstracts;


use SugarAPI\SDK\EntryPoint\Interfaces\EPInterface;
use SugarAPI\SDK\Exception\EntryPointException;
use SugarAPI\SDK\Request\POST;
use SugarAPI\SDK\Response\JSON as JSONResponse;

abstract class AbstractEntryPoint implements EPInterface {

    /**
     * Whether or not Authentication is Required
     * @var bool
     */
    protected $_AUTH_REQUIRED = true;

    /**
     * The default Module for the EntryPoint
     * @var string
     */
    protected $_MODULE;

    /**
     * The URL for the EntryPoint
     * - When configuring URL you define URL Parameters with $variables
     *      Examples:
     *          - Forecasts/$record_id
     * - $module Variable is a keyword to place the Module property into the URL
     *      Examples:
     *          - $module/$record
     * - Options property is used to replace variables in the order in which they are passed
     *
     * @var string
     */
    protected $_URL;

    /**
     * An array of Required Data properties that should be passed in the Request
     * @var array
     */
    protected $_REQUIRED_DATA;

    /**
     * The configured URL for the EntryPoint
     * @var string
     */
    protected $url;

    /**
     * The configured Module for the EntryPoint
     * @var string
     */
    protected $Module;

    /**
     * The passed in Options for the EntryPoint
     * - If $module variable is used in $_URL static property, then 1st option will be used as Module
     * @var array
     */
    protected $Options = array();

    /**
     * The data being passed to the API EntryPoint
     * @var mixed - array or Std Object
     */
    protected $Data;

    /**
     * The Request Object, used by the EntryPoint to submit the data
     * @var Object
     */
    protected $Request;

    /**
     * The Response Object, returned by the Request Object
     * @var Object
     */
    protected $Response;

    /**
     * Access Token for authentication
     * @var string
     */
    protected $accessToken;

    public function __construct($url,$options = array()){
        $this->url = $url;
        $this->Module = $this->_MODULE;

        if (!empty($options)) {
            if (empty($this->Module)) {
                if (strpos($this->_URL, '$module') !== FALSE) {
                    $this->module($options[0]);
                    array_shift($options);
                }
            }
            $this->options($options);
        }
        $this->setupRequest();
    }

    /**
     * @inheritdoc
     */
    public function module($module){
        $this->Module = $module;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function options(array $options){
        $this->Options = $options;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function data($data){
        $data = $this->configureData($data);
        $this->Data = $data;
        $this->Request->setBody($this->Data);
        return $this;
    }

    /**
     * Override function for configuring Default Values on some EntryPoints to allow for short hand
     * @param mixed $data
     * @return mixed
     */
    protected function configureData($data){
        return $data;
    }

    /**
     * @inheritdoc
     */
    public function execute(){
        if ($this->verifyURL() && $this->validateData()) {
            $this->configureURL();
            $this->Request->setURL($this->url);
            $this->Request->send();
            $this->setupResponse();
            //Trying to manage memory by closing Curl Resource
            $this->Request->close();
        }
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function authRequired() {
        return $this->_AUTH_REQUIRED;
    }

    /**
     * @inheritdoc
     */
    public function configureAuth($accessToken) {
        if ($this->authRequired()){
            $this->accessToken = $accessToken;
            $this->Request->addHeader('OAuth-Token', $accessToken);
        }
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getModule() {
        return $this->Module;
    }

    /**
     * @inheritdoc
     */
    public function getData(){
        return $this->Data;
    }

    /**
     * @inheritdoc
     */
    public function getURL(){
        return $this->url;
    }

    /**
     * @inheritdoc
     */
    public function getResponse(){
        return $this->Response;
    }

    /**
     * @inheritdoc
     */
    public function getRequest(){
        return $this->Request;
    }

    /**
     * Configures the URL, by updating any variable placeholders in the URL property on the EntryPoint
     * - Replaces $module with $this->Module
     * - Replaces all other variables starting with $, with options in the order they were given
     */
    protected function configureURL(){
        $url = $this->_URL;
        if (strpos($this->_URL,"$")!==FALSE) {
            if (count($this->Options) > 0 || !empty($this->Module)) {
                $urlParts = explode("/", $this->_URL);
                $o = 0;
                foreach ($urlParts as $key => $part) {
                    if (strpos($part, '$module') !== FALSE) {
                        if (isset($this->Module)) {
                            $urlParts[$key] = $this->Module;
                            continue;
                        } else {
                            if (isset($this->Options[$o])) {
                                $this->Module = $this->Options[$o];
                                array_shift($this->Options);
                            }
                        }
                    }
                    if (strpos($part, "$") !== FALSE) {
                        if (isset($this->Options[$o])) {
                            $urlParts[$key] = $this->Options[$o];
                            $o++;
                        }
                    }
                }
                $url = implode($urlParts,"/");
            }
        }
        $this->url = $this->url.$url;
    }

    /**
     * Setup the Request Object property, setup on initial Construct of EntryPoint
     */
    protected function setupRequest(){
        $this->Request = new POST();
    }

    /**
     * Setup the Response Object Property, not called until after Request Execution
     */
    protected function setupResponse(){
        $this->Response = new JSONResponse($this->Request->getResponse(),$this->Request->getCurlObject());
    }

    /**
     * Verify URL variables have been removed, and that valid number of options were passed.
     * @return bool
     * @throws EntryPointException
     */
    protected function verifyURL(){
        $urlVarCount = substr_count($this->_URL,"$");
        $optionCount = 0;
        if (!empty($this->Module)){
            $optionCount++;
        }
        $optionCount += count($this->Options);
        if ($urlVarCount!==$optionCount){
            if (empty($this->Module) && strpos($this->_URL,'$module')){
                throw new EntryPointException('Module is required for EntryPoint '.get_called_class());
            }else{
                throw new EntryPointException('EntryPoint URL ('.$this->_URL.') requires more parameters than passed.');
            }
        }else{
            return true;
        }
    }

    /**
     * Validate Required Data for the Request
     * @return bool
     * @throws EntryPointException
     */
    protected function validateData(){
        if (empty($this->_REQUIRED_DATA)||count($this->_REQUIRED_DATA)==0){
            return true;
        }else{
            $errors = array();
            foreach($this->_REQUIRED_DATA as $property){
                if (isset($this->Data[$property]) || $this->Data[$property]!==null){
                    continue;
                }else{
                    $errors[] = $property;
                }
            }
            if (count($errors)>0){
                throw new EntryPointException('EntryPoint requires specific properties in Request data. Missing the following '.implode($errors,","));
            }else{
                return true;
            }
        }
    }

}

1			<?php
2
3			namespace SugarAPI\SDK\EntryPoint\Abstracts;
4
5
6			use SugarAPI\SDK\EntryPoint\Interfaces\EPInterface;
7			use SugarAPI\SDK\Exception\EntryPointException;
8			use SugarAPI\SDK\Request\POST;
9			use SugarAPI\SDK\Response\JSON as JSONResponse;
10
11			abstract class AbstractEntryPoint implements EPInterface {
12
13			/**
14			* Whether or not Authentication is Required
15			* @var bool
16			*/
17			protected $_AUTH_REQUIRED = true;
18
19			/**
20			* The default Module for the EntryPoint
21			* @var string
22			*/
23			protected $_MODULE;
24
25			/**
26			* The URL for the EntryPoint
27			* - When configuring URL you define URL Parameters with $variables
28			* Examples:
29			* - Forecasts/$record_id
30			* - $module Variable is a keyword to place the Module property into the URL
31			* Examples:
32			* - $module/$record
33			* - Options property is used to replace variables in the order in which they are passed
34			*
35			* @var string
36			*/
37			protected $_URL;
38
39			/**
40			* An array of Required Data properties that should be passed in the Request
41			* @var array
42			*/
43			protected $_REQUIRED_DATA;
44
45			/**
46			* The configured URL for the EntryPoint
47			* @var string
48			*/
49			protected $url;
50
51			/**
52			* The configured Module for the EntryPoint
53			* @var string
54			*/
55			protected $Module;
56
57			/**
58			* The passed in Options for the EntryPoint
59			* - If $module variable is used in $_URL static property, then 1st option will be used as Module
60			* @var array
61			*/
62			protected $Options = array();
63
64			/**
65			* The data being passed to the API EntryPoint
66			* @var mixed - array or Std Object
67			*/
68			protected $Data;
69
70			/**
71			* The Request Object, used by the EntryPoint to submit the data
72			* @var Object
73			*/
74			protected $Request;
75
76			/**
77			* The Response Object, returned by the Request Object
78			* @var Object
79			*/
80			protected $Response;
81
82			/**
83			* Access Token for authentication
84			* @var string
85			*/
86			protected $accessToken;
87
88			public function __construct($url,$options = array()){
89			$this->url = $url;
90			$this->Module = $this->_MODULE;
91
92			if (!empty($options)) {
93			if (empty($this->Module)) {
94			if (strpos($this->_URL, '$module') !== FALSE) {
95			$this->module($options[0]);
96			array_shift($options);
97			}
98			}
99			$this->options($options);
100			}
101			$this->setupRequest();
102			}
103
104			/**
105			* @inheritdoc
106			*/
107			public function module($module){
108			$this->Module = $module;
109			return $this;
110			}
111
112			/**
113			* @inheritdoc
114			*/
115			public function options(array $options){
116			$this->Options = $options;
117			return $this;
118			}
119
120			/**
121			* @inheritdoc
122			*/
123			public function data($data){
124			$data = $this->configureData($data);
125			$this->Data = $data;
126			$this->Request->setBody($this->Data);
127			return $this;
128			}
129
130			/**
131			* Override function for configuring Default Values on some EntryPoints to allow for short hand
132			* @param mixed $data
133			* @return mixed
134			*/
135			protected function configureData($data){
136			return $data;
137			}
138
139			/**
140			* @inheritdoc
141			*/
142			public function execute(){
143			if ($this->verifyURL() && $this->validateData()) {
144			$this->configureURL();
145			$this->Request->setURL($this->url);
146			$this->Request->send();
147			$this->setupResponse();
148			//Trying to manage memory by closing Curl Resource
149			$this->Request->close();
150			}
151			return $this;
152			}
153
154			/**
155			* @inheritdoc
156			*/
157			public function authRequired() {
158			return $this->_AUTH_REQUIRED;
159			}
160
161			/**
162			* @inheritdoc
163			*/
164			public function configureAuth($accessToken) {
165			if ($this->authRequired()){
166			$this->accessToken = $accessToken;
167			$this->Request->addHeader('OAuth-Token', $accessToken);
168			}
169			return $this;
170			}
171
172			/**
173			* @inheritdoc
174			*/
175			public function getModule() {
176			return $this->Module;
177			}
178
179			/**
180			* @inheritdoc
181			*/
182			public function getData(){
183			return $this->Data;
184			}
185
186			/**
187			* @inheritdoc
188			*/
189			public function getURL(){
190			return $this->url;
191			}
192
193			/**
194			* @inheritdoc
195			*/
196			public function getResponse(){
197			return $this->Response;
198			}
199
200			/**
201			* @inheritdoc
202			*/
203			public function getRequest(){
204			return $this->Request;
205			}
206
207			/**
208			* Configures the URL, by updating any variable placeholders in the URL property on the EntryPoint
209			* - Replaces $module with $this->Module
210			* - Replaces all other variables starting with $, with options in the order they were given
211			*/
212			protected function configureURL(){
213			$url = $this->_URL;
214			if (strpos($this->_URL,"$")!==FALSE) {
215			if (count($this->Options) > 0 \|\| !empty($this->Module)) {
216			$urlParts = explode("/", $this->_URL);
217			$o = 0;
218			foreach ($urlParts as $key => $part) {
219			if (strpos($part, '$module') !== FALSE) {
220			if (isset($this->Module)) {
221			$urlParts[$key] = $this->Module;
222			continue;
223			} else {
224			if (isset($this->Options[$o])) {
225			$this->Module = $this->Options[$o];
226			array_shift($this->Options);
227			}
228			}
229			}
230			if (strpos($part, "$") !== FALSE) {
231			if (isset($this->Options[$o])) {
232			$urlParts[$key] = $this->Options[$o];
233			$o++;
234			}
235			}
236			}
237			$url = implode($urlParts,"/");
238			}
239			}
240			$this->url = $this->url.$url;
241			}
242
243			/**
244			* Setup the Request Object property, setup on initial Construct of EntryPoint
245			*/
246			protected function setupRequest(){
247			$this->Request = new POST();
248			}
249
250			/**
251			* Setup the Response Object Property, not called until after Request Execution
252			*/
253			protected function setupResponse(){
254			$this->Response = new JSONResponse($this->Request->getResponse(),$this->Request->getCurlObject());
255			}
256
257			/**
258			* Verify URL variables have been removed, and that valid number of options were passed.
259			* @return bool
260			* @throws EntryPointException
261			*/
262			protected function verifyURL(){
263			$urlVarCount = substr_count($this->_URL,"$");
264			$optionCount = 0;
265			if (!empty($this->Module)){
266			$optionCount++;
267			}
268			$optionCount += count($this->Options);
269			if ($urlVarCount!==$optionCount){
270			if (empty($this->Module) && strpos($this->_URL,'$module')){
271			throw new EntryPointException('Module is required for EntryPoint '.get_called_class());
272			}else{
273			throw new EntryPointException('EntryPoint URL ('.$this->_URL.') requires more parameters than passed.');
274			}
275			}else{
276			return true;
277			}
278			}
279
280			/**
281			* Validate Required Data for the Request
282			* @return bool
283			* @throws EntryPointException
284			*/
285			protected function validateData(){
286			if (empty($this->_REQUIRED_DATA)\|\|count($this->_REQUIRED_DATA)==0){
287			return true;
288			}else{
289			$errors = array();
290			foreach($this->_REQUIRED_DATA as $property){
291			if (isset($this->Data[$property]) \|\| $this->Data[$property]!==null){
292			continue;
293			}else{
294			$errors[] = $property;
295			}
296			}
297			if (count($errors)>0){
298			throw new EntryPointException('EntryPoint requires specific properties in Request data. Missing the following '.implode($errors,","));
299			}else{
300			return true;
301			}
302			}
303			}
304
305			}

MichaelJ2324 / sugarcrm-restv10-sdk

Push — master ( fd48c6...d6eea8 )

AbstractEntryPoint::configureData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like