Completed
Pull Request — master (#492)
by Roman
26:23
created

ShoppingCart::current()   B

Complexity

Conditions 6
Paths 8

Size

Total Lines 18
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 8.6047

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 18
ccs 7
cts 12
cp 0.5833
rs 8.8571
cc 6
eloc 11
nc 8
nop 0
crap 8.6047
1
<?php
2
3
/**
4
 * Encapsulated manipulation of the current order using a singleton pattern.
5
 *
6
 * Ensures that an order is only started (persisted to DB) when necessary,
7
 * and all future changes are on the same order, until the order has is placed.
8
 * The requirement for starting an order is to adding an item to the cart.
9
 *
10
 * @package shop
11
 */
12
class ShoppingCart
0 ignored issues
show
Complexity introduced by
This class has a complexity of 52 which exceeds the configured maximum of 50.

The class complexity is the sum of the complexity of all methods. A very high value is usually an indication that your class does not follow the single reponsibility principle and does more than one job.

Some resources for further reading:

You can also find more detailed suggestions for refactoring in the “Code” section of your repository.

Loading history...
13
{
14
    private static $cartid_session_name = 'shoppingcartid';
15
16
    private        $order;
17
18
    private        $calculateonce       = false;
19
20
    private        $message;
21
22
    private        $type;
23
24
    private static $instance;
25
26
    /**
27
     * Access for only allowing access to one (singleton) ShoppingCart.
28
     *
29
     * @return ShoppingCart
30
     */
31 91
    public static function singleton()
32
    {
33 91
        if (self::$instance === null) {
34 2
            self::$instance = new ShoppingCart();
35 2
        }
36
37 91
        return self::$instance;
38
    }
39
40
    /**
41
     * Shortened alias for ShoppingCart::singleton()->current()
42
     *
43
     * @return Order
44
     */
45 16
    public static function curr()
46
    {
47 16
        return self::singleton()->current();
48
    }
49
50
    /**
51
     * Singleton prevents constructing a ShoppingCart any other way.
52
     */
53 2
    private function __construct()
54
    {
55 2
    }
56
57
    /**
58
     * Get the current order, or return null if it doesn't exist.
59
     *
60
     * @return Order
61
     */
62 91
    public function current()
63
    {
64
        //find order by id saved to session (allows logging out and retaining cart contents)
65 91
        if (!$this->order && $sessionid = Session::get(self::$cartid_session_name)) {
66
            $this->order = Order::get()->filter(
67
                array(
68
                    "Status" => "Cart",
69
                    "ID"     => $sessionid,
70
                )
71
            )->first();
72
        }
73 91
        if (!$this->calculateonce && $this->order) {
74 2
            $this->order->calculate();
75 5
            $this->calculateonce = true;
76 19
        }
77
78 91
        return $this->order ? $this->order : false;
79
    }
80
81
    /**
82
     * Set the current cart
83
     *
84
     * @param Order
85
     *
86
     * @return ShoppingCart
87
     */
88 7
    public function setCurrent(Order $cart)
89
    {
90 7
        if (!$cart->IsCart()) {
91
            trigger_error("Passed Order object is not cart status", E_ERROR);
92
        }
93 7
        $this->order = $cart;
94 7
        Session::set(self::$cartid_session_name, $cart->ID);
95
96 7
        return $this;
97
    }
98
99
    /**
100
     * Helper that only allows orders to be started internally.
101
     *
102
     * @return Order
103
     */
104 18
    protected function findOrMake()
105
    {
106 18
        if ($this->current()) {
107 18
            return $this->current();
108
        }
109 9
        $this->order = Order::create();
110 9
        if (Member::config()->login_joins_cart && Member::currentUserID()) {
111 2
            $this->order->MemberID = Member::currentUserID();
0 ignored issues
show
Documentation introduced by
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...
112 2
        }
113 9
        $this->order->write();
114 9
        $this->order->extend('onStartOrder');
115 9
        Session::set(self::$cartid_session_name, $this->order->ID);
116
117 9
        return $this->order;
118
    }
119
120
    /**
121
     * Adds an item to the cart
122
     *
123
     * @param Buyable $buyable
124
     * @param number  $quantity
125
     * @param unknown $filter
126
     *
127
     * @return boolean|OrderItem false or the new/existing item
128
     */
129 17
    public function add(Buyable $buyable, $quantity = 1, $filter = array())
130
    {
131 17
        $order = $this->findOrMake();
132 17
        $order->extend("beforeAdd", $buyable, $quantity, $filter);
133 17
        if (!$buyable) {
134
135
            return $this->error(_t("ShoppingCart.PRODUCTNOTFOUND", "Product not found."));
136
        }
137 17
        $item = $this->findOrMakeItem($buyable, $filter);
138 17
        if (!$item) {
139
140 1
            return false;
141
        }
142 17
        if (!$item->_brandnew) {
0 ignored issues
show
Documentation introduced by
The property _brandnew does not exist on object<OrderItem>. 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...
143 4
            $item->Quantity += $quantity;
0 ignored issues
show
Documentation introduced by
The property Quantity does not exist on object<OrderItem>. 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...
144 4
        } else {
145 17
            $item->Quantity = $quantity;
0 ignored issues
show
Documentation introduced by
The property Quantity does not exist on object<OrderItem>. 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...
146
        }
147 17
        $item->write();
148 17
        $order->extend("afterAdd", $item, $buyable, $quantity, $filter);
149 17
        $this->message(_t("ShoppingCart.ITEMADD", "Item has been added successfully."));
150
151 17
        return $item;
152
    }
153
154
    /**
155
     * Remove an item from the cart.
156
     *
157
     * @param     id        or Buyable $buyable
158
     * @param     $item
159
     * @param int $quantity - number of items to remove, or leave null for all items (default)
160
     *
161
     * @return boolean success/failure
162
     */
163 4
    public function remove(Buyable $buyable, $quantity = null, $filter = array())
164
    {
165 4
        $order = $this->current();
166
167 4
        if (!$order) {
168
            return $this->error(_t("ShoppingCart.NOORDER", "No current order."));
169
        }
170
171 4
        $order->extend("beforeRemove", $buyable, $quantity, $filter);
172
173 4
        $item = $this->get($buyable, $filter);
174
175 4
        if (!$item) {
176 1
            return false;
177
        }
178
179
        //if $quantity will become 0, then remove all
180 4
        if (!$quantity || ($item->Quantity - $quantity) <= 0) {
181 4
            $item->delete();
182 4
            $item->destroy();
183 4
        } else {
184 1
            $item->Quantity -= $quantity;
185 1
            $item->write();
186
        }
187 4
        $order->extend("afterRemove", $item, $buyable, $quantity, $filter);
188 4
        $this->message(_t("ShoppingCart.ITEMREMOVED", "Item has been successfully removed."));
189
190 4
        return true;
191
    }
192
193
    /**
194
     * Sets the quantity of an item in the cart.
195
     * Will automatically add or remove item, if necessary.
196
     *
197
     * @param     id or Buyable $buyable
198
     * @param     $item
199
     * @param int $quantity
200
     *
201
     * @return boolean|OrderItem false or the new/existing item
202
     */
203 3
    public function setQuantity(Buyable $buyable, $quantity = 1, $filter = array())
204
    {
205 3
        if ($quantity <= 0) {
206
            return $this->remove($buyable, $quantity, $filter);
207
        }
208 3
        $order = $this->findOrMake();
209 3
        $item = $this->findOrMakeItem($buyable, $filter);
210 3
        if (!$item) {
211
212
            return false;
213 3
        }
214 3
        $order->extend("beforeSetQuantity", $buyable, $quantity, $filter);
215 3
        $item->Quantity = $quantity;
0 ignored issues
show
Documentation introduced by
The property Quantity does not exist on object<OrderItem>. 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...
216 3
        $item->write();
217 3
        $order->extend("afterSetQuantity", $item, $buyable, $quantity, $filter);
218 3
        $this->message(_t("ShoppingCart.QUANTITYSET", "Quantity has been set."));
219
220 3
        return $item;
221
    }
222
223
    /**
224
     * Finds or makes an order item for a given product + filter.
225
     *
226
     * @param        id or Buyable $buyable
227
     * @param string $filter
228
     *
229
     * @return OrderItem the found or created item
230
     */
231 18
    private function findOrMakeItem(Buyable $buyable, $filter = array())
232
    {
233 18
        $order = $this->findOrMake();
234
235 18
        if (!$buyable || !$order) {
236
            return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by ShoppingCart::findOrMakeItem of type OrderItem.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
237
        }
238
239 18
        $item = $this->get($buyable, $filter);
0 ignored issues
show
Bug introduced by
It seems like $filter defined by parameter $filter on line 231 can also be of type string; however, ShoppingCart::get() does only seem to accept array, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
Bug Compatibility introduced by
The expression $this->get($buyable, $filter); of type the adds the type the to the return on line 266 which is incompatible with the return type documented by ShoppingCart::findOrMakeItem of type OrderItem.
Loading history...
240
241 18
        if (!$item) {
242 18
            $member = Member::currentUser();
243
244 18
            if (!$buyable->canPurchase($member)) {
245 1
                return $this->error(
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->error(spri...18n_singular_name()))); (boolean) is incompatible with the return type documented by ShoppingCart::findOrMakeItem of type OrderItem.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
246 1
                    sprintf(
247 1
                        _t(
248 1
                            "ShoppingCart.CANNOTPURCHASE",
249
                            "This %s cannot be purchased."
250 1
                        ),
251 1
                        strtolower($buyable->i18n_singular_name())
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Buyable as the method i18n_singular_name() does only exist in the following implementations of said interface: CustomProduct, ProductVariation.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
252 1
                    )
253 1
                );
254
                //TODO: produce a more specific message
255
            }
256
257 18
            $item = $buyable->createItem(1, $filter);
0 ignored issues
show
Bug introduced by
It seems like $filter defined by parameter $filter on line 231 can also be of type string; however, Buyable::createItem() does only seem to accept array, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
258 18
            $item->OrderID = $order->ID;
0 ignored issues
show
Documentation introduced by
The property OrderID does not exist on object<OrderItem>. 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...
259 18
            $item->write();
260
261 18
            $order->Items()->add($item);
0 ignored issues
show
Documentation Bug introduced by
The method Items does not exist on object<Order>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
262
263 18
            $item->_brandnew = true; // flag as being new
0 ignored issues
show
Documentation introduced by
The property _brandnew does not exist on object<OrderItem>. 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...
264 18
        }
265
266 18
        return $item;
267
    }
