MembershipCheckoutComponent - Code Metrics - Inspection of "Merge pull request #435 from markguinn/patch-addre..." - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f2f332...64a02d )

by Mark

created 2016-02-26 12:18 UTC

MembershipCheckoutComponent B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	15

Test Coverage

Coverage

59.38%

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
wmc	31
c	4
b	1
f	0
lcom	2
cbo	15
dl	0
loc	148
ccs	57
cts	96
cp	0.5938
rs	8.9833

8 Methods

Rating	Name	Size	Complexity
A	__construct()	15	3
B	getFormFields()	14	5
A	getRequiredFields()	10	3
A	getPasswordField()	9	2
C	validateData()	33	8
A	getData()	10	2
C	setData()	30	7
A	setConfirmed()	6	1

<?php

/**
 * Provides:
 *    - member identifier, and password fields.
 *    - required membership fields
 *    - validating data
 *
 */
class MembershipCheckoutComponent extends CheckoutComponent
{
    protected $confirmed;

    protected $passwordvalidator;

    protected $dependson = array(
        'CustomerDetailsCheckoutComponent',
    );

    public function __construct($confirmed = true, $validator = null)
    {
        $this->confirmed = $confirmed;
        if (!$validator) {
            $this->passwordvalidator = Member::password_validator();
            if (!$this->passwordvalidator) {
                $this->passwordvalidator = PasswordValidator::create();
                $this->passwordvalidator->minLength(5);
                $this->passwordvalidator->characterStrength(
                    2,
                    array("lowercase", "uppercase", "digits", "punctuation")
                );
            }
        }
    }

    public function getFormFields(Order $order, Form $form = null)
    {
        $fields = FieldList::create();
        if (Member::currentUserID()) {
            return $fields;
        }
        $idfield = Member::config()->unique_identifier_field;
        if (!$order->{$idfield} && ($form && !$form->Fields()->fieldByName($idfield))) {
            //TODO: scaffold the correct id field type
            $fields->push(TextField::create($idfield, $idfield));
        }
        $fields->push($this->getPasswordField());
        return $fields;
    }

    public function getRequiredFields(Order $order)
    {
        if (Member::currentUserID() || !Checkout::membership_required()) {
            return array();
        }
        return array(
            Member::get_unique_identifier_field(),

            'Password',
        );
    }

    public function getPasswordField()
    {
        if ($this->confirmed) {
            //relies on fix: https://github.com/silverstripe/silverstripe-framework/pull/2757
            return ConfirmedPasswordField::create('Password', _t('CheckoutField.PASSWORD', 'Password'))
                ->setCanBeEmpty(!Checkout::membership_required());
        }
        return PasswordField::create('Password', _t('CheckoutField.PASSWORD', 'Password'));
    }

    public function validateData(Order $order, array $data)
    {
        if (Member::currentUserID()) {
            return;
        }
        $result = ValidationResult::create();
        if (Checkout::membership_required() || !empty($data['Password'])) {
            $member = Member::create($data);
            $idfield = Member::config()->unique_identifier_field;
            $idval = $data[$idfield];
            if (ShopMember::get_by_identifier($idval)) {
                // get localized field labels
                $fieldLabels = $member->fieldLabels(false);
                // if a localized value exists, use this for our error-message
                $fieldLabel = isset($fieldLabels[$idfield]) ? $fieldLabels[$idfield] : $idfield;
                $result->error(
                    sprintf(
                        _t("Checkout.MEMBEREXISTS", "A member already exists with the %s %s"),
                        $fieldLabel,
                        $idval
                    ),
                    $idval
                );
            }
            $passwordresult = $this->passwordvalidator->validate($data['Password'], $member);
            if (!$passwordresult->valid()) {
                $result->error($passwordresult->message(), "Password");
            }
        }
        if (!$result->valid()) {
            throw new ValidationException($result);
        }
    }

    public function getData(Order $order)
    {
        $data = array();

        if ($member = Member::currentUser()) {
            $idf = Member::config()->unique_identifier_field;
            $data[$idf] = $member->{$idf};
        }
        return $data;
    }

    /**
     * @throws ValidationException
     */
    public function setData(Order $order, array $data)
    {
        if (Member::currentUserID()) {
            return;
        }
        if (!Checkout::membership_required() && empty($data['Password'])) {
            return;
        }

        $factory = new ShopMemberFactory();
        $member = $factory->create($data);
        $member->write();
        $member->logIn();

        if ($order->BillingAddressID) {
<?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.");
        }
    }

}
            $address = $order->getBillingAddress();
            $address->MemberID = $member->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.");
        }
    }

}
            $address->write();
            $member->DefaultBillingAddressID = $order->BillingAddressID;
<?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 ($order->ShippingAddressID) {
<?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.");
        }
    }

}
            $address = $order->getShippingAddress();
            $address->MemberID = $member->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.");
        }
    }

}
            $address->write();
            $member->DefaultShippingAddressID = $order->ShippingAddressID;
<?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->isChanged()) {
            $member->write();
        }
    }

    public function setConfirmed($confirmed)
    {
        $this->confirmed = $confirmed;

        return $this;
    }
}


