WidgetMapManager::overwrite() - Code Metrics - Inspection of "Feature/refactor dnd" - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#325)

by Paul

created 2016-02-01 14:24 UTC

WidgetMapManager::overwrite() A

↳ Parent: WidgetMapManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	1
eloc	11
nc	1
nop	3

<?php

namespace Victoire\Bundle\WidgetMapBundle\Manager;

use Doctrine\Orm\EntityManager;
use Victoire\Bundle\CoreBundle\Entity\View;
use Victoire\Bundle\WidgetBundle\Entity\Widget;
use Victoire\Bundle\WidgetMapBundle\Builder\WidgetMapBuilder;
use Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap;

class WidgetMapManager
{
    private $em;
    private $builder;

    public function __construct(EntityManager $em, WidgetMapBuilder $builder)
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
    {
        $this->em = $em;
        $this->builder = $builder;
    }

    /**
     * @param string $slotId
     */
    public function insert(Widget $widget, View $view, $slotId, $position, $widgetReference)
    {
        $parent = null;
        if ($widgetReference) {
            $parent = $this->em->getRepository('VictoireWidgetMapBundle:WidgetMap')->find($widgetReference);
        }
        //create the new widget map
        $widgetMapEntry = new WidgetMap();
        $widgetMapEntry->setAction(WidgetMap::ACTION_CREATE);
        $widgetMapEntry->setWidget($widget);
        $widgetMapEntry->setSlot($slotId);
        $widgetMapEntry->setPosition($position);
        $widgetMapEntry->setParent($parent);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        $view->addWidgetMap($widgetMapEntry);
    }

