Issues in StockControlPing.php - All Issues - Inspection of "Merge branch 'master' of https://github.com/sunnys..." - sunnysideup/silverstripe-ecommerce_stockcontrol - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b7c5b8...080abf )

by Nicolaas

created 2017-07-23 06:03 UTC

code/model/StockControlPing.php (1 issue)

Labels

Severity

Informational 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * connection with external stock setting systems
 * as an orderstep
 *
 *
 */


class StockControlPing_OrderStep extends OrderStep
{
    private static $db = array(
        "URLToPing" => "Varchar(200)",
        "Username" => "Varchar(30)",
        "Password" => "Varchar(30)"
    );

    private static $defaults = array(
        "CustomerCanEdit" => 0,
        "CustomerCanPay" => 0,
        "CustomerCanCancel" => 0,
        "Name" => "StockControlPing",
        "Code" => "STOCKCONTROLPING",
        "Sort" => 23,
        "ShowAsInProcessOrder" => 1
    );

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->addFieldToTab("Root.Main", new HeaderField("HowToSaveSubmittedOrder", _t("OrderStep.STOCKCONTROLPING", "Please enter details below"), 3), "URLToPing");
        return $fields;
    }

    /**
     * Can run this step once any items have been submitted.
     * @param DataObject - $order Order
     * @return Boolean
     **/
    public function initStep(Order $order)
    {
        return true;
    }

    /**
     * Add a member to the order - in case he / she is not a shop admin.
     * @param DataObject - $order Order
     * @return Boolean
     **/
    public function doStep(Order $order)
    {
        $stockControlPing = StockControlPing_OrderStatusLog::get()
            ->filter(array('OrderID' => $order->ID))->First();
        if (!$stockControlPing) {
            if ($this->Username && $this->Password) {
                $authentication = array(
                    CURLOPT_USERPWD =>
                    $this->Username.":".$this->Password
                );
            } else {
                $authentication = array();
            }
            $outcome = $this->curlGet(
                $this->URLToPing,
                array(
                    "id" => $order->ID,
                    "link" => urlencode($order->APILink())
                ),
                $authentication
            );
            //create record
            $obj = new StockControlPing_OrderStatusLog();
            $obj->OrderID = $order->ID;
            $obj->Note = $outcome;
            $obj->write();
        }
        return true;
    }

    /**
     * go to next step if order has been submitted.
     *@param DataObject - $order Order
     *@return DataObject | Null	(next step OrderStep)
     **/
    public function nextStep(Order $order)
    {
        if ($order->IsSubmitted()) {
            return parent::nextStep($order);
        }
        return null;
    }

    /**
     *
     * @return Boolean
     */
    protected function hasCustomerMessage()
    {
        return false;
    }

    /**
     * Explains the current order step.
     * @return String
     */
    protected function myDescription()
    {
        return _t("OrderStep.STOCKCONTROLPING_DESCRIPTION", "Sends a 'ping' to a third-party stock control system.");
    }


    /**
     * Send a GET requst using cURL
     * @source php.net
     * @param string $url to request
     * @param array $get values to send
     * @param array $options for cURL
     * @return string
     */
    protected function curlGet($url, array $get = null, array $options = array())
    {
        $defaults = array(
            CURLOPT_URL => $url. (strpos($url, '?') === false ? '?' : ''). http_build_query($get),
            CURLOPT_HEADER => 0,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_TIMEOUT => 4
        );
        $ch = curl_init();
        curl_setopt_array($ch, ($options + $defaults));
        if (! $result = curl_exec($ch)) {
            return curl_error($ch);
        }
        curl_close($ch);
        return $result;
    }
}


class StockControlPing_OrderStatusLog extends OrderStatusLog
{
    private static $singular_name = "Stock Control External Ping";
    public function i18n_singular_name()
    {
        return _t("OrderStatusLog.STOCKCONTROLEXTERNALPING", "Stock Control External Ping");
    }

    private static $plural_name = "Stock Control External Pings";
    public function i18n_plural_name()
    {
        return _t("OrderStatusLog.STOCKCONTROLEXTERNALPINGS", "Stock Control External Pings");
    }

    private static $defaults = array(
        'Title' => 'Ping External Service',
        'Note' => 'HTMLText',
        'InternalUseOnly' => 1
    );
}

