Warehouse::createFromJson() - Code Metrics - Inspection of "added documentation" - GGGGino/WarehousePath - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( e0ffe6...4f8f39 )

by David
created 2019-02-18 11:56 UTC
Warehouse::createFromJson() A

↳ Parent: Warehouse
Complexity

Conditions	2
Paths	2
Size

Total Lines	14
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	8
nc	2
nop	1
dl	0
loc	14
rs	10
c	0
b	0
f	0
<?php

namespace GGGGino\WarehousePath;

use GGGGino\WarehousePath\Calculator\CalculatorInterface;
use GGGGino\WarehousePath\Entity\Place;
use GGGGino\WarehousePath\Parser\JsonMatrixParser;
use GGGGino\WarehousePath\Parser\MatrixParser;
use GGGGino\WarehousePath\Parser\ParserInterface;
use GGGGino\WarehousePath\Parser\TreeParser;

class Warehouse
{
    /**
     * @var PlacesCollector
     */
    private $placesCollector;

    /**
     * @var Place[]
     */
    private $places = array();

    /**
     * @var CalculatorInterface
     */
    private $pathCalculator;

    /**
     * @var ParserInterface
     */
    private $parser;

    public function __construct(PlacesCollector $placesCollector, ParserInterface $parser)
    {
        $this->placesCollector = $placesCollector;
        $this->parser = $parser;
    }

    /***
     * @param string $path
     * @return Warehouse
     * @throws \Exception
     */
    public static function createFromJson($path)
    {
        if( !$path )
            throw new \Exception('Please select a path');

        $placesCollector = new PlacesCollector();
        $placesCollector->addBasePlaceTypes();

        $wm = new JsonMatrixParser($path, $placesCollector);

        $instance = new self($placesCollector, $wm);
        $instance->setPlaces($wm->parse());

        return $instance;
    }

    /**
     * @param $param
     * @return Warehouse
     * @throws \Exception
     */
    public static function createFromMatrix($param)
    {
        if( !is_array($param) )
            throw new \Exception('Matrix should be initialized with an array');

        $placesCollector = new PlacesCollector();
        $placesCollector->addBasePlaceTypes();

        $wm = new MatrixParser($param, $placesCollector);

        $instance = new self($placesCollector, $wm);
        $instance->setPlaces($wm->parse());

        return $instance;
    }

    /**
     * @param $param
     * @return Warehouse
     * @throws \Exception
     */
    public static function createFromTree($param)
    {
        if( !is_array($param) )
            throw new \Exception('Matrix should be initialized with an array');

        $placesCollector = new PlacesCollector();
        $placesCollector->addBasePlaceTypes();

        $wm = new TreeParser($param);

        $instance = new self($placesCollector, $wm);
        $instance->setPlaces($wm->parse());

        return $instance;
    }

    /**
     * Main algorithm to find the shortest path.
     *
     * @todo: nel futuro quando ci sarà un magazzino grande, spezzare il magazzino prendendo solo il quadrato contenente i vari punti
     *
     * @param Place $startPlace
     * @param Place $endPlace if not null do early exit
     */
    public function getPath(Place $startPlace, Place $endPlace = null)
    public function getPath(Place $startPlace, /** @scrutinizer ignore-unused */ Place $endPlace = null)
    {
        $frontier = array();
        array_push($frontier, $startPlace);

        while (!empty($frontier)) {
            /** @var Place $current */
            $current = array_shift($frontier);

            /** @var Place $vicino */
            foreach ($current->getWalkableNeighbors() as $vicino) {
                $tempCost = $current->getCurrentWeight() + $vicino->getOriginalWeight();

                if ($vicino->isVisited() && $tempCost < $vicino->getCurrentWeight()) {
                    $vicino->setCurrentWeight($tempCost);
                    $vicino->setWalkingCameFrom($current);
                    array_push($frontier, $vicino);
                    continue;
                }

                if ($vicino->isVisited()) {
                    continue;
                }

                $vicino->setVisited(true);

                $vicino->increaseCurrentWeight($current->getCurrentWeight());
                $vicino->setWalkingCameFrom($current);

                array_push($frontier, $vicino);
            }

            $current->setVisited(true);
        }
    }

    /**
     * Reset all the node to permit another calculation
     */
    public function reset()
    {
        foreach ($this->places as $place) {
            $place->reset();
        }
    }

    /**
     * For every place i create the path
     *
     * @param Place[] $places
     * @return array
     */
    public function getMultiplePath(array $places)
    {
        $matrixDistances = array();

        /** @var Place $place */
        foreach ($places as $place) {
            $this->getPath($place);
            $tempPlaceDistance = array();

            /** @var Place $place */
            foreach ($places as $place1) {
                $tempPlaceDistance[] = $place1->getCurrentWeight();
            }

            $matrixDistances[] = $tempPlaceDistance;
            $this->reset();
        }

        return $matrixDistances;
    }

    /**
     * Create the matrix for development purpose.
     * If you want to print the whole wharehouse
     *
     * @return Entity\Place[][]
     * @throws \Exception
     */
    public function createMatrix()
    {
        /** @var Place[] $places */
        $places = $this->getPlaces();

        /** @var Place[][] $resultMatrix */
        $resultMatrix = array();

        if ( empty($places) )
            throw new \Exception('First add the places');

        /** @var Place $startingPlace */
        $startingPlace = reset($places);

        while ( $newPlace = $startingPlace->getTopRef() ) {
            $startingPlace = $newPlace;
        }

        while ( $newPlace = $startingPlace->getLeftRef() ) {
            $startingPlace = $newPlace;
        }

        /** @var Place $rowPlace */
        $rowPlace = $startingPlace;

        do {
            $tempRow = array();

            /** @var Place $columnPlace */
            $columnPlace = $rowPlace;

            do {
                $tempRow[] = $columnPlace;
            } while ($columnPlace = $columnPlace->getRightRef());

            $resultMatrix[] = $tempRow;
        } while ($rowPlace = $rowPlace->getBottomRef());

        return $resultMatrix;
    }

    /**
     * @param $arrayNodes
     * @param $matrix
     * @return Place[]
     */
    public function calculate($arrayNodes, $matrix)
    {
        return $this->pathCalculator->calculate($arrayNodes, $matrix);
    }

    /**
     * @return Place[]
     */
    public function getPlaces(): array
    {
        return $this->places;
    }

    /**
     * @param Entity\Place[] $places
     * @return Warehouse
     */
    public function setPlaces($places)
    {
        $this->places = $places;
        return $this;
    }

    /**
     * @param CalculatorInterface $pathCalculator
     * @return Warehouse
     */
    public function setPathCalculator($pathCalculator)
    {
        $this->pathCalculator = $pathCalculator;
        return $this;
    }

    /**
     * @param PlacesCollector $placesCollector
     * @return Warehouse
     */
    public function setPlacesCollector($placesCollector)
    {
        $this->placesCollector = $placesCollector;
        return $this;
    }

    /**
     * @return ParserInterface
     */
    public function getParser(): ParserInterface
    {
        return $this->parser;
    }

    /**
     * @return PlacesCollector
     */
    public function getPlacesCollector()
    {
        return $this->placesCollector;
    }
}
GGGGino / WarehousePath

Push — master ( e0ffe6...4f8f39 )

Warehouse::createFromJson() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
