Merge commit 'refs/pull/origin/86'

Behavioral/State/CreateOrder.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace DesignPatterns\Behavioral\State;
+
+/**
+ * Class CreateOrder
+ */
+class CreateOrder implements OrderInterface
+{
+    /**
+     * @var array
+     */
+    private $order;
+
+    /**
+     * @param array $order
+     *
+     * @throws \Exception
+     */
+    public function __construct(array $order)
+    {
+        if (empty($order)) {
+            throw new \Exception('Order can not be empty!');
+        }
+        $this->order = $order;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function shipOrder()
+    {
+        $this->order['status'] = 'shipping';
+        $this->order['updatedTime'] = time();
+
+        // Setting the new order status into database;
+        return $this->updateOrder($this->order);
+    }
+
+    /**
+     * @return mixed|void
+     * @throws \Exception
+     */
+    public function completeOrder()
+    {
+        //Can not complete the order which status is created, throw exception;
+        throw new \Exception('Can not complete the order which status is created!');
+    }
+}

Behavioral/State/OrderController.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace DesignPatterns\Behavioral\State;
+
+/**
+ * Class OrderController
+ */
+class OrderController
+{
+    /**
+     * @param int $id
+     */
+    public function shipAction($id)
+    {
+        $order = OrderFactory::getOrder($id);
+        try {
+            $order->shipOrder();
+        } catch (Exception $e) {
+            //handle error!
+        }
+        // response to browser
+    }
+
+    /**
+     * @param int $id
+     */
+    public function completeAction($id)
+    {
+        $order = OrderFactory::getOrder($id);
+        try {
+            $order->completeOrder();
+        } catch (Exception $e) {
+            //handle error!
+        }
+        // response to browser
+    }
+}

Behavioral/State/OrderFactory.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace DesignPatterns\Behavioral\State;
+
+/**
+ * Class OrderFactory
+ */
+class OrderFactory
+{
+    private function __construct()
+    {
+        throw new \Exception('Can not instance the OrderFactory class!');
+    }
+
+    /**
+     * @param int $id
+     *
+     * @return CreateOrder|ShippingOrder
+     * @throws \Exception
+     */
+    public static function getOrder($id)
+    {
+        $order = 'Get Order From Database';
+
+        switch ($order['status']) {
+            case 'created':
+                return new CreateOrder($order);
+            case 'shipping':
+                return new ShippingOrder($order);
+            default:
+                throw new \Exception('Order status error!');
+                break;
+        }
+    }
+}

Behavioral/State/OrderInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace DesignPatterns\Behavioral\State;
+
+/**
+ * Class OrderInterface
+ */
+interface OrderInterface
+{
+    /**
+     * @return mixed
+     */
+    public function shipOrder();
+
+    /**
+     * @return mixed
+     */
+    public function completeOrder();
+}

Behavioral/State/README.md

@@ -0,0 +1,5 @@
+# State
+
+## Purpose
+
+Encapsulate varying behavior for the same routine based on an object's state.  This can be a cleaner way for an object to change its behavior at runtime without resorting to large monolithic conditional statements.

Behavioral/State/ShippingOrder.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace DesignPatterns\Behavioral\State;
+
+/**
+ * Class ShippingOrder
+ */
+class ShippingOrder implements OrderInterface
+{
+    /**
+     * @var array
+     */
+    private $order;
+
+    /**
+     * @param array $order
+     *
+     * @throws \Exception
+     */
+    public function __construct(array $order)
+    {
+        if (empty($order)) {
+            throw new \Exception('Order can not be empty!');
+        }
+        $this->order = $order;
+    }
+
+    /**
+     * @return mixed|void
+     * @throws \Exception
+     */
+    public function shipOrder()
+    {
+        //Can not ship the order which status is shipping, throw exception;
+        throw new \Exception('Can not ship the order which status is shipping!');
+    }
+
+    /**
+     * @return mixed
+     */
+    public function completeOrder()
+    {
+        $this->order['status'] = 'completed';
+        $this->order['updatedTime'] = time();
+
+        // Setting the new order status into database;
+        return $this->updateOrder($order);
+    }
+}