268
269
    /**
270
     * Finds an existing order item.
271
     *
272
     * @param Buyable $buyable
273
     * @param string  $filter
0 ignored issues
show
Documentation introduced by
There is no parameter named $filter. Did you maybe mean $customfilter?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
274
     *
275
     * @return the item requested, or false
276
     */
277 22
    public function get(Buyable $buyable, $customfilter = array())
278 15
    {
279 22
        $order = $this->current();
280 21
        if (!$buyable || !$order) {
281
            return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by ShoppingCart::get of type the.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
282
        }
283
        $filter = array(
284 21
            'OrderID' => $order->ID,
285 21
        );
286 21
        $itemclass = Config::inst()->get(get_class($buyable), 'order_item');
287 21
        $relationship = Config::inst()->get($itemclass, 'buyable_relationship');
288 21
        $filter[$relationship . "ID"] = $buyable->ID;
0 ignored issues
show
Bug introduced by
Accessing ID on the interface Buyable suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
289 21
        $required = array('Order', $relationship);
290 21
        if (is_array($itemclass::config()->required_fields)) {
291 21
            $required = array_merge($required, $itemclass::config()->required_fields);
292 21
        }
293 21
        $query = new MatchObjectFilter($itemclass, array_merge($customfilter, $filter), $required);
294 21
        $item = $itemclass::get()->where($query->getFilter())->first();
295 21
        if (!$item) {
296 21
            return $this->error(_t("ShoppingCart.ITEMNOTFOUND", "Item not found."));
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->error(_t('...', 'Item not found.')); (boolean) is incompatible with the return type documented by ShoppingCart::get of type the.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
297
        }
298
299 12
        return $item;
300
    }
