Checkout::validateMember() - Code Metrics - Inspection of "Merge pull request #463 from bummzack/issues/445-r..." - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0 ( 3b582e...88c91b )

by Mark

created 2016-03-22 10:27 UTC

Checkout::validateMember() A

↳ Parent: Checkout

Complexity

Conditions	4
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	4

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	11
ccs	4
cts	4
cp	1
rs	9.2
cc	4
eloc	6
nc	3
nop	1
crap	4

<?php

/**
 * Helper class for getting an order throught the checkout process
 */
class Checkout
{
    /**
     * 4 different membership schemes:
     *    1: creation disabled & membership not required
     *        no body can, or is required to, become a member at checkout.
     *    2: creation disabled & membership required
     *        only existing members can use checkout.
     *        (ideally the entire shop should be disabled in this case)
     *    3: creation enabled & membership required
     *        everyone must be, or become a member at checkout.
     *    4: creation enabled & membership not required (default)
     *        it is optional to be, or become a member at checkout.
     */

    public static function member_creation_enabled()
    {
        return CheckoutConfig::config()->member_creation_enabled;
    }

    public static function membership_required()
    {
        return CheckoutConfig::config()->membership_required;
    }

    public static function get($order = null)
    {
        if ($order === null) {
            $order = ShoppingCart::curr(); //roll back to current cart
        }
        if ($order->exists() && $order->isInDB()) {//check if order can go through checkout
            return new Checkout($order);
        }
        return false;
    }

    protected $order;

    protected $message;

    protected $type;

    public function __construct(Order $order)
    {
        $this->order = $order;
    }

    /**
     * Get stored message
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Get type of stored message
     *
     * @return string
     */
    public function getMessageType()
    {
        return $this->type;
    }

    /**
     * contact information
     */
    public function setContactDetails($email, $firstname, $surname)
    {
        $this->order->Email = $email;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->order->FirstName = $firstname;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->order->Surname = $surname;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->order->write();
    }

