Circular Class Reference

Public Member Functions
	buildCircularDependencies ($dependencies)

Protected Member Functions
	init ($dependencies)
	expandDependencies ($vertex, $path=[])
	buildCircular ($modules)
	divideByModules ($circularDependencies)

Protected Attributes
	$dependencies = []
	$circularDependencies = []
	$graph

Detailed Description

Build circular dependencies by modules map

Definition at line 13 of file Circular.php.

Member Function Documentation

buildCircular()

buildCircular (   $modules )

protected

Build all circular dependencies based on chain

Parameters

array

$modules

Returns

void

Definition at line 114 of file Circular.php.

    {
        $path = '/' . implode('/', $modules);
        if (isset($this->circularDependencies[$path])) {
            return;
        }
        $this->circularDependencies[$path] = $modules;
        $modules[] = array_shift($modules);
        $this->buildCircular($modules);
    }

buildCircularDependencies()

buildCircularDependencies

(

$dependencies

)

Build modules dependencies

Parameters

array

$dependencies

Key is the vertex and the value are the adjacent vertices(dependencies) of this vertex

Returns

array

Definition at line 42 of file Circular.php.

    {
        $this->init($dependencies);

        foreach (array_keys($this->dependencies) as $vertex) {
            $this->expandDependencies($vertex);
        }

        $circulars = $this->graph->findCycle(null, false);
        foreach ($circulars as $circular) {
            array_shift($circular);
            $this->buildCircular($circular);
        }

        return $this->divideByModules($this->circularDependencies);
    }

divideByModules()

divideByModules (   $circularDependencies )

protected

Divide dependencies by modules

Parameters

array

$circularDependencies

Returns

array

Definition at line 131 of file Circular.php.

    {
        $dependenciesByModule = [];
        foreach ($circularDependencies as $circularDependency) {
            $module = $circularDependency[0];
            $circularDependency[] = $module;
            $dependenciesByModule[$module][] = $circularDependency;
        }

        return $dependenciesByModule;
    }

expandDependencies()

expandDependencies (   $vertex,   $path = []  )

protected

Expand modules dependencies from chain

Parameters

string	$vertex
array	$path	nesting path

Returns

void

Definition at line 79 of file Circular.php.

    {
        if (!$this->dependencies[$vertex]) {
            return;
        }

        $path[] = $vertex;
        foreach ($this->dependencies[$vertex] as $dependency) {
            if (!isset($this->dependencies[$dependency])) {
                // dependency vertex is not described in basic definition
                continue;
            }
            $relations = $this->graph->getRelations();
            if (isset($relations[$vertex][$dependency])) {
                continue;
            }
            $this->graph->addRelation($vertex, $dependency);

            $searchResult = array_search($dependency, $path);

            if (false !== $searchResult) {
                $this->buildCircular(array_slice($path, $searchResult));
                break;
            } else {
                $this->expandDependencies($dependency, $path);
            }
        }
    }

init()

init (   $dependencies )

protected

Init data before building

Parameters

array

$dependencies

Returns

void

Definition at line 65 of file Circular.php.

    {
        $this->dependencies = $dependencies;
        $this->circularDependencies = [];
        $this->graph = new Graph(array_keys($this->dependencies), []);
    }

Field Documentation

$circularDependencies

$circularDependencies = []

protected

Definition at line 27 of file Circular.php.

$dependencies

$dependencies = []

protected

Definition at line 20 of file Circular.php.

$graph

$graph

protected

Definition at line 34 of file Circular.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/setup/src/Magento/Setup/Module/Dependency/Circular.php