/**
 *
 *
 *
 *
 *
 *	Example of POST:
 * 	function TestPost() {
 *
 *		$baseURL = Director::absoluteBaseURL();
 *
 *		// 1) My Personal Data
 *
 *		$className = 'StockControlPing_IncomingUpdate';
 *		$fields = array(
 *			'AllowPurchase' => 0,
 *			'InternalItemID' => "xxxx",
 * 			//below are optional (if you include ID then you leave out InternalItemID)k6
 *
 * 			//'BuyableClassName' => 'Product',
 * 			//'BuyableID' => 123,
 *		);
 *
 *		// 2) The Query
 *
 *		$url = "{$baseURL}/api/ecommerce/v1/{$className}.xml";
 *		$body = $fields;
 *		$c = curl_init($url);
 *		curl_setopt($c, CURLOPT_POST, true);
 *		curl_setopt($c, CURLOPT_POSTFIELDS, $body);
 *		curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
 *		$page = curl_exec($c);
 *		curl_close($c);
 *
 *		// 3) The XML Result
 *		return $page;
 *	}
 *
 *
 */
class StockControlPing_IncomingUpdate extends DataObject
{
    private static $api_access = array(
        'create' => array('InternalItemID', 'BuyableClassName', 'BuyableID', 'AllowPurchase'),
        'add' => array('InternalItemID', 'BuyableClassName', 'BuyableID', 'AllowPurchase'),
        'view' => array('InternalItemID', 'BuyableClassName', 'BuyableID', 'AllowPurchase')
    );

    private static $db = array(
        "InternalItemID" => "Varchar(30)",
        "BuyableClassName" => "Varchar(50)",
        "BuyableID" => "Int",
        "AllowPurchase" => "Boolean",
        "Actioned" => "Boolean"
    );

    private static $default_sort = "\"LastEdited\" DESC";

    private static $singular_name = "External Update to Product Availability";
    public function i18n_singular_name()
    {
        return _t("StockControlPing.EXTERNALUPDATETOPRODUCTAVAILABILITY", "External Update to Product Availability");
    }

    private static $plural_name = "External Updates to Product Availability";
    public function i18n_plural_name()
    {
        return _t("StockControlPing.EXTERNALUPDATESTOPRODUCTAVAILABILITY", "External Updates to Product Availability");
    }

    public function canView($member = null)
    {
        return $this->canDoAnything($member);
    }

    public function canCreate($member = null)
    {
        return $this->canDoAnything($member);
    }

    public function canEdit($member = null)
    {
        return false;
    }

    public function canDelete($member = null)
    {
        return false;
    }

    protected function canDoAnything($member = null)

    {
        $shopAdminCode = EcommerceConfig::get("EcommerceRole", "admin_permission_code");
        if (!Permission::check("ADMIN") && !Permission::check($shopAdminCode)) {
            Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
        }
        return true;
    }


    public function onAfterWrite()
    {
        parent::onAfterWrite();
        //TODO: move to findBuyable in Core Ecommerce Code!
        if (!$this->Actioned) {
            $internalItemID = Convert::raw2sql($this->InternalItemID);
            $id = intval($this->ID);
            $className = Convert::raw2sql($this->BuyableClassName);
            $allowPurchase = $this->AllowPurchase ? 1 : 0;
            if ($className) {
                if ($className && $id) {
                    $buyable = $className::get()->byID($id);
                } else {
                    $buyable = $className::get()->filter(array('InternalItemID' => $internalItemID))->First();
                }
            } else {
                $buyablesArray = EcommerceConfig::get($className = "EcommerceDBConfig", $identifier = "array_of_buyables");
                if (is_array($buyablesArray)) {
                    if (count($buyablesArray)) {
                        foreach ($buyablesArray as $className) {
                            $buyable = $className::get()->filter(array('InternalItemID' => $internalItemID))->First();
                            if ($buyable) {
                                break;
                            }
                        }
                    }
                }
            }
            if ($buyable) {
                if ($buyable->AllowPurchase =! $allowPurchase) {
                    $buyable->AllowPurchase = $allowPurchase;
                    if ($buyable instanceof SiteTree) {
                        $buyable->writeToStage('Stage');
                        $buyable->publish('Stage', 'Live');
                    } else {
                        $buyable->write();
                    }
                }
                $this->BuyableClassName = $buyable->ClassName;
                $this->BuyableID = $buyable->ID;
            }
            $this->Actioned = 1;
            $this->write();
        }
    }
}