    /**
     * moves a widget in a view.
     *
     * @param View  $view
     * @param array $sortedWidget
     *
     * @returns void
     */
    public function move(View $view, $sortedWidget)
    {
        /** @var WidgetMap $widgetMapReference */
        $widgetMapReference = $this->em->getRepository('VictoireWidgetMapBundle:WidgetMap')->find((int) $sortedWidget['widgetMapReference']);
        $position = $sortedWidget['position'];
        $slot = $sortedWidget['slot'];
        /** @var WidgetMap $widgetMap */
        $widgetMap = $this->em->getRepository('VictoireWidgetMapBundle:WidgetMap')->find((int) $sortedWidget['widgetMap']);

        $originalParent = $widgetMap->getParent();
        $originalPosition = $widgetMap->getPosition();

        $children = $widgetMap->getChildren($view);
        $beforeChild = !empty($children[WidgetMap::POSITION_BEFORE]) ? $children[WidgetMap::POSITION_BEFORE] : null;
        $afterChild = !empty($children[WidgetMap::POSITION_AFTER]) ? $children[WidgetMap::POSITION_AFTER] : null;

        $widgetMapReferenceChildren = $this->getChildrenByView($widgetMapReference);

        $widgetMap = $this->moveWidgetMap($view, $widgetMap, $widgetMapReference, $position, $slot);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        // If the moved widgetMap has someone at both his before and after, arbitrary move UP the before side
        // and find the first place after the before widgetMap hierarchy to place the after widgetMap.
        if ($beforeChild && $afterChild) {

            $this->moveWidgetMap($view, $beforeChild, $originalParent, $originalPosition);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            $child = $beforeChild;
            while ($child->getChild(WidgetMap::POSITION_AFTER)) {
                $child = $child->getChild(WidgetMap::POSITION_AFTER);
            }
            if ($afterChild->getId() !== $child->getId()) {
                $this->moveWidgetMap($view, $afterChild, $child);
            }
        } elseif ($beforeChild) {
            $this->moveWidgetMap($view, $beforeChild, $originalParent, $originalPosition);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } elseif ($afterChild) {
            $this->moveWidgetMap($view, $afterChild, $originalParent, $originalPosition);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        foreach ($widgetMapReferenceChildren['views'] as $_view) {
            if ($_view->getId() !== $view->getId()) {
                if (isset($widgetMapReferenceChildren['before'][$_view->getId()])) {

                    $widgetMapReferenceChildren['before'][$_view->getId()]->setParent($widgetMap);
                }
                if (isset($widgetMapReferenceChildren['after'][$_view->getId()])) {

                    $widgetMapReferenceChildren['after'][$_view->getId()]->setParent($widgetMap);
                }
            }
        }
    }

    /**
     * Delete the widget from the view.
     *
     * @param View   $view
     * @param Widget $widget
     *
     * @throws \Exception Widget map does not exists
     */
    public function delete(View $view, Widget $widget)
    {
        $this->builder->build($view);

        $widgetMap = $view->getWidgetMapByWidget($widget);
        $slot = $widgetMap->getSlot();

        $originalParent = $widgetMap->getParent();
        $originalPosition = $widgetMap->getPosition();

        $children = $widgetMap->getChildren($view);
        $beforeChild = !empty($children[WidgetMap::POSITION_BEFORE]) ? $children[WidgetMap::POSITION_BEFORE] : null;
        $afterChild = !empty($children[WidgetMap::POSITION_AFTER]) ? $children[WidgetMap::POSITION_AFTER] : null;

        //we remove the widget from the current view
        if ($widgetMap->getView() === $view) {
            //remove the widget map from the slot
            $view->removeWidgetMap($widgetMap);
        } else {
            //the widget is owned by another view (a parent)
            //so we add a new widget map that indicates we delete this widget
            $replaceWidgetMap = new WidgetMap();
            $replaceWidgetMap->setAction(WidgetMap::ACTION_DELETE);
            $replaceWidgetMap->setWidget($widget);
            $replaceWidgetMap->setSlot($slot);
            $replaceWidgetMap->setReplaced($widgetMap);

            $view->addWidgetMap($replaceWidgetMap);
        }

        $this->moveChildren($view, $beforeChild, $afterChild, $originalParent, $originalPosition);
    }

    /**
     * the widget is owned by another view (a parent)
     * so we add a new widget map that indicates we delete this widget.
     *
     * @param View      $view
     * @param WidgetMap $originalWidgetMap
     * @param Widget    $widgetCopy
     *
     * @throws \Exception
     */
    public function overwrite(View $view, WidgetMap $originalWidgetMap, Widget $widgetCopy)
    {
        $widgetMap = new WidgetMap();
        $widgetMap->setAction(WidgetMap::ACTION_OVERWRITE);
        $widgetMap->setReplaced($originalWidgetMap);
        $widgetMap->setWidget($widgetCopy);
        $widgetMap->setView($view);
        $widgetMap->setSlot($originalWidgetMap->getSlot());
        $widgetMap->setPosition($originalWidgetMap->getPosition());
        $widgetMap->setAsynchronous($widgetCopy->isAsynchronous());
        $widgetMap->setParent($originalWidgetMap->getParent());

        $view->addWidgetMap($widgetMap);
    }

    /**
     * If the moved widgetMap has someone at both his before and after, arbitrary move UP the before side
     * and find the first place after the before widgetMap hierarchy to place the after widgetMap.
     *
     * @param View $view
     * @param $beforeChild
     * @param $afterChild
     * @param $originalParent
     * @param $originalPosition
     */
    public function moveChildren(View $view, $beforeChild, $afterChild, $originalParent, $originalPosition)
    {
        if ($beforeChild && $afterChild) {

            $this->moveWidgetMap($view, $beforeChild, $originalParent, $originalPosition);

            $child = $beforeChild;
            while ($child->getChild(WidgetMap::POSITION_AFTER)) {
                $child = $child->getChild(WidgetMap::POSITION_AFTER);
            }
            if ($afterChild->getId() !== $child->getId()) {
                $this->moveWidgetMap($view, $afterChild, $child);
            }
        } elseif ($beforeChild) {
            $this->moveWidgetMap($view, $beforeChild, $originalParent, $originalPosition);
        } elseif ($afterChild) {
            $this->moveWidgetMap($view, $afterChild, $originalParent, $originalPosition);
        }
    }

    protected function cloneWidgetMap(WidgetMap $widgetMap, View $view)
    {
        $originalWidgetMap = $widgetMap;
        $widgetMap = clone $widgetMap;
        $widgetMap->setId(null);
        $widgetMap->setAction(WidgetMap::ACTION_OVERWRITE);
        $widgetMap->setReplaced($originalWidgetMap);
        $originalWidgetMap->addSubstitute($widgetMap);
        $view->addWidgetMap($widgetMap);
        $this->em->persist($widgetMap);

        return $widgetMap;
    }

    protected function moveWidgetMap(View $view, WidgetMap $widgetMap, $parent = false, $position = false, $slot = false)
    {
        if ($widgetMap->getView() !== $view) {
            $widgetMap = $this->cloneWidgetMap($widgetMap, $view);
        }

        if ($parent !== false) {
            if ($oldParent = $widgetMap->getParent()) {
                $oldParent->removeChild($widgetMap);
            }
            $widgetMap->setParent($parent);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            if ($parent) {
                $parent->addChild($widgetMap);

            }
        }
        if ($position !== false) {
            $widgetMap->setPosition($position);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if ($slot !== false) {
            $widgetMap->setSlot($slot);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return $widgetMap;
    }

    public function getChildrenByView(WidgetMap $widgetMap)
    {
        $beforeChilds = $widgetMap->getChilds(WidgetMap::POSITION_BEFORE);
        $afterChilds = $widgetMap->getChilds(WidgetMap::POSITION_AFTER);

        $childrenByView['views'] = [];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $childrenByView['before'] = [];
        $childrenByView['after'] = [];
        foreach ($beforeChilds as $beforeChild) {
            $view = $beforeChild->getView();
            $childrenByView['views'][] = $view;
            $childrenByView['before'][$view->getId()] = $beforeChild;
        }
        foreach ($afterChilds as $afterChild) {
            $view = $afterChild->getView();
            $childrenByView['views'][] = $view;
            $childrenByView['after'][$view->getId()] = $afterChild;
        }

        return $childrenByView;
    }
}


1			<?php
2
3			namespace Victoire\Bundle\WidgetMapBundle\Manager;
4
5			use Doctrine\Orm\EntityManager;
6			use Victoire\Bundle\CoreBundle\Entity\View;
7			use Victoire\Bundle\WidgetBundle\Entity\Widget;
8			use Victoire\Bundle\WidgetMapBundle\Builder\WidgetMapBuilder;
9			use Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap;
10
11			class WidgetMapManager
12			{
13			private $em;
14			private $builder;
15
16			public function __construct(EntityManager $em, WidgetMapBuilder $builder)
			0 ignored issues – show Bug introduced 2016-02-01 08:33 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$em`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
17			{
18			$this->em = $em;
19			$this->builder = $builder;
20			}
21
22			/**
23			* @param string $slotId
24			*/
25			public function insert(Widget $widget, View $view, $slotId, $position, $widgetReference)
26			{
27			$parent = null;
28			if ($widgetReference) {
29			$parent = $this->em->getRepository('VictoireWidgetMapBundle:WidgetMap')->find($widgetReference);
30			}
31			//create the new widget map
32			$widgetMapEntry = new WidgetMap();
33			$widgetMapEntry->setAction(WidgetMap::ACTION_CREATE);
34			$widgetMapEntry->setWidget($widget);
35			$widgetMapEntry->setSlot($slotId);
36			$widgetMapEntry->setPosition($position);
37			$widgetMapEntry->setParent($parent);
			0 ignored issues – show Bug introduced 2016-02-01 14:32 UTC by Report Bug Copy Issue Report It seems like `$parent` defined by `$this->em->getRepository...>find($widgetReference)` on line `29` can also be of type `object`; however, `Victoire\Bundle\WidgetMa...\WidgetMap::setParent()` does only seem to accept `null\|object<Victoire\Bun...undle\Entity\WidgetMap>`, 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...
38

Victoire / victoire

Pull Request — master (#325)

WidgetMapManager::overwrite() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like