Main::hookModuleInstallAfter() - Code Metrics - Inspection of "Removed core Library::clearCache()" - gplcart/packer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5630d2...55136e )

by Iurii

created 2018-03-10 20:48 UTC

Main::hookModuleInstallAfter() A

↳ Parent: Main::hookRouteList()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * @package Packer
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2018, Iurii Makukh <[email protected]>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0-or-later
 */

namespace gplcart\modules\packer;

use Exception;
use gplcart\core\Config;
use gplcart\core\Container;

/**
 * Main class for Packer module
 */
class Main
{

    /**
     * Database class instance
     * @var \gplcart\core\Database $db
     */
    protected $db;

    /**
     * Main constructor.
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        $this->db = $config->getDb();
        $this->db->addScheme($this->getDbScheme());
    }

    /**
     * Implements hook "library.list"
     * @param array $libraries
     */
    public function hookLibraryList(array &$libraries)
    {
        $libraries['packer'] = array(
            'name' => 'Box packer', // @text
            'description' => '4D bin packing / knapsack problem solver', // @text
            'url' => 'https://github.com/dvdoug/BoxPacker',
            'download' => 'https://github.com/dvdoug/BoxPacker/archive/2.4.3.zip',
            'type' => 'php',
            'version' => '2.4.3',
            'module' => 'packer',
            'vendor' => 'dvdoug/boxpacker'
        );
    }

    /**
     * Implements hook "module.uninstall.after"
     */
    public function hookModuleUninstallAfter()
    {
        $this->db->deleteTable('module_packer_boxes');
    }

    /**
     * Implements hook "module.install.before"
     * @param null|string
     */
    public function hookModuleInstallBefore(&$result)
    {
        try {
            $this->db->importScheme('module_packer_boxes', $this->getDbScheme());
        } catch (Exception $ex) {
            $result = $ex->getMessage();
        }
    }

    /**
     * Implements hook "route.list"
     * @param array $routes
     */
    public function hookRouteList(array &$routes)
    {
        $routes['admin/settings/box'] = array(
            'menu' => array(
                'admin' => 'Boxes' // @text
            ),
            'access' => 'module_packer_box',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'listBox')
            )
        );

        $routes['admin/settings/box/add'] = array(
            'access' => 'module_packer_box_add',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'editBox')
            )
        );

        $routes['admin/settings/box/fit/(\d+)'] = array(
            'access' => 'module_packer_box',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'fitBox')
            )
        );

        $routes['admin/settings/box/edit/(\d+)'] = array(
            'access' => 'module_packer_box_edit',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'editBox')
            )
        );
    }

    /**
     * Implements hook "order.add.before"
     * @param array $data
     */
    public function hookOrderAddBefore(array &$data)
    {
        if (!empty($data['cart']['items'])) {

            try {
                $data['data']['packages'] = $this->packOrder($data, $data['cart']);
            } catch (Exception $ex) {
                trigger_error($ex->getMessage());
            }
        }
    }

    /**
     * Implements hook "user.role.permissions"
     * @param array $permissions
     */
    public function hookUserRolePermissions(array &$permissions)
    {
        $permissions['module_packer_box'] = 'Packer: access boxes'; // @text
        $permissions['module_packer_box_add'] = 'Packer: add box'; // @text
        $permissions['module_packer_box_edit'] = 'Packer: edit box'; // @text
        $permissions['module_packer_box_delete'] = 'Packer: delete box'; // @text
    }


    /**
     * Returns an array of boxes needed to fit all the order items
     * @param array $order
     * @param array $cart
     * @return array
     */
    public function packOrder(array $order, array $cart)
    {
        return $this->getPackerModel()->packOrder($order, $cart);
    }

    /**
     * Pack an array of items into a given array of boxes
     * @param array $items
     * @param array $boxes
     * @return array
     */
    public function getPackedBoxes(array $items, array $boxes)
    {
        return $this->getPackerModel()->getPackedBoxes($items, $boxes);
    }

    /**
     * Returns an array of items that fit into the box
     * @param array $items
     * @param array $box
     * @return array
     */
    public function getFitItems(array $items, array $box)
    {
        return $this->getPackerModel()->getFitItems($items, $box);
    }

    /**
     * Returns an array of database scheme
     * @return array
     */
    public function getDbScheme()
    {
        return array(
            'module_packer_boxes' => array(
                'fields' => array(
                    'name' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
                    'outer_width' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'outer_length' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'outer_depth' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'empty_weight' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'inner_width' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'inner_length' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'inner_depth' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'max_weight' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'status' => array('type' => 'int', 'length' => 1, 'not_null' => true, 'default' => 0),
                    'weight_unit' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
                    'size_unit' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
                    'box_id' => array('type' => 'int', 'length' => 10, 'auto_increment' => true, 'primary' => true),
                    'shipping_method' => array('type' => 'varchar', 'length' => 255, 'not_null' => true, 'default' => '')
                )
            )
        );
    }

    /**
     * Returns the Box model instance
     * @return \gplcart\modules\packer\models\Box
     */
    public function getBoxModel()
    {
        /** @var \gplcart\modules\packer\models\Box $instance */
        $instance = Container::get('gplcart\\modules\\packer\\models\\Box');
        return $instance;
    }

    /**
     * Returns the Packer model instance
     * @return \gplcart\modules\packer\models\Packer
     */
    public function getPackerModel()
    {
        /** @var \gplcart\modules\packer\models\Packer $instance */
        $instance = Container::get('gplcart\\modules\\packer\\models\\Packer');
        return $instance;
    }
}


