ChildrenCountPlugin::mergeEntity() - Code Metrics - Inspection of "Implement category delete + replace functionality" - techdivision/import-category - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Tim

created 2017-02-22 14:31 UTC

ChildrenCountPlugin::mergeEntity() A

↳ Parent: ChildrenCountPlugin

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * TechDivision\Import\Category\Plugins\ChildrenCountPlugin
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-category
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Category\Plugins;

use TechDivision\Import\Utils\EntityStatus;
use TechDivision\Import\Plugins\AbstractPlugin;
use TechDivision\Import\Category\Utils\MemberNames;

/**
 * Plugin that updates the categories children count attribute after a successfull category import.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-category
 * @link      http://www.techdivision.com
 */
class ChildrenCountPlugin extends AbstractPlugin
{

    /**
     * Process the plugin functionality.
     *
     * @return void
     * @throws \Exception Is thrown, if the plugin can not be processed
     */
    public function process()
    {

        // load all available categories
        $categories = $this->getImportProcessor()->getCategories();

        // update the categories children count
        foreach ($categories as $category) {
            // load the category itself
            $this->category = $this->loadCategory($entityId = $category[MemberNames::ENTITY_ID]);
class MyClass { }

$x = new MyClass();
$x->foo = true;

            // update the category's children count
            $this->persistCategory($this->initializeCategory($this->prepareAttributes()));

            // write a log message
            $this->getSystemLogger()->debug(
                sprintf('Successfully updated category with ID %d', $entityId)
            );
        }
    }

    /**
     * Prepare the attributes of the entity that has to be persisted.
     *
     * @return array The prepared attributes
     */
    protected function prepareAttributes()
    {

        // initialize the values that has to be updated
        $updatedAt = date('Y-m-d H:i:s');
        $childrenCount = $this->loadCategoryChildrenChildrenCount($this->category[MemberNames::PATH] . '/%');

        // prepare and return the array with the updated values
        return array(
            MemberNames::UPDATED_AT     => $updatedAt,
            MemberNames::CHILDREN_COUNT => $childrenCount
        );
    }

    /**
     * Initialize the category with the passed attributes and returns an instance.
     *
     * @param array $attr The category attributes
     *
     * @return array The initialized category
     */
    protected function initializeCategory(array $attr)
    {
        return $this->mergeEntity(
            $this->category,
            $attr
        );
    }

    /**
     * Return's the category with the passed ID.
     *
     * @param string $id The ID of the category to return
     *
     * @return array The category
     */
    protected function loadCategory($id)
    {
        return $this->getProcessor()->loadCategory($id);

    }

    /**
     * Return's the children count of the category with the passed path.
     *
     * @param string $path The path of the category to count the children for
     *
     * @return integer The children count of the category with the passed path
     */
    protected function loadCategoryChildrenChildrenCount($path)
    {
        return $this->getProcessor()->loadCategoryChildrenChildrenCount($path);

    }

    /**
     * Persist's the passed category data and return's the ID.
     *
     * @param array $category The category data to persist
     *
     * @return string The ID of the persisted entity
     */
    protected function persistCategory($category)
    {
        return $this->getProcessor()->persistCategory($category);

    }

