Victoire / victoire

Bundle/WidgetMapBundle/Resolver/WidgetMapChildrenResolver.php

<?php

namespace Victoire\Bundle\WidgetMapBundle\Resolver;

use Symfony\Bridge\Monolog\Logger;
use Victoire\Bundle\CoreBundle\Entity\View;
use Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap;

class WidgetMapChildrenResolver

Missing class doc comment

{
    private $logger;

    /**
     * WidgetMapChildrenResolver constructor.
     *
     * @param Logger $logger
     */
    public function __construct(Logger $logger)
    {
        $this->logger = $logger;
    }

    /**

Doc comment for parameter "$widgetMap" missing

Doc comment for parameter "$view" missing

     * Return "after" and "before" children,
     * based on contextual View and its Templates.
     *
     * @return array
     */
    public function getChildren(WidgetMap $widgetMap, View $view = null)
    {
        $positions = [WidgetMap::POSITION_BEFORE, WidgetMap::POSITION_AFTER];
        $children = [];
        foreach ($positions as $position) {
            $matchingChildren = [];

            //Position is null by default
            $children[$position] = null;

            //Pass through all current WidgetMap children for a given position
            foreach ($widgetMap->getContextualChildren($position) as $_child) {

This code seems to be duplicated across your project.

                //If child don't have a substitute for this View and Templates, this is the one
                if (null === $_child->getSubstituteForView($view)) {

It seems like $view defined by parameter $view on line 29 can be null; however, Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap::getSubstituteForView() does not accept null, maybe add an additional type check?

                    $children[$position] = $_child;
                    $matchingChildren[] = $_child->getId();
                }
            }

            //If children has not been found for this position
            //and current WidgetMap is a substitute
            if (!$children[$position] && $widgetMap->getReplaced()) {
                //Pass through all replaced WidgetMap children for a given position
                foreach ($widgetMap->getReplaced()->getContextualChildren($position) as $_child) {

This code seems to be duplicated across your project.

                    //If child don't have a substitute for this View and Templates, this is the one
                    if (null === $_child->getSubstituteForView($view)) {

It seems like $view defined by parameter $view on line 29 can be null; however, Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap::getSubstituteForView() does not accept null, maybe add an additional type check?

                        $children[$position] = $_child;
                        $matchingChildren[] = $_child->getId();
                    }
                }
            }

            $matchingChildren = array_unique($matchingChildren);
            if (count($matchingChildren) > 1) {
                $this->logger->critical(sprintf(
                    'Conflict found between WidgetMaps %s for View %s',
                    implode(', ', $matchingChildren),
                    $view->getId()

It seems like $view is not always an object, but can also be of type null. Maybe add an additional type check?

                ));
            }
        }

        return $children;
    }

    /**

Doc comment for parameter "$widgetMap" missing

Doc comment for parameter "$position" missing

     * @param $position

Missing parameter name

     * @param View|null $view

Doc comment for parameter $view does not match actual variable name $position

     *
     * @return bool
     */
    public function hasChildren(WidgetMap $widgetMap, $position, View $view = null)
    {
        foreach ($this->getChildren($widgetMap, $view) as $child) {
            if ($child && $child->getPosition() === $position) {
                return true;
            }
        }

        return false;
    }
}