EcommerceSiteTreeExtension::IsEcommercePage() - Code Metrics - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

EcommerceSiteTreeExtension::IsEcommercePage() A
last analyzed 2019-09-15 09:38 UTC

↳ Parent: EcommerceSiteTreeExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
nc	1
nop	0

<?php

/**
 * @description: adds a few functions to SiteTree to give each page
 * some e-commerce related functionality.
 *
 *
 *
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: extensions
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class EcommerceSiteTreeExtension extends SiteTreeExtension
{
    /**
     * returns the instance of EcommerceConfigAjax for use in templates.
     * In templates, it is used like this:
     * $AJAXDefinitions.TableID.
     *
     * @return EcommerceConfigAjax

     **/
    public function AJAXDefinitions()
    {
        return EcommerceConfigAjax::get_one($this->owner);

    }

    /**
     * @return EcommerceDBConfig
     **/
    public function EcomConfig()
    {
        return EcommerceDBConfig::current_ecommerce_db_config();
    }

    /**
     * tells us if the current page is part of e-commerce.
     *
     * @return bool
     */
    public function IsEcommercePage()
    {
        return false;
    }

    /**
     * Log in link.
     *
     * @return string
     */
    public function EcommerceLogInLink()
    {
        if ($this->owner->IsEcommercePage()) {
            $link = $this->owner->Link();
        } else {
            $link = $this->EcomConfig()->AccountPageLink();
        }

        return '/Security/login?BackURL='.urlencode($link);
    }

    public function augmentValidURLSegment()
    {
        if ($this->owner instanceof ProductGroup) {
            $checkForDuplicatesURLSegments = ProductGroup::get()
                ->filter(array('URLSegment' => $this->owner->URLSegment))
                ->exclude(array('ID' => $this->owner->ID));
            if ($checkForDuplicatesURLSegments->count() > 0) {
                return false;
            }
        }
    }
}

class EcommerceSiteTreeExtension_Controller extends Extension
{
    /**
     * standard SS method.
     * Runs before the Page::init method is called.
     */
    public function onBeforeInit()
    {
        //$this->secureHostSwitcher();

        Requirements::javascript(THIRDPARTY_DIR.'/jquery/jquery.js');
        //Requirements::block(THIRDPARTY_DIR."/jquery/jquery.js");
        //Requirements::javascript(Director::protocol()."ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js");
        //todo: check if we even need this (via ShoppingCartsRequirements.ss)
        if ($this->owner->dataRecord) {
            if (is_a($this->owner->dataRecord, Object::getCustomClass('Product')) || is_a($this->owner->dataRecord, Object::getCustomClass('ProductGroup'))) {

                Session::set('ContinueShoppingLink', $this->owner->Link());
            }
        }
    }

    /**
     * Standard SS method.
     * Runs after the Page::init method is called.
     */
    public function onAfterInit()
    {
        Requirements::javascript(EcommerceConfig::get('EcommerceConfigAjax', 'cart_js_file_location'));
        Requirements::javascript(EcommerceConfig::get('EcommerceConfigAjax', 'dialogue_js_file_location'));
        Requirements::themedCSS('Cart', 'ecommerce');
        Requirements::themedCSS('jquery.colorbox', 'ecommerce');
    }

    /**
     * This returns a link that displays just the cart, for use in ajax calls.
     *
     * @see ShoppingCart::showcart
     * It uses AjaxSimpleCart.ss to render the cart.
     *
     * @return string
     **/
    public function SimpleCartLinkAjax()
    {
        return EcommerceConfig::get('ShoppingCart_Controller', 'url_segment').'/showcart/?ajax=1';
    }

    /**
     * returns the current order.
     *
     * @return Order
     **/
    public function Cart()
    {
        return ShoppingCart::current_order();
    }

    /**
     * @return string (Link)
     */
    public function ContinueShoppingLink()
    {
        $link = Session::get('ContinueShoppingLink');
        if (!$link) {
            $link = Director::baseURL();
        }

        return $link;
    }


    /**
     * Is the page a secure page?
     *
     * @return true/false

     */
    public function isSecurePage()
    {
        return $this->owner->dataRecord instanceof CartPage;

    }

