CheckoutComponentConfig::validateData() - Code Metrics - AntonyThorpe/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

CheckoutComponentConfig::validateData() B
last analyzed 2023-07-10 20:11 UTC

↳ Parent: CheckoutComponentConfig

Complexity

Conditions	7
Paths	14

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	15
c	1
b	0
f	0
nc	14
nop	1
dl	0
loc	27
rs	8.8333

<?php

namespace SilverShop\Checkout;

use SilverShop\Checkout\Component\CheckoutComponent;
use SilverShop\Checkout\Component\CheckoutComponentNamespaced;
use SilverShop\Model\Order;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Forms\FieldList;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\ValidationException;
use SilverStripe\ORM\ValidationResult;

/**
 * @package shop
 */
class CheckoutComponentConfig
{
    use Injectable;

    protected $components;

    protected $order;

    protected $namespaced; //namespace fields according to their component

    public function __construct(Order $order, $namespaced = true)
    {
        $this->components = ArrayList::create();
        $this->order = $order;
        $this->namespaced = $namespaced;
    }

    public function getOrder()
    {
        return $this->order;
    }

    /**
     * @param CheckoutComponent $component
     * @param string            $insertBefore The class of the component to insert this one before
     * @return $this
     */
    public function addComponent(CheckoutComponent $component, $insertBefore = null)
    {
        if ($this->namespaced) {
            $component = CheckoutComponentNamespaced::create($component);
        }
        if ($insertBefore) {
            $existingItems = $this->getComponents();
            $this->components = ArrayList::create();
            $inserted = false;
            foreach ($existingItems as $existingItem) {
                if (!$inserted && $existingItem instanceof $insertBefore) {
                    $this->components->push($component);
                    $inserted = true;
                }
                $this->components->push($existingItem);
            }
            if (!$inserted) {
                $this->components->push($component);
            }
        } else {
            $this->getComponents()->push($component);
        }
        return $this;
    }

    /**
     * @return ArrayList Of CheckoutComponent
     */
    public function getComponents()
    {
        if (!$this->components) {
            $this->components = ArrayList::create();
        }
        return $this->components;
    }

    /**
     * Returns the first available component with the given class or interface.
     *
     * @param String ClassName
filter:
    dependency_paths: ["lib/*"]
     *
     * @return CheckoutComponent
     */
    public function getComponentByType($type)
    {
        foreach ($this->components as $component) {
            if ($this->namespaced) {
                if ($component->Proxy() instanceof $type) {
                    return $component->Proxy();
                }
            } else {
                if ($component instanceof $type) {
                    return $component;
                }
            }
        }
    }