    //save / set up addresses
    public function setShippingAddress(Address $address)
    {
        $this->order->ShippingAddressID = $address->ID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (Member::currentUserID()) {
            $this->order->MemberID = Member::currentUserID();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        $this->order->write();
        $this->order->extend('onSetShippingAddress', $address);
        //update zones and userinfo
        ShopUserInfo::singleton()->setAddress($address);
        Zone::cache_zone_ids($address);
    }

    public function setBillingAddress(Address $address)
    {
        $this->order->BillingAddressID = $address->ID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (Member::currentUserID()) {
            $this->order->MemberID = Member::currentUserID();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        $this->order->write();
        $this->order->extend('onSetBillingAddress', $address);
    }

    /*
     * Get a dataobject of payment methods.
     */
    public function getPaymentMethods()
    {
        return GatewayInfo::get_supported_gateways();
    }

    /**
     * Set payment method
     */
    public function setPaymentMethod($paymentmethod)
    {
        $methods = $this->getPaymentMethods();
        if (!isset($methods[$paymentmethod])) {
            Session::set("Checkout.PaymentMethod", null);
            Session::clear("Checkout.PaymentMethod");
            return $this->error(_t("Checkout.NoPaymentMethod", "Payment method does not exist"));
        }
        Session::set("Checkout.PaymentMethod", $paymentmethod);
        return true;
    }

    /**
     * Gets the selected payment method from the session,
     * or the only available method, if there is only one.
     */
    public function getSelectedPaymentMethod($nice = false)
    {
        $methods = $this->getPaymentMethods();
        reset($methods);
        $method = count($methods) === 1 ? key($methods) : Session::get("Checkout.PaymentMethod");
        if ($nice && isset($methods[$method])) {
            $method = $methods[$method];
        }
        return $method;
    }

    /**
     * Checks if member (or not) is allowed, in accordance with configuration
     */
    public function validateMember($member)
    {
        if (!CheckoutConfig::config()->membership_required) {
            return true;
        }
        if (empty($member) || !($member instanceof Member)) {
            return false;
        }

        return true;
    }

    /**
     * Store a new error & return false;
     */
    protected function error($message)
    {
        $this->message($message, "bad");
        return false;
    }

    /**
     * Store a message to be fed back to user.
     *
     * @param string $message
     * @param string $type - good, bad, warning
     */
    protected function message($message, $type = "good")
    {
        $this->message = $message;
        $this->type = $type;
    }
}


1		<?php
2
3		/**
4		* Helper class for getting an order throught the checkout process
5		*/
6		class Checkout
7		{
8		/**
9		* 4 different membership schemes:
10		* 1: creation disabled & membership not required
11		* no body can, or is required to, become a member at checkout.
12		* 2: creation disabled & membership required
13		* only existing members can use checkout.
14		* (ideally the entire shop should be disabled in this case)
15		* 3: creation enabled & membership required
16		* everyone must be, or become a member at checkout.
17		* 4: creation enabled & membership not required (default)
18		* it is optional to be, or become a member at checkout.
19		*/
20
21	11	public static function member_creation_enabled()
22		{
23	11	return CheckoutConfig::config()->member_creation_enabled;
24		}
25
26	1	public static function membership_required()
27		{
28	1	return CheckoutConfig::config()->membership_required;
29		}
30
31	4	public static function get($order = null)
32		{
33	4	if ($order === null) {
34		$order = ShoppingCart::curr(); //roll back to current cart
35		}
36	4	if ($order->exists() && $order->isInDB()) {//check if order can go through checkout
37	4	return new Checkout($order);
38		}
39		return false;
40		}
41
42		protected $order;
43
44		protected $message;
45
46		protected $type;
47
48	14	public function __construct(Order $order)
49		{
50	14	$this->order = $order;
51	14	}
52
53		/**
54		* Get stored message
55		*
56		* @return string
57		*/
58	1	public function getMessage()
59		{
60	1	return $this->message;
61		}
62
63		/**
64		* Get type of stored message
65		*
66		* @return string
67		*/
68		public function getMessageType()
69		{
70		return $this->type;
71		}
72
73		/**
74		* contact information
75		*/
76		public function setContactDetails($email, $firstname, $surname)
77		{
78		$this->order->Email = $email;
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `Email` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
79		$this->order->FirstName = $firstname;
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `FirstName` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
80		$this->order->Surname = $surname;
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `Surname` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
81		$this->order->write();
82		}
83
84		//save / set up addresses
85	1	public function setShippingAddress(Address $address)
86		{
87	1	$this->order->ShippingAddressID = $address->ID;
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `ShippingAddressID` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
88	1	if (Member::currentUserID()) {
89	1	$this->order->MemberID = Member::currentUserID();
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `MemberID` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
90	1	}
91	1	$this->order->write();
92	1	$this->order->extend('onSetShippingAddress', $address);
93		//update zones and userinfo
94	1	ShopUserInfo::singleton()->setAddress($address);
95	1	Zone::cache_zone_ids($address);
96	1	}
97
98	1	public function setBillingAddress(Address $address)
99		{
100	1	$this->order->BillingAddressID = $address->ID;
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `BillingAddressID` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
101	1	if (Member::currentUserID()) {
102	1	$this->order->MemberID = Member::currentUserID();
		0 ignored issues – show Documentation introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `MemberID` does not exist on `object<Order>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
103	1	}
104	1	$this->order->write();
105	1	$this->order->extend('onSetBillingAddress', $address);
106	1	}
107
108		/*
109		* Get a dataobject of payment methods.
110		*/
111	5	public function getPaymentMethods()
112		{
113	5	return GatewayInfo::get_supported_gateways();
114		}
115
116		/**
117		* Set payment method
118		*/
119	5	public function setPaymentMethod($paymentmethod)
120		{
121	5	$methods = $this->getPaymentMethods();
122	5	if (!isset($methods[$paymentmethod])) {
123		Session::set("Checkout.PaymentMethod", null);
124		Session::clear("Checkout.PaymentMethod");
125		return $this->error(_t("Checkout.NoPaymentMethod", "Payment method does not exist"));
126		}
127	5	Session::set("Checkout.PaymentMethod", $paymentmethod);
128	5	return true;
129		}
130
131		/**
132		* Gets the selected payment method from the session,
133		* or the only available method, if there is only one.
134		*/
135	5	public function getSelectedPaymentMethod($nice = false)
136		{
137	5	$methods = $this->getPaymentMethods();
138	5	reset($methods);
139	5	$method = count($methods) === 1 ? key($methods) : Session::get("Checkout.PaymentMethod");
140	5	if ($nice && isset($methods[$method])) {
141		$method = $methods[$method];
142		}
143	5	return $method;
144		}
145
146		/**
147		* Checks if member (or not) is allowed, in accordance with configuration
148		*/
149	7	public function validateMember($member)
150		{
151	7	if (!CheckoutConfig::config()->membership_required) {
152	7	return true;
153		}
154		if (empty($member) \|\| !($member instanceof Member)) {
155		return false;
156		}
157
158	1	return true;
159		}
160	1
161		/**
162		* Store a new error & return false;
163	1	*/
164	1	protected function error($message)
165		{
166		$this->message($message, "bad");
167	1	return false;
168		}
169
170		/**
171		* Store a message to be fed back to user.
172		*
173		* @param string $message
174		* @param string $type - good, bad, warning
175		*/
176		protected function message($message, $type = "good")
177		{
178		$this->message = $message;
179		$this->type = $type;
180		}
181		}
182

silvershop / silvershop-core

Push — 2.0 ( 3b582e...88c91b )

Checkout::validateMember() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like