301
302
    /**
303
     * Store old cart id in session order history
304
     * @param int|null $requestedOrderId optional parameter that denotes the order that was requested
305 1
     */
306
    public function archiveorderid($requestedOrderId = null)
307 1
    {
308
        $sessionId = Session::get(self::$cartid_session_name);
309
        $order = Order::get()
310
            ->filter("Status:not", "Cart")
311
            ->byId($sessionId);
312
        if ($order && !$order->IsCart()) {
313
            OrderManipulation::add_session_order($order);
0 ignored issues
show
Compatibility introduced by
$order of type object<DataObject> is not a sub-type of object<Order>. It seems like you assume a child class of the class DataObject 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...
314
        }
315
        // in case there was no order requested
316
        // OR there was an order requested AND it's the same one as currently in the session,
317
        // then clear the cart. This check is here to prevent clearing of the cart if the user just
318
        // wants to view an old order (via AccountPage).
319
        if (!$requestedOrderId || ($sessionId == $requestedOrderId)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $requestedOrderId of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
320
            $this->clear();
321 10
        }
322
    }
323 10
324 10
    /**
325 10
     * Empty / abandon the entire cart.
326 10
     *
327 4
     * @return bool - true if successful, false if no cart found
328
     */
329 9
    public function clear()
330 9
    {
331
        Session::clear(self::$cartid_session_name);
332 9
        $order = $this->current();
333
        $this->order = null;
334
        if (!$order) {
335
            return $this->error(_t("ShoppingCart.NOCARTFOUND", "No cart found."));
336
        }
337
        $order->write();
338 22
        $this->message(_t("ShoppingCart.CLEARED", "Cart was successfully cleared."));
339
340 22
        return true;
341
    }