    /**
     * Redirect users if found on incorrect domain
     * Detects if $_GET['session'] is present, sets session
     * and redirects back to "clean URL"
     * Both _SECURE_URL and _STANDARD_URL must be defined,
     * and include protocol (http(s)://mydomain.com) with no trailing slash.
    *    protected function secureHostSwitcher()
    *     {
    *    if (!DEFINED('_SECURE_URL') || !DEFINED('_STANDARD_URL')) {
    *        return false;
    *    }
    *
    *    $protocol = Director::is_https() ? 'https://' : 'http://';
    *    $currentUrlFull = $protocol.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];
    *    list($currentUrlFull) = explode('#', $currentUrlFull);
    *    $currentUrlWithoutHost = $_SERVER['REQUEST_URI'];
    *    //remove fragment...just to keep it simple...
    *    list($currentUrlWithoutHost) = explode('#', $currentUrlWithoutHost);
    *    $sessionPartOfURL = '';
    *    $sessionID = session_id();
    *    if ($sessionID) {
    *        if (strpos($currentUrlWithoutHost, '?')) {
    *            $sessionPartOfURL .= '&';
    *        } else {
    *            $sessionPartOfURL = '?';
    *        }
    *        $sessionPartOfURL .= 'session='.$sessionID;
    *        $currentUrlWithoutHost .= $sessionPartOfURL;
    *    }
    *
    *        $isSecure = $this->owner->isSecurePage();
    *
    *    if ($isSecure && !preg_match('/^'.preg_quote(_SECURE_URL, '/').'/', $currentUrlFull)) {
    *        return $this->owner->redirect(_SECURE_URL.$currentUrlWithoutHost);
    *    } elseif (!$isSecure && !preg_match('/^'.preg_quote(_STANDARD_URL, '/').'/', $currentUrlFull)) {
    *        return $this->owner->redirect(_STANDARD_URL.$currentUrlWithoutHost);
    *    }
    *
    *    if ($sessionID = $this->owner->request->getVar('session')) {
    *        $currentUrlFull = str_replace('?session='.$sessionID, '', $currentUrlFull);
    *        $currentUrlFull = str_replace('&session='.$sessionID, '', $currentUrlFull);
    *        // force hard-coded session setting
    *        @session_write_close();
    *        @session_id($sessionID);
    *        @session_start();
    *        header('location: '.$currentUrlFull, 302);
    *        exit;
    *    }
    *}
    */
}