1		<?php
2
3		/**
4		* connection with external stock setting systems
5		* as an orderstep
6		*
7		*
8		*/
9
10
11		class StockControlPing_OrderStep extends OrderStep
12		{
13		private static $db = array(
14		"URLToPing" => "Varchar(200)",
15		"Username" => "Varchar(30)",
16		"Password" => "Varchar(30)"
17		);
18
19		private static $defaults = array(
20		"CustomerCanEdit" => 0,
21		"CustomerCanPay" => 0,
22		"CustomerCanCancel" => 0,
23		"Name" => "StockControlPing",
24		"Code" => "STOCKCONTROLPING",
25		"Sort" => 23,
26		"ShowAsInProcessOrder" => 1
27		);
28
29		public function getCMSFields()
30		{
31		$fields = parent::getCMSFields();
32		$fields->addFieldToTab("Root.Main", new HeaderField("HowToSaveSubmittedOrder", _t("OrderStep.STOCKCONTROLPING", "Please enter details below"), 3), "URLToPing");
33		return $fields;
34		}
35
36		/**
37		* Can run this step once any items have been submitted.
38		* @param DataObject - $order Order
39		* @return Boolean
40		**/
41		public function initStep(Order $order)
42		{
43		return true;
44		}
45
46		/**
47		* Add a member to the order - in case he / she is not a shop admin.
48		* @param DataObject - $order Order
49		* @return Boolean
50		**/
51		public function doStep(Order $order)
52		{
53		$stockControlPing = StockControlPing_OrderStatusLog::get()
54		->filter(array('OrderID' => $order->ID))->First();
55		if (!$stockControlPing) {
56		if ($this->Username && $this->Password) {
57		$authentication = array(
58		CURLOPT_USERPWD =>
59		$this->Username.":".$this->Password
60		);
61		} else {
62		$authentication = array();
63		}
64		$outcome = $this->curlGet(
65		$this->URLToPing,
66		array(
67		"id" => $order->ID,
68		"link" => urlencode($order->APILink())
69		),
70		$authentication
71		);
72		//create record
73		$obj = new StockControlPing_OrderStatusLog();
74		$obj->OrderID = $order->ID;
75		$obj->Note = $outcome;
76		$obj->write();
77		}
78		return true;
79		}
80
81		/**
82		* go to next step if order has been submitted.
83		*@param DataObject - $order Order
84		*@return DataObject \| Null (next step OrderStep)
85		**/
86		public function nextStep(Order $order)
87		{
88		if ($order->IsSubmitted()) {
89		return parent::nextStep($order);
90		}
91		return null;
92		}
93
94		/**
95		*
96		* @return Boolean
97		*/
98		protected function hasCustomerMessage()
99		{
100		return false;
101		}
102
103		/**
104		* Explains the current order step.
105		* @return String
106		*/
107		protected function myDescription()
108		{
109		return _t("OrderStep.STOCKCONTROLPING_DESCRIPTION", "Sends a 'ping' to a third-party stock control system.");
110		}
111
112
113		/**
114		* Send a GET requst using cURL
115		* @source php.net
116		* @param string $url to request
117		* @param array $get values to send
118		* @param array $options for cURL
119		* @return string
120		*/
121		protected function curlGet($url, array $get = null, array $options = array())
122		{
123		$defaults = array(
124		CURLOPT_URL => $url. (strpos($url, '?') === false ? '?' : ''). http_build_query($get),
125		CURLOPT_HEADER => 0,
126		CURLOPT_RETURNTRANSFER => true,
127		CURLOPT_TIMEOUT => 4
128		);
129		$ch = curl_init();
130		curl_setopt_array($ch, ($options + $defaults));
131		if (! $result = curl_exec($ch)) {
132		return curl_error($ch);
133		}
134		curl_close($ch);
135		return $result;
136		}
137		}
138
139
140		class StockControlPing_OrderStatusLog extends OrderStatusLog
141		{
142		private static $singular_name = "Stock Control External Ping";
143		public function i18n_singular_name()
144		{
145		return _t("OrderStatusLog.STOCKCONTROLEXTERNALPING", "Stock Control External Ping");
146		}
147
148		private static $plural_name = "Stock Control External Pings";
149		public function i18n_plural_name()
150		{
151		return _t("OrderStatusLog.STOCKCONTROLEXTERNALPINGS", "Stock Control External Pings");
152		}
153
154		private static $defaults = array(
155		'Title' => 'Ping External Service',
156		'Note' => 'HTMLText',
157		'InternalUseOnly' => 1
158		);
159		}
160
161		/**
162		*
163		*
164		*
165		*
166		*
167		* Example of POST:
168		* function TestPost() {
169		*
170		* $baseURL = Director::absoluteBaseURL();
171		*
172		* // 1) My Personal Data
173		*
174		* $className = 'StockControlPing_IncomingUpdate';
175		* $fields = array(
176		* 'AllowPurchase' => 0,
177		* 'InternalItemID' => "xxxx",
178		* //below are optional (if you include ID then you leave out InternalItemID)k6
179		*
180		* //'BuyableClassName' => 'Product',
181		* //'BuyableID' => 123,
182		* );
183		*
184		* // 2) The Query
185		*
186		* $url = "{$baseURL}/api/ecommerce/v1/{$className}.xml";
187		* $body = $fields;
188		* $c = curl_init($url);
189		* curl_setopt($c, CURLOPT_POST, true);
190		* curl_setopt($c, CURLOPT_POSTFIELDS, $body);
191		* curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
192		* $page = curl_exec($c);
193		* curl_close($c);
194		*
195		* // 3) The XML Result
196		* return $page;
197		* }
198		*
199		*
200		*/
201		class StockControlPing_IncomingUpdate extends DataObject
202		{
203		private static $api_access = array(
204		'create' => array('InternalItemID', 'BuyableClassName', 'BuyableID', 'AllowPurchase'),
205		'add' => array('InternalItemID', 'BuyableClassName', 'BuyableID', 'AllowPurchase'),
206		'view' => array('InternalItemID', 'BuyableClassName', 'BuyableID', 'AllowPurchase')
207		);
208
209		private static $db = array(
210		"InternalItemID" => "Varchar(30)",
211		"BuyableClassName" => "Varchar(50)",
212		"BuyableID" => "Int",
213		"AllowPurchase" => "Boolean",
214		"Actioned" => "Boolean"
215		);
216
217		private static $default_sort = "\"LastEdited\" DESC";
218
219		private static $singular_name = "External Update to Product Availability";
220		public function i18n_singular_name()
221		{
222		return _t("StockControlPing.EXTERNALUPDATETOPRODUCTAVAILABILITY", "External Update to Product Availability");
223		}
224
225		private static $plural_name = "External Updates to Product Availability";
226		public function i18n_plural_name()
227		{
228		return _t("StockControlPing.EXTERNALUPDATESTOPRODUCTAVAILABILITY", "External Updates to Product Availability");
229		}
230
231		public function canView($member = null)
232		{
233		return $this->canDoAnything($member);
234		}
235
236		public function canCreate($member = null)
237		{
238		return $this->canDoAnything($member);
239		}
240
241		public function canEdit($member = null)
242		{
243		return false;
244		}
245
246		public function canDelete($member = null)
247		{
248		return false;
249		}
250
251	View Code Duplication	protected function canDoAnything($member = null)
		0 ignored issues – show Duplication introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
252		{
253		$shopAdminCode = EcommerceConfig::get("EcommerceRole", "admin_permission_code");
254		if (!Permission::check("ADMIN") && !Permission::check($shopAdminCode)) {
255		Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
256		}
257		return true;
258		}
259
260
261		public function onAfterWrite()
262		{
263		parent::onAfterWrite();
264		//TODO: move to findBuyable in Core Ecommerce Code!
265		if (!$this->Actioned) {
266		$internalItemID = Convert::raw2sql($this->InternalItemID);
267		$id = intval($this->ID);
268		$className = Convert::raw2sql($this->BuyableClassName);
269		$allowPurchase = $this->AllowPurchase ? 1 : 0;
270		if ($className) {
271		if ($className && $id) {
272		$buyable = $className::get()->byID($id);
273		} else {
274		$buyable = $className::get()->filter(array('InternalItemID' => $internalItemID))->First();
275		}
276		} else {
277		$buyablesArray = EcommerceConfig::get($className = "EcommerceDBConfig", $identifier = "array_of_buyables");
278		if (is_array($buyablesArray)) {
279		if (count($buyablesArray)) {
280		foreach ($buyablesArray as $className) {
281		$buyable = $className::get()->filter(array('InternalItemID' => $internalItemID))->First();
282		if ($buyable) {
283		break;
284		}
285		}
286		}
287		}
288		}
289		if ($buyable) {
290		if ($buyable->AllowPurchase =! $allowPurchase) {
291		$buyable->AllowPurchase = $allowPurchase;
292		if ($buyable instanceof SiteTree) {
293		$buyable->writeToStage('Stage');
294		$buyable->publish('Stage', 'Live');
295		} else {
296		$buyable->write();
297		}
298		}
299		$this->BuyableClassName = $buyable->ClassName;
300		$this->BuyableID = $buyable->ID;
301		}
302		$this->Actioned = 1;
303		$this->write();
304		}
305		}
306		}
307

sunnysideup / silverstripe-ecommerce_stockcontrol

Push — master ( b7c5b8...080abf )

code/model/StockControlPing.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like