342 22
343
    /**
344
     * Store a new error.
345
     */
346
    protected function error($message)
347
    {
348
        $this->message($message, "bad");
349
350
        return false;
351 23
    }
352
353 23
    /**
354 23
     * Store a message to be fed back to user.
355 23
     *
356
     * @param string $message
357 15
     * @param string $type - good, bad, warning
358 15
     */
359
    protected function message($message, $type = "good")
360
    {
361
        $this->message = $message;
362
        $this->type = $type;
363
    }
364
365
    public function getMessage()
366
    {
367
        return $this->message;
368
    }
369
370
    public function getMessageType()
371
    {
372
        return $this->type;
373
    }
374
375
    public function clearMessage()
376
    {
377
        $this->message = null;
378
    }
379
380
    //singleton protection
381
    public function __clone()
382
    {
383
        trigger_error('Clone is not allowed.', E_USER_ERROR);
384
    }
385
386
    public function __wakeup()
387
    {
388
        trigger_error('Unserializing is not allowed.', E_USER_ERROR);
389
    }
390
}
391
392
/**
393
 * Manipulate the cart via urls.
394
 */
395
class ShoppingCart_Controller extends Controller
0 ignored issues
show
Complexity introduced by
This class has a complexity of 52 which exceeds the configured maximum of 50.

The class complexity is the sum of the complexity of all methods. A very high value is usually an indication that your class does not follow the single reponsibility principle and does more than one job.

Some resources for further reading:

You can also find more detailed suggestions for refactoring in the “Code” section of your repository.