    /**
     * Whether or not this config has a component that collects payment data.
     * Should be used to determine whether or not to add an additional payment step after checkout.
     * @return bool
     */
    public function hasComponentWithPaymentData()
    {
        foreach ($this->getComponents() as $component) {
            if ($component->providesPaymentData()) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get combined form fields
     *
     * @return FieldList namespaced fields
     */
    public function getFormFields()
    {
        $fields = FieldList::create();
        foreach ($this->getComponents() as $component) {
            if ($cfields = $component->getFormFields($this->order)) {
                $fields->merge($cfields);
            } else {
                user_error('getFields on  ' . get_class($component) . ' must return a FieldList');
            }
        }
        return $fields;
    }

    public function getRequiredFields()
    {
        $required = [];
        foreach ($this->getComponents() as $component) {
            $required = array_merge($required, $component->getRequiredFields($this->order));
        }
        return $required;
    }

    /**
     * Validate every component against given data.
     *
     * @param array $data data to validate
     *
     * @return boolean validation result
     * @throws ValidationException
     */
    public function validateData($data)
    {
        $result = ValidationResult::create();
        foreach ($this->getComponents() as $component) {
            try {
                $component->validateData($this->order, $this->dependantData($component, $data));
            } catch (ValidationException $e) {
                //transfer messages into a single result
                foreach ($e->getResult()->getMessages() as $code => $message) {
                    if (is_numeric($code)) {
                        $code = null;
                    }
                    if ($this->namespaced) {
                        $code = $component->namespaceFieldName($code);
                    }
                    $result->addError($message['message'], $code);
                }
            }
        }

        $this->order->extend('onValidateDataOnCheckout', $result);

        if (!$result->isValid()) {
            throw new ValidationException($result);
        }

        return true;
    }

    /**
     * Get combined data
     *
     * @return array map of field names to data values
     */
    public function getData()
    {
        $data = [];

        foreach ($this->getComponents() as $component) {
            $orderdata = $component->getData($this->order);

            if (is_array($orderdata)) {
                $data = array_merge($data, $orderdata);
            } else {
                user_error('getData on  ' . $component->name() . ' must return an array');
            }
        }
        return $data;
    }

    /**
     * Set data on all components
     *
     * @param array $data map of field names to data values
     */
    public function setData($data)
    {
        foreach ($this->getComponents() as $component) {
            $component->setData($this->order, $this->dependantData($component, $data));
        }
    }

    /**
     * Helper function for saving data from other components.
     */
    protected function dependantData($component, $data)
    {
        if (!$this->namespaced) { //no need to try and get un-namespaced dependant data
            return $data;
        }
        $dependantdata = [];
        foreach ($component->dependsOn() as $dependanttype) {
            $dependant = null;
            foreach ($this->components as $check) {
                if (get_class($check->Proxy()) == $dependanttype) {
                    $dependant = $check;
                    break;
                }
            }
            if (!$dependant) {
                user_error("Could not find a $dependanttype component, as depended by " . $component->name());
            }
            $dependantdata = array_merge(
                $dependantdata,
                $component->namespaceData($dependant->unnamespaceData($data))
            );
        }
        return array_merge($dependantdata, $data);
    }
}


1			<?php
2
3			namespace SilverShop\Checkout;
4
5			use SilverShop\Checkout\Component\CheckoutComponent;
6			use SilverShop\Checkout\Component\CheckoutComponentNamespaced;
7			use SilverShop\Model\Order;
8			use SilverStripe\Core\Injector\Injectable;
9			use SilverStripe\Forms\FieldList;
10			use SilverStripe\ORM\ArrayList;
11			use SilverStripe\ORM\ValidationException;
12			use SilverStripe\ORM\ValidationResult;
13
14			/**
15			* @package shop
16			*/
17			class CheckoutComponentConfig
18			{
19			use Injectable;
20
21			protected $components;
22
23			protected $order;
24
25			protected $namespaced; //namespace fields according to their component
26
27			public function __construct(Order $order, $namespaced = true)
28			{
29			$this->components = ArrayList::create();
30			$this->order = $order;
31			$this->namespaced = $namespaced;
32			}
33
34			public function getOrder()
35			{
36			return $this->order;
37			}
38
39			/**
40			* @param CheckoutComponent $component
41			* @param string $insertBefore The class of the component to insert this one before
42			* @return $this
43			*/
44			public function addComponent(CheckoutComponent $component, $insertBefore = null)
45			{
46			if ($this->namespaced) {
47			$component = CheckoutComponentNamespaced::create($component);
48			}
49			if ($insertBefore) {
50			$existingItems = $this->getComponents();
51			$this->components = ArrayList::create();
52			$inserted = false;
53			foreach ($existingItems as $existingItem) {
54			if (!$inserted && $existingItem instanceof $insertBefore) {
55			$this->components->push($component);
56			$inserted = true;
57			}
58			$this->components->push($existingItem);
59			}
60			if (!$inserted) {
61			$this->components->push($component);
62			}
63			} else {
64			$this->getComponents()->push($component);
65			}
66			return $this;
67			}
68
69			/**
70			* @return ArrayList Of CheckoutComponent
71			*/
72			public function getComponents()
73			{
74			if (!$this->components) {
75			$this->components = ArrayList::create();
76			}
77			return $this->components;
78			}
79
80			/**
81			* Returns the first available component with the given class or interface.
82			*
83			* @param String ClassName
			0 ignored issues – show Bug introduced 2023-07-10 20:11 UTC by Report Bug Copy Issue Report The type `SilverShop\Checkout\ClassName` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
84			*
85			* @return CheckoutComponent
86			*/
87			public function getComponentByType($type)
88			{
89			foreach ($this->components as $component) {
90			if ($this->namespaced) {
91			if ($component->Proxy() instanceof $type) {
92			return $component->Proxy();
93			}
94			} else {
95			if ($component instanceof $type) {
96			return $component;
97			}
98			}
99			}
100			}
101
102			/**
103			* Whether or not this config has a component that collects payment data.
104			* Should be used to determine whether or not to add an additional payment step after checkout.
105			* @return bool
106			*/
107			public function hasComponentWithPaymentData()
108			{
109			foreach ($this->getComponents() as $component) {
110			if ($component->providesPaymentData()) {
111			return true;
112			}
113			}
114
115			return false;
116			}
117
118			/**
119			* Get combined form fields
120			*
121			* @return FieldList namespaced fields
122			*/
123			public function getFormFields()
124			{
125			$fields = FieldList::create();
126			foreach ($this->getComponents() as $component) {
127			if ($cfields = $component->getFormFields($this->order)) {
128			$fields->merge($cfields);
129			} else {
130			user_error('getFields on ' . get_class($component) . ' must return a FieldList');
131			}
132			}
133			return $fields;
134			}
135
136			public function getRequiredFields()
137			{
138			$required = [];
139			foreach ($this->getComponents() as $component) {
140			$required = array_merge($required, $component->getRequiredFields($this->order));
141			}
142			return $required;
143			}
144
145			/**
146			* Validate every component against given data.
147			*
148			* @param array $data data to validate
149			*
150			* @return boolean validation result
151			* @throws ValidationException
152			*/
153			public function validateData($data)
154			{
155			$result = ValidationResult::create();
156			foreach ($this->getComponents() as $component) {
157			try {
158			$component->validateData($this->order, $this->dependantData($component, $data));
159			} catch (ValidationException $e) {
160			//transfer messages into a single result
161			foreach ($e->getResult()->getMessages() as $code => $message) {
162			if (is_numeric($code)) {
163			$code = null;
164			}
165			if ($this->namespaced) {
166			$code = $component->namespaceFieldName($code);
167			}
168			$result->addError($message['message'], $code);
169			}
170			}
171			}
172
173			$this->order->extend('onValidateDataOnCheckout', $result);
174
175			if (!$result->isValid()) {
176			throw new ValidationException($result);
177			}
178
179			return true;
180			}
181
182			/**
183			* Get combined data
184			*
185			* @return array map of field names to data values
186			*/
187			public function getData()
188			{
189			$data = [];
190
191			foreach ($this->getComponents() as $component) {
192			$orderdata = $component->getData($this->order);
193
194			if (is_array($orderdata)) {
195			$data = array_merge($data, $orderdata);
196			} else {
197			user_error('getData on ' . $component->name() . ' must return an array');
198			}
199			}
200			return $data;
201			}
202
203			/**
204			* Set data on all components
205			*
206			* @param array $data map of field names to data values
207			*/
208			public function setData($data)
209			{
210			foreach ($this->getComponents() as $component) {
211			$component->setData($this->order, $this->dependantData($component, $data));
212			}
213			}
214
215			/**
216			* Helper function for saving data from other components.
217			*/
218			protected function dependantData($component, $data)
219			{
220			if (!$this->namespaced) { //no need to try and get un-namespaced dependant data
221			return $data;
222			}
223			$dependantdata = [];
224			foreach ($component->dependsOn() as $dependanttype) {
225			$dependant = null;
226			foreach ($this->components as $check) {
227			if (get_class($check->Proxy()) == $dependanttype) {
228			$dependant = $check;
229			break;
230			}
231			}
232			if (!$dependant) {
233			user_error("Could not find a $dependanttype component, as depended by " . $component->name());
234			}
235			$dependantdata = array_merge(
236			$dependantdata,
237			$component->namespaceData($dependant->unnamespaceData($data))
238			);
239			}
240			return array_merge($dependantdata, $data);
241			}
242			}
243

AntonyThorpe / silvershop-core

CheckoutComponentConfig::validateData() B last analyzed 2023-07-10 20:11 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CheckoutComponentConfig::validateData() B
last analyzed 2023-07-10 20:11 UTC