1			<?php
2
3			/**
4			* @description: adds a few functions to SiteTree to give each page
5			* some e-commerce related functionality.
6			*
7			*
8			*
9			* @authors: Nicolaas [at] Sunny Side Up .co.nz
10			* @package: ecommerce
11			* @sub-package: extensions
12			* @inspiration: Silverstripe Ltd, Jeremy
13			**/
14			class EcommerceSiteTreeExtension extends SiteTreeExtension
15			{
16			/**
17			* returns the instance of EcommerceConfigAjax for use in templates.
18			* In templates, it is used like this:
19			* $AJAXDefinitions.TableID.
20			*
21			* @return EcommerceConfigAjax
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the return type not be `EcommerceConfigAjaxDefinitions`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
22			**/
23			public function AJAXDefinitions()
24			{
25			return EcommerceConfigAjax::get_one($this->owner);
			0 ignored issues – show Compatibility introduced 2018-06-20 01:18 UTC by Report Bug Copy Issue Report `$this->owner` of type `object<SS_Object>` is not a sub-type of `object<DataObject>`. It seems like you assume a child class of the class `SS_Object` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
26			}
27
28			/**
29			* @return EcommerceDBConfig
30			**/
31			public function EcomConfig()
32			{
33			return EcommerceDBConfig::current_ecommerce_db_config();
34			}
35
36			/**
37			* tells us if the current page is part of e-commerce.
38			*
39			* @return bool
40			*/
41			public function IsEcommercePage()
42			{
43			return false;
44			}
45
46			/**
47			* Log in link.
48			*
49			* @return string
50			*/
51			public function EcommerceLogInLink()
52			{
53			if ($this->owner->IsEcommercePage()) {
54			$link = $this->owner->Link();
55			} else {
56			$link = $this->EcomConfig()->AccountPageLink();
57			}
58
59			return '/Security/login?BackURL='.urlencode($link);
60			}
61
62			public function augmentValidURLSegment()
63			{
64			if ($this->owner instanceof ProductGroup) {
65			$checkForDuplicatesURLSegments = ProductGroup::get()
66			->filter(array('URLSegment' => $this->owner->URLSegment))
67			->exclude(array('ID' => $this->owner->ID));
68			if ($checkForDuplicatesURLSegments->count() > 0) {
69			return false;
70			}
71			}
72			}
73			}
74
75			class EcommerceSiteTreeExtension_Controller extends Extension
76			{
77			/**
78			* standard SS method.
79			* Runs before the Page::init method is called.
80			*/
81			public function onBeforeInit()
82			{
83			//$this->secureHostSwitcher();
84
85			Requirements::javascript(THIRDPARTY_DIR.'/jquery/jquery.js');
86			//Requirements::block(THIRDPARTY_DIR."/jquery/jquery.js");
87			//Requirements::javascript(Director::protocol()."ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js");
88			//todo: check if we even need this (via ShoppingCartsRequirements.ss)
89			if ($this->owner->dataRecord) {
90			if (is_a($this->owner->dataRecord, Object::getCustomClass('Product')) \|\| is_a($this->owner->dataRecord, Object::getCustomClass('ProductGroup'))) {
			0 ignored issues – show Bug introduced 2018-06-20 01:18 UTC by Report Bug Copy Issue Report The property `dataRecord` does not seem to exist in `SS_Object`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
91			Session::set('ContinueShoppingLink', $this->owner->Link());
92			}
93			}
94			}
95
96			/**
97			* Standard SS method.
98			* Runs after the Page::init method is called.
99			*/
100			public function onAfterInit()
101			{
102			Requirements::javascript(EcommerceConfig::get('EcommerceConfigAjax', 'cart_js_file_location'));
103			Requirements::javascript(EcommerceConfig::get('EcommerceConfigAjax', 'dialogue_js_file_location'));
104			Requirements::themedCSS('Cart', 'ecommerce');
105			Requirements::themedCSS('jquery.colorbox', 'ecommerce');
106			}
107
108			/**
109			* This returns a link that displays just the cart, for use in ajax calls.
110			*
111			* @see ShoppingCart::showcart
112			* It uses AjaxSimpleCart.ss to render the cart.
113			*
114			* @return string
115			**/
116			public function SimpleCartLinkAjax()
117			{
118			return EcommerceConfig::get('ShoppingCart_Controller', 'url_segment').'/showcart/?ajax=1';
119			}
120
121			/**
122			* returns the current order.
123			*
124			* @return Order
125			**/
126			public function Cart()
127			{
128			return ShoppingCart::current_order();
129			}
130
131			/**
132			* @return string (Link)
133			*/
134			public function ContinueShoppingLink()
135			{
136			$link = Session::get('ContinueShoppingLink');
137			if (!$link) {
138			$link = Director::baseURL();
139			}
140
141			return $link;
142			}
143
144
145			/**
146			* Is the page a secure page?
147			*
148			* @return true/false
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The doc-type `true/false` could not be parsed: Unknown type name "true/false" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
149			*/
150			public function isSecurePage()
151			{
152			return $this->owner->dataRecord instanceof CartPage;
			0 ignored issues – show Bug introduced 2018-06-20 01:18 UTC by Report Bug Copy Issue Report The property `dataRecord` does not seem to exist in `SS_Object`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
153			}
154
155			/**
156			* Redirect users if found on incorrect domain
157			* Detects if $_GET['session'] is present, sets session
158			* and redirects back to "clean URL"
159			* Both _SECURE_URL and _STANDARD_URL must be defined,
160			* and include protocol (http(s)://mydomain.com) with no trailing slash.
161			* protected function secureHostSwitcher()
162			* {
163			* if (!DEFINED('_SECURE_URL') \|\| !DEFINED('_STANDARD_URL')) {
164			* return false;
165			* }
166			*
167			* $protocol = Director::is_https() ? 'https://' : 'http://';
168			* $currentUrlFull = $protocol.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];
169			* list($currentUrlFull) = explode('#', $currentUrlFull);
170			* $currentUrlWithoutHost = $_SERVER['REQUEST_URI'];
171			* //remove fragment...just to keep it simple...
172			* list($currentUrlWithoutHost) = explode('#', $currentUrlWithoutHost);
173			* $sessionPartOfURL = '';
174			* $sessionID = session_id();
175			* if ($sessionID) {
176			* if (strpos($currentUrlWithoutHost, '?')) {
177			* $sessionPartOfURL .= '&';
178			* } else {
179			* $sessionPartOfURL = '?';
180			* }
181			* $sessionPartOfURL .= 'session='.$sessionID;
182			* $currentUrlWithoutHost .= $sessionPartOfURL;
183			* }
184			*
185			* $isSecure = $this->owner->isSecurePage();
186			*
187			* if ($isSecure && !preg_match('/^'.preg_quote(_SECURE_URL, '/').'/', $currentUrlFull)) {
188			* return $this->owner->redirect(_SECURE_URL.$currentUrlWithoutHost);
189			* } elseif (!$isSecure && !preg_match('/^'.preg_quote(_STANDARD_URL, '/').'/', $currentUrlFull)) {
190			* return $this->owner->redirect(_STANDARD_URL.$currentUrlWithoutHost);
191			* }
192			*
193			* if ($sessionID = $this->owner->request->getVar('session')) {
194			* $currentUrlFull = str_replace('?session='.$sessionID, '', $currentUrlFull);
195			* $currentUrlFull = str_replace('&session='.$sessionID, '', $currentUrlFull);
196			* // force hard-coded session setting
197			* @session_write_close();
198			* @session_id($sessionID);
199			* @session_start();
200			* header('location: '.$currentUrlFull, 302);
201			* exit;
202			* }
203			*}
204			*/
205			}
206

sunnysideup / silverstripe-ecommerce

EcommerceSiteTreeExtension::IsEcommercePage() A last analyzed 2019-09-15 09:38 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EcommerceSiteTreeExtension::IsEcommercePage() A
last analyzed 2019-09-15 09:38 UTC