1		<?php
2
3		/**
4		* Provides:
5		* - member identifier, and password fields.
6		* - required membership fields
7		* - validating data
8		*
9		*/
10		class MembershipCheckoutComponent extends CheckoutComponent
11		{
12		protected $confirmed;
13
14		protected $passwordvalidator;
15
16		protected $dependson = array(
17		'CustomerDetailsCheckoutComponent',
18		);
19
20	1	public function __construct($confirmed = true, $validator = null)
21		{
22	1	$this->confirmed = $confirmed;
23	1	if (!$validator) {
24	1	$this->passwordvalidator = Member::password_validator();
25	1	if (!$this->passwordvalidator) {
26	1	$this->passwordvalidator = PasswordValidator::create();
27	1	$this->passwordvalidator->minLength(5);
28	1	$this->passwordvalidator->characterStrength(
29	1	2,
30	1	array("lowercase", "uppercase", "digits", "punctuation")
31	1	);
32	1	}
33	1	}
34	1	}
35
36	1	public function getFormFields(Order $order, Form $form = null)
37		{
38	1	$fields = FieldList::create();
39	1	if (Member::currentUserID()) {
40		return $fields;
41		}
42	1	$idfield = Member::config()->unique_identifier_field;
43	1	if (!$order->{$idfield} && ($form && !$form->Fields()->fieldByName($idfield))) {
44		//TODO: scaffold the correct id field type
45		$fields->push(TextField::create($idfield, $idfield));
46		}
47	1	$fields->push($this->getPasswordField());
48	1	return $fields;
49		}
50
51	1	public function getRequiredFields(Order $order)
52		{
53	1	if (Member::currentUserID() \|\| !Checkout::membership_required()) {
54	1	return array();
55		}
56		return array(
57		Member::get_unique_identifier_field(),
		0 ignored issues – show Deprecated Code introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The method `Member::get_unique_identifier_field()` has been deprecated with message: 4.0 Use the "Member.unique_identifier_field" config setting instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
58		'Password',
59		);
60		}
61
62	1	public function getPasswordField()
63		{
64	1	if ($this->confirmed) {
65		//relies on fix: https://github.com/silverstripe/silverstripe-framework/pull/2757
66	1	return ConfirmedPasswordField::create('Password', _t('CheckoutField.PASSWORD', 'Password'))
67	1	->setCanBeEmpty(!Checkout::membership_required());
68		}
69		return PasswordField::create('Password', _t('CheckoutField.PASSWORD', 'Password'));
70		}
71
72	1	public function validateData(Order $order, array $data)
73		{
74	1	if (Member::currentUserID()) {
75		return;
76		}
77	1	$result = ValidationResult::create();
78	1	if (Checkout::membership_required() \|\| !empty($data['Password'])) {
79	1	$member = Member::create($data);
80	1	$idfield = Member::config()->unique_identifier_field;
81	1	$idval = $data[$idfield];
82	1	if (ShopMember::get_by_identifier($idval)) {
83		// get localized field labels
84		$fieldLabels = $member->fieldLabels(false);
85		// if a localized value exists, use this for our error-message
86	1	$fieldLabel = isset($fieldLabels[$idfield]) ? $fieldLabels[$idfield] : $idfield;
87		$result->error(
88		sprintf(
89		_t("Checkout.MEMBEREXISTS", "A member already exists with the %s %s"),
90		$fieldLabel,
91		$idval
92		),
93		$idval
94		);
95		}
96	1	$passwordresult = $this->passwordvalidator->validate($data['Password'], $member);
97	1	if (!$passwordresult->valid()) {
98		$result->error($passwordresult->message(), "Password");
99		}
100	1	}
101	1	if (!$result->valid()) {
102		throw new ValidationException($result);
103		}
104	1	}
105
106	1	public function getData(Order $order)
107		{
108	1	$data = array();
109
110	1	if ($member = Member::currentUser()) {
111		$idf = Member::config()->unique_identifier_field;
112		$data[$idf] = $member->{$idf};
113		}
114	1	return $data;
115		}
116
117		/**
118		* @throws ValidationException
119		*/
120	1	public function setData(Order $order, array $data)
121		{
122	1	if (Member::currentUserID()) {
123		return;
124		}
125	1	if (!Checkout::membership_required() && empty($data['Password'])) {
126		return;
127		}
128
129	1	$factory = new ShopMemberFactory();
130	1	$member = $factory->create($data);
131	1	$member->write();
132	1	$member->logIn();
133
134	1	if ($order->BillingAddressID) {
		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 `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
135		$address = $order->getBillingAddress();
136		$address->MemberID = $member->ID;
		0 ignored issues – show Documentation introduced 2016-02-26 12:15 UTC by Report Bug Copy Issue Report The property `MemberID` does not exist on `object<Address>`. 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...
137		$address->write();
138		$member->DefaultBillingAddressID = $order->BillingAddressID;
		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...
139		}
140	1	if ($order->ShippingAddressID) {
		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 `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
141		$address = $order->getShippingAddress();
142		$address->MemberID = $member->ID;
		0 ignored issues – show Documentation introduced 2016-02-26 12:15 UTC by Report Bug Copy Issue Report The property `MemberID` does not exist on `object<Address>`. 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...
143		$address->write();
144		$member->DefaultShippingAddressID = $order->ShippingAddressID;
		0 ignored issues – show Bug introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The property `DefaultShippingAddressID` does not seem to exist. Did you mean `defaults`? 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... 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...
145		}
146	1	if ($member->isChanged()) {
147		$member->write();
148		}
149	1	}
150
151		public function setConfirmed($confirmed)
152		{
153		$this->confirmed = $confirmed;
154
155		return $this;
156		}
157		}
158

silvershop / silvershop-core

Push — master ( f2f332...64a02d )

MembershipCheckoutComponent B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like