Update return type

Author: cjonstrup

phpstan.neon.dist

@@ -5,13 +5,3 @@ parameters:
     reportUnmatchedIgnoredErrors: false
     checkGenericClassInNonGenericObjectType: false
     checkMissingIterableValueType: false
-    ignoreErrors:
-        - '#Method Lenius\\Basket\\Storage\\Session::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\Storage\\Runtime::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\StorageInterface::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\ItemInterface::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\IdentifierInterface::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\Item::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\Basket::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\Identifier\\Cookie::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'
-        - '#Method Lenius\\Basket\\Identifier\\Runtime::[a-zA-Z0-9\\_]+\(\) has no return typehint specified.#'

src/Basket.php

@@ -113,7 +113,7 @@ public function insert(ItemInterface $item): string
      * @param mixed $key The key to update, or an array of key-value pairs
      * @param mixed $value The value to set $key to
      */
-    public function update(string $itemIdentifier, $key, $value = null)
+    public function update(string $itemIdentifier, $key, $value = null): void
     {
         /** @var Item $item */
         foreach ($this->contents() as $item) {
@@ -130,15 +130,15 @@ public function update(string $itemIdentifier, $key, $value = null)
      *
      * @param string $identifier Unique item identifier
      */
-    public function remove(string $identifier)
+    public function remove(string $identifier): void
     {
         $this->store->remove($identifier);
     }
 
     /**
      * Destroy/empty the basket.
      */
-    public function destroy()
+    public function destroy(): void
     {
         $this->store->destroy();
     }
@@ -258,7 +258,7 @@ public function totalItems($unique = false): int
      *
      * @param string $identifier
      */
-    public function setIdentifier(string $identifier)
+    public function setIdentifier(string $identifier): void
     {
         $this->store->setIdentifier($identifier);
     }
@@ -288,7 +288,7 @@ protected function createItemIdentifier(ItemInterface $item): string
      * Check if a basket item has the required parameters.
      * @param ItemInterface $item
      */
-    protected function checkArgs(ItemInterface $item)
+    protected function checkArgs(ItemInterface $item): void
     {
         foreach ($this->requiredParams as $param) {
             if (! array_key_exists($param, $item->toArray())) {

src/Item.php

@@ -59,7 +59,7 @@ public function __construct(array $item)
      *
      * @param string $identifier
      */
-    public function setIdentifier(string $identifier)
+    public function setIdentifier(string $identifier): void
     {
         $this->identifier = $identifier;
     }
@@ -82,7 +82,7 @@ public function __get(string $param)
      * @param mixed $param The key to set
      * @param mixed $value The value to set $param to
      */
-    public function __set($param, $value)
+    public function __set($param, $value): void
     {
         $this->data[$param] = $value;
 
@@ -186,7 +186,7 @@ public function single($includeTax = true): float
      * @param mixed $key   The array key to update, or an array of key-value pairs to update
      * @param mixed $value
      */
-    public function update($key, $value = null)
+    public function update($key, $value = null): void
     {
         if ($key instanceof ItemInterface) {
             foreach ($key->toArray() as $updateKey => $updateValue) {

src/ItemInterface.php

@@ -33,7 +33,7 @@ interface ItemInterface
     /**
      * @param string $identifier
      */
-    public function setIdentifier(string $identifier);
+    public function setIdentifier(string $identifier): void;
 
     /**
      * Return the total tax for this item.
@@ -73,7 +73,7 @@ public function single($includeTax = true): float;
      * @param mixed $key   The array key to update, or an array of key-value pairs to update
      * @param mixed $value
      */
-    public function update($key, $value = null);
+    public function update($key, $value = null): void;
 
     /**
      * Check if this item has options.
@@ -95,7 +95,7 @@ public function toArray(): array;
      * @param mixed $param
      * @param mixed $value
      */
-    public function __set($param, $value);
+    public function __set($param, $value): void;
 
     /**
      * Return the value of protected methods.

src/Storage/Runtime.php

@@ -43,7 +43,7 @@ class Runtime implements StorageInterface
      *
      * @param ItemInterface $item The item to insert or update
      */
-    public function insertUpdate(ItemInterface $item)
+    public function insertUpdate(ItemInterface $item): void
     {
         static::$cart[$this->id][$item->identifier] = $item;
     }
@@ -135,15 +135,15 @@ public function find(string $id)
      *
      * @param string $id
      */
-    public function remove(string $id)
+    public function remove(string $id): void
     {
         unset(static::$cart[$this->id][$id]);
     }
 
     /**
      * Destroy the cart.
      */
-    public function destroy()
+    public function destroy(): void
     {
         static::$cart[$this->id] = [];
     }
@@ -155,7 +155,7 @@ public function destroy()
      *
      * @internal param string $identifier
      */
-    public function setIdentifier(string $identifier)
+    public function setIdentifier(string $identifier): void
     {
         $this->id = $identifier;
 
@@ -177,7 +177,7 @@ public function getIdentifier(): string
     /**
      * Restore the cart.
      */
-    public function restore()
+    public function restore(): void
     {
         if (isset($_SESSION['cart'])) {
             static::$cart = unserialize($_SESSION['cart']);

src/Storage/Session.php

@@ -30,7 +30,7 @@ class Session extends Runtime implements StorageInterface
     /**
      * The Session store constructor.
      */
-    public function restore()
+    public function restore(): void
     {
         session_id() || session_start();
 

src/StorageInterface.php

@@ -30,7 +30,7 @@ interface StorageInterface
      *
      * @param ItemInterface $item The item to insert or update
      */
-    public function insertUpdate(ItemInterface $item);
+    public function insertUpdate(ItemInterface $item): void;
 
     /**
      * Retrieve the cart data.
@@ -73,24 +73,24 @@ public function find(string $id);
      *
      * @param string $id
      */
-    public function remove(string $id);
+    public function remove(string $id): void;
 
     /**
      * Destroy the cart.
      */
-    public function destroy();
+    public function destroy(): void;
 
     /**
      * Restore the cart.
      */
-    public function restore();
+    public function restore(): void;
 
     /**
      * Set the cart identifier.
      *
      * @param string $identifier
      */
-    public function setIdentifier(string $identifier);
+    public function setIdentifier(string $identifier): void;
 
     /**
      * Return the current cart identifier.