Loading history...
396
{
397
    private static $url_segment         = "shoppingcart";
398
399
    private static $direct_to_cart_page = false;
400
401
    protected      $cart;
402
403
    private static $url_handlers        = array(
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
404
        '$Action/$Buyable/$ID' => 'handleAction',
405
    );
406
407
    private static $allowed_actions     = array(
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
408
        'add',
409
        'additem',
410
        'remove',
411
        'removeitem',
412 6
        'removeall',
413
        'removeallitem',
414 6
        'setquantity',
415
        'setquantityitem',
416
        'clear',
417 2
        'debug',
418
    );
419 2
420
    public static function add_item_link(Buyable $buyable, $parameters = array())
421
    {
422 2
        return self::build_url("add", $buyable, $parameters);
423
    }
424 2
425
    public static function remove_item_link(Buyable $buyable, $parameters = array())
426
    {
427 3
        return self::build_url("remove", $buyable, $parameters);
428
    }
429 3
430
    public static function remove_all_item_link(Buyable $buyable, $parameters = array())
431
    {
432
        return self::build_url("removeall", $buyable, $parameters);
433
    }
434
435 6
    public static function set_quantity_item_link(Buyable $buyable, $parameters = array())
436
    {
437 6
        return self::build_url("setquantity", $buyable, $parameters);
438
    }
439
440 6
    /**
441 1
     * Helper for creating a url
442 1
     */
443 6
    protected static function build_url($action, $buyable, $params = array())
444 6
    {
445 6
        if (!$action || !$buyable) {
446 6
            return false;
447 6
        }
448
        if (SecurityToken::is_enabled() && !self::config()->disable_security_token) {
449
            $params[SecurityToken::inst()->getName()] = SecurityToken::inst()->getValue();
450
        }
451
        return self::config()->url_segment . '/' .
452
        $action . '/' .
453
        $buyable->class . "/" .
454
        $buyable->ID .
455
        self::params_to_get_string($params);
456
    }
457
458 6
    /**
459
     * Creates the appropriate string parameters for links from array
460 6
     *
461 3
     * Produces string such as: MyParam%3D11%26OtherParam%3D1
462 3
     *     ...which decodes to: MyParam=11&OtherParam=1
463
     *
464 6
     * you will need to decode the url with javascript before using it.
465
     */
466
    protected static function params_to_get_string($array)
467
    {
468
        if ($array & count($array > 0)) {
469
            array_walk($array, create_function('&$v,$k', '$v = $k."=".$v ;'));
470
            return "?" . implode("&", $array);
471
        }
472
        return "";
473
    }
474 4
475
    /**
476 4
     * This is used here and in VariationForm and AddProductForm
477
     *
478
     * @param bool|string $status
479 4
     *
480
     * @return bool
481
     */
482
    public static function direct($status = true)
483 4
    {
484 4
        if (Director::is_ajax()) {
485
            return $status;
486
        }
487
        if (self::config()->direct_to_cart_page && $cartlink = CartPage::find_link()) {
488 4
            Controller::curr()->redirect($cartlink);
489
            return;
490 4
        } else {
491 4
            Controller::curr()->redirectBack();
492 4
            return;
493
        }
494
    }
495
496
    public function init()
497 4
    {
498
        parent::init();
499 4
        $this->cart = ShoppingCart::singleton();
500
    }
501 4
502 4
    /**
503 1
     * @return Product|ProductVariation|Buyable
504 4
     */
505 1
    protected function buyableFromRequest()
0 ignored issues
show
Complexity introduced by
This operation has 480 execution paths which exceeds the configured maximum of 200.

A high number of execution paths generally suggests many nested conditional statements and make the code less readible. This can usually be fixed by splitting the method into several smaller methods.

You can also find more information in the “Code” section of your repository.

Loading history...
506 1
    {
507 1
        $request = $this->getRequest();
508 1
        if (
509
            SecurityToken::is_enabled() &&
510 4
            !self::config()->disable_security_token &&
511 4
            !SecurityToken::inst()->checkRequest($request)
512
        ) {
513
            return $this->httpError(
514
                400,
515 4
                _t("ShoppingCart.CSRF", "Invalid security token, possible CSRF attack.")
516 4
            );
517 4
        }
518 4
        $id = (int)$request->param('ID');
519 4
        if (empty($id)) {
520
            //TODO: store error message
521
            return null;
522
        }
523
        $buyableclass = "Product";
524 4
        if ($class = $request->param('Buyable')) {
525
            $buyableclass = Convert::raw2sql($class);
526 4
        }
527 4
        if (!ClassInfo::exists($buyableclass)) {
528 4
            //TODO: store error message
529 4
            return null;
530
        }
531 1
        //ensure only live products are returned, if they are versioned
532
        $buyable = Object::has_extension($buyableclass, 'Versioned')
0 ignored issues
show
Bug introduced by
It seems like $buyableclass defined by \Convert::raw2sql($class) on line 525 can also be of type array; however, Object::has_extension() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
533 4
            ?
534
            Versioned::get_by_stage($buyableclass, 'Live')->byID($id)
0 ignored issues
show
Bug introduced by
It seems like $buyableclass defined by \Convert::raw2sql($class) on line 525 can also be of type array; however, Versioned::get_by_stage() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
535
            :
536
            DataObject::get($buyableclass)->byID($id);
0 ignored issues
show
Bug introduced by
It seems like $buyableclass defined by \Convert::raw2sql($class) on line 525 can also be of type array; however, DataObject::get() does only seem to accept string|null, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
537
        if (!$buyable || !($buyable instanceof Buyable)) {
538
            //TODO: store error message
539
            return null;
540
        }
541
        return $buyable;
542
    }
543 4
544
    /**
545 4
     * Action: add item to cart
546 4
     *
547 4
     * @param SS_HTTPRequest $request
548 4
     *
549 4
     * @return SS_HTTPResponse
550 4
     */
551 4
    public function add($request)
552
    {
553 4
        if ($product = $this->buyableFromRequest()) {
554 4
            $quantity = (int)$request->getVar('quantity');
555 4
            if (!$quantity) {
556
                $quantity = 1;
557
            }
558
            $this->cart->add($product, $quantity, $request->getVars());
559
        }
560
561
        $this->updateLocale($request);
562
        $this->extend('updateAddResponse', $request, $response, $product, $quantity);
563
        return $response ? $response : self::direct();
564
    }
565 1
566
    /**
567 1
     * Action: remove a certain number of items from the cart
568 1
     *
569 1
     * @param SS_HTTPRequest $request
570
     *
571 1
     * @return SS_HTTPResponse
572 1
     */
573 1
    public function remove($request)
574
    {
575
        if ($product = $this->buyableFromRequest()) {
576
            $this->cart->remove($product, $quantity = 1, $request->getVars());
577
        }
578
579
        $this->updateLocale($request);
580
        $this->extend('updateRemoveResponse', $request, $response, $product, $quantity);
581
        return $response ? $response : self::direct();
582
    }
583 1
584
    /**
585 1
     * Action: remove all of an item from the cart
586 1
     *
587 1
     * @param SS_HTTPRequest $request
588
     *
589 1
     * @return SS_HTTPResponse
590 1
     */
591 1
    public function removeall($request)
592
    {
593
        if ($product = $this->buyableFromRequest()) {
594
            $this->cart->remove($product, null, $request->getVars());
595
        }
596
597
        $this->updateLocale($request);
598
        $this->extend('updateRemoveAllResponse', $request, $response, $product);
599
        return $response ? $response : self::direct();
600
    }
601 2
602
    /**
603 2
     * Action: update the quantity of an item in the cart
604 2
     *
605 2
     * @param $request
606 2
     *
607 2
     * @return AjaxHTTPResponse|bool
608
     */
609 2
    public function setquantity($request)
610 2
    {
611 2
        $product = $this->buyableFromRequest();
612
        $quantity = (int)$request->getVar('quantity');
613
        if ($product) {
614
            $this->cart->setQuantity($product, $quantity, $request->getVars());
615
        }
616
617
        $this->updateLocale($request);
618
        $this->extend('updateSetQuantityResponse', $request, $response, $product, $quantity);
619
        return $response ? $response : self::direct();
620
    }
621
622
    /**
623
     * Action: clear the cart
624
     *
625
     * @param $request
626
     *
627
     * @return AjaxHTTPResponse|bool
628
     */
629
    public function clear($request)
630
    {
631
        $this->updateLocale($request);
632
        $this->cart->clear();
633
        $this->extend('updateClearResponse', $request, $response);
634
        return $response ? $response : self::direct();
635
    }
636
637
    /**
638
     * Handle index requests
639
     */
640
    public function index()
641
    {
642
        if ($cart = $this->Cart()) {
0 ignored issues
show
Documentation Bug introduced by
The method Cart does not exist on object<ShoppingCart_Controller>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
643
            $this->redirect($cart->CartLink);
644
            return;
645
        } elseif ($response = ErrorPage::response_for(404)) {
646
            return $response;
647
        }
648
        return $this->httpError(404, _t("ShoppingCart.NOCARTINITIALISED", "no cart initialised"));
649
    }
650
651
    /**
652
     * Displays order info and cart contents.
653
     */
654
    public function debug()
655
    {
656
        if (Director::isDev() || Permission::check("ADMIN")) {
657
            //TODO: allow specifying a particular id to debug
658
            Requirements::css(SHOP_DIR . "/css/cartdebug.css");
659
            $order = ShoppingCart::curr();
660
            $content = ($order)
661 4
                ?
662
                Debug::text($order)
0 ignored issues
show
Documentation introduced by
$order is of type object<Order>, but the function expects a object<unknown_type>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
663 4
                :
664 4
                "Cart has not been created yet. Add a product.";
665
            return array('Content' => $content);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return array('Content' => $content); (array<string,unknown|string>) is incompatible with the return type of the parent method ViewableData::Debug of type ViewableData_Debugger.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
666
        }
667 4
    }
668
669 2
    protected function updateLocale($request)
670
    {
671
        $order = $this->cart->current();
672
        if ($request && $request->isAjax() && $order) {
673
            ShopTools::install_locale($order->Locale);
0 ignored issues
show
Documentation introduced by
The property Locale 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...
674
        }
675
    }
676
}
677