    /**
     * Merge's and return's the entity with the passed attributes and set's the
     * status to 'update'.
     *
     * @param array $entity The entity to merge the attributes into
     * @param array $attr   The attributes to be merged
     *
     * @return array The merged entity
     */
    protected function mergeEntity(array $entity, array $attr)
    {
        return array_merge($entity, $attr, array(EntityStatus::MEMBER_NAME => EntityStatus::STATUS_UPDATE));
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Category\Plugins\ChildrenCountPlugin
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2016 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import-category
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Category\Plugins;
22
23			use TechDivision\Import\Utils\EntityStatus;
24			use TechDivision\Import\Plugins\AbstractPlugin;
25			use TechDivision\Import\Category\Utils\MemberNames;
26
27			/**
28			* Plugin that updates the categories children count attribute after a successfull category import.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2016 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/techdivision/import-category
34			* @link http://www.techdivision.com
35			*/
36			class ChildrenCountPlugin extends AbstractPlugin
37			{
38
39			/**
40			* Process the plugin functionality.
41			*
42			* @return void
43			* @throws \Exception Is thrown, if the plugin can not be processed
44			*/
45			public function process()
46			{
47
48			// load all available categories
49			$categories = $this->getImportProcessor()->getCategories();
50
51			// update the categories children count
52			foreach ($categories as $category) {
53			// load the category itself
54			$this->category = $this->loadCategory($entityId = $category[MemberNames::ENTITY_ID]);
			0 ignored issues – show Bug introduced 2017-02-22 14:33 UTC by Report Bug Copy Issue Report The property `category` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
55
56			// update the category's children count
57			$this->persistCategory($this->initializeCategory($this->prepareAttributes()));
58
59			// write a log message
60			$this->getSystemLogger()->debug(
61			sprintf('Successfully updated category with ID %d', $entityId)
62			);
63			}
64			}
65
66			/**
67			* Prepare the attributes of the entity that has to be persisted.
68			*
69			* @return array The prepared attributes
70			*/
71			protected function prepareAttributes()
72			{
73
74			// initialize the values that has to be updated
75			$updatedAt = date('Y-m-d H:i:s');
76			$childrenCount = $this->loadCategoryChildrenChildrenCount($this->category[MemberNames::PATH] . '/%');
77
78			// prepare and return the array with the updated values
79			return array(
80			MemberNames::UPDATED_AT => $updatedAt,
81			MemberNames::CHILDREN_COUNT => $childrenCount
82			);
83			}
84
85			/**
86			* Initialize the category with the passed attributes and returns an instance.
87			*
88			* @param array $attr The category attributes
89			*
90			* @return array The initialized category
91			*/
92			protected function initializeCategory(array $attr)
93			{
94			return $this->mergeEntity(
95			$this->category,
96			$attr
97			);
98			}
99
100			/**
101			* Return's the category with the passed ID.
102			*
103			* @param string $id The ID of the category to return
104			*
105			* @return array The category
106			*/
107			protected function loadCategory($id)
108			{
109			return $this->getProcessor()->loadCategory($id);
			0 ignored issues – show Bug introduced 2017-02-22 14:33 UTC by Report Bug Copy Issue Report The method `getProcessor()` does not exist on `TechDivision\Import\Cate...ins\ChildrenCountPlugin`. Did you maybe mean `process()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
110			}
111
112			/**
113			* Return's the children count of the category with the passed path.
114			*
115			* @param string $path The path of the category to count the children for
116			*
117			* @return integer The children count of the category with the passed path
118			*/
119			protected function loadCategoryChildrenChildrenCount($path)
120			{
121			return $this->getProcessor()->loadCategoryChildrenChildrenCount($path);
			0 ignored issues – show Bug introduced 2017-02-22 14:33 UTC by Report Bug Copy Issue Report The method `getProcessor()` does not exist on `TechDivision\Import\Cate...ins\ChildrenCountPlugin`. Did you maybe mean `process()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
122			}
123
124			/**
125			* Persist's the passed category data and return's the ID.
126			*
127			* @param array $category The category data to persist
128			*
129			* @return string The ID of the persisted entity
130			*/
131			protected function persistCategory($category)
132			{
133			return $this->getProcessor()->persistCategory($category);
			0 ignored issues – show Bug introduced 2017-02-22 14:33 UTC by Report Bug Copy Issue Report The method `getProcessor()` does not exist on `TechDivision\Import\Cate...ins\ChildrenCountPlugin`. Did you maybe mean `process()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
134			}
135
136			/**
137			* Merge's and return's the entity with the passed attributes and set's the
138			* status to 'update'.
139			*
140			* @param array $entity The entity to merge the attributes into
141			* @param array $attr The attributes to be merged
142			*
143			* @return array The merged entity
144			*/
145			protected function mergeEntity(array $entity, array $attr)
146			{
147			return array_merge($entity, $attr, array(EntityStatus::MEMBER_NAME => EntityStatus::STATUS_UPDATE));
148			}
149			}
150

techdivision / import-category

Pull Request — master (#2)

ChildrenCountPlugin::mergeEntity() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like