1			<?php
2
3			/**
4			* @package Packer
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2018, Iurii Makukh <[email protected]>
7			* @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0-or-later
8			*/
9
10			namespace gplcart\modules\packer;
11
12			use Exception;
13			use gplcart\core\Config;
14			use gplcart\core\Container;
15
16			/**
17			* Main class for Packer module
18			*/
19			class Main
20			{
21
22			/**
23			* Database class instance
24			* @var \gplcart\core\Database $db
25			*/
26			protected $db;
27
28			/**
29			* Main constructor.
30			* @param Config $config
31			*/
32			public function __construct(Config $config)
33			{
34			$this->db = $config->getDb();
35			$this->db->addScheme($this->getDbScheme());
36			}
37
38			/**
39			* Implements hook "library.list"
40			* @param array $libraries
41			*/
42			public function hookLibraryList(array &$libraries)
43			{
44			$libraries['packer'] = array(
45			'name' => 'Box packer', // @text
46			'description' => '4D bin packing / knapsack problem solver', // @text
47			'url' => 'https://github.com/dvdoug/BoxPacker',
48			'download' => 'https://github.com/dvdoug/BoxPacker/archive/2.4.3.zip',
49			'type' => 'php',
50			'version' => '2.4.3',
51			'module' => 'packer',
52			'vendor' => 'dvdoug/boxpacker'
53			);
54			}
55
56			/**
57			* Implements hook "module.uninstall.after"
58			*/
59			public function hookModuleUninstallAfter()
60			{
61			$this->db->deleteTable('module_packer_boxes');
62			}
63
64			/**
65			* Implements hook "module.install.before"
66			* @param null\|string
67			*/
68			public function hookModuleInstallBefore(&$result)
69			{
70			try {
71			$this->db->importScheme('module_packer_boxes', $this->getDbScheme());
72			} catch (Exception $ex) {
73			$result = $ex->getMessage();
74			}
75			}
76
77			/**
78			* Implements hook "route.list"
79			* @param array $routes
80			*/
81			public function hookRouteList(array &$routes)
82			{
83			$routes['admin/settings/box'] = array(
84			'menu' => array(
85			'admin' => 'Boxes' // @text
86			),
87			'access' => 'module_packer_box',
88			'handlers' => array(
89			'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'listBox')
90			)
91			);
92
93			$routes['admin/settings/box/add'] = array(
94			'access' => 'module_packer_box_add',
95			'handlers' => array(
96			'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'editBox')
97			)
98			);
99
100			$routes['admin/settings/box/fit/(\d+)'] = array(
101			'access' => 'module_packer_box',
102			'handlers' => array(
103			'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'fitBox')
104			)
105			);
106
107			$routes['admin/settings/box/edit/(\d+)'] = array(
108			'access' => 'module_packer_box_edit',
109			'handlers' => array(
110			'controller' => array('gplcart\\modules\\packer\\controllers\\Box', 'editBox')
111			)
112			);
113			}
114
115			/**
116			* Implements hook "order.add.before"
117			* @param array $data
118			*/
119			public function hookOrderAddBefore(array &$data)
120			{
121			if (!empty($data['cart']['items'])) {
122
123			try {
124			$data['data']['packages'] = $this->packOrder($data, $data['cart']);
125			} catch (Exception $ex) {
126			trigger_error($ex->getMessage());
127			}
128			}
129			}
130
131			/**
132			* Implements hook "user.role.permissions"
133			* @param array $permissions
134			*/
135			public function hookUserRolePermissions(array &$permissions)
136			{
137			$permissions['module_packer_box'] = 'Packer: access boxes'; // @text
138			$permissions['module_packer_box_add'] = 'Packer: add box'; // @text
139			$permissions['module_packer_box_edit'] = 'Packer: edit box'; // @text
140			$permissions['module_packer_box_delete'] = 'Packer: delete box'; // @text
141			}
142
143
144			/**
145			* Returns an array of boxes needed to fit all the order items
146			* @param array $order
147			* @param array $cart
148			* @return array
149			*/
150			public function packOrder(array $order, array $cart)
151			{
152			return $this->getPackerModel()->packOrder($order, $cart);
153			}
154
155			/**
156			* Pack an array of items into a given array of boxes
157			* @param array $items
158			* @param array $boxes
159			* @return array
160			*/
161			public function getPackedBoxes(array $items, array $boxes)
162			{
163			return $this->getPackerModel()->getPackedBoxes($items, $boxes);
164			}
165
166			/**
167			* Returns an array of items that fit into the box
168			* @param array $items
169			* @param array $box
170			* @return array
171			*/
172			public function getFitItems(array $items, array $box)
173			{
174			return $this->getPackerModel()->getFitItems($items, $box);
175			}
176
177			/**
178			* Returns an array of database scheme
179			* @return array
180			*/
181			public function getDbScheme()
182			{
183			return array(
184			'module_packer_boxes' => array(
185			'fields' => array(
186			'name' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
187			'outer_width' => array('type' => 'int', 'length' => 10, 'not_null' => true),
188			'outer_length' => array('type' => 'int', 'length' => 10, 'not_null' => true),
189			'outer_depth' => array('type' => 'int', 'length' => 10, 'not_null' => true),
190			'empty_weight' => array('type' => 'int', 'length' => 10, 'not_null' => true),
191			'inner_width' => array('type' => 'int', 'length' => 10, 'not_null' => true),
192			'inner_length' => array('type' => 'int', 'length' => 10, 'not_null' => true),
193			'inner_depth' => array('type' => 'int', 'length' => 10, 'not_null' => true),
194			'max_weight' => array('type' => 'int', 'length' => 10, 'not_null' => true),
195			'status' => array('type' => 'int', 'length' => 1, 'not_null' => true, 'default' => 0),
196			'weight_unit' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
197			'size_unit' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
198			'box_id' => array('type' => 'int', 'length' => 10, 'auto_increment' => true, 'primary' => true),
199			'shipping_method' => array('type' => 'varchar', 'length' => 255, 'not_null' => true, 'default' => '')
200			)
201			)
202			);
203			}
204
205			/**
206			* Returns the Box model instance
207			* @return \gplcart\modules\packer\models\Box
208			*/
209			public function getBoxModel()
210			{
211			/** @var \gplcart\modules\packer\models\Box $instance */
212			$instance = Container::get('gplcart\\modules\\packer\\models\\Box');
213			return $instance;
214			}
215
216			/**
217			* Returns the Packer model instance
218			* @return \gplcart\modules\packer\models\Packer
219			*/
220			public function getPackerModel()
221			{
222			/** @var \gplcart\modules\packer\models\Packer $instance */
223			$instance = Container::get('gplcart\\modules\\packer\\models\\Packer');
224			return $instance;
225			}
226			}
227

gplcart / packer

Push — master ( 5630d2...55136e )

Main::hookModuleInstallAfter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like