Lechimp\Dicto\Graph\Graph

Complexity

Total Complexity

17

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	create_node()	0	9	2
A	build_node()	0	3	1
A	add_relation()	0	3	1
A	nodes()	0	8	2
A	all_nodes()	0	7	3
A	filtered_nodes()	0	12	4
A	node()	0	9	3
A	query()	0	3	1

<?php
/******************************************************************************
 * An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
 * 
 * Copyright (c) 2016 Richard Klees <richard.klees@rwth-aachen.de>
 *
 * This software is licensed under The MIT License. You should have received 
 * a copy of the license along with the code.
 */

namespace Lechimp\Dicto\Graph;

use Lechimp\Dicto\Graph\Predicate;

/**
 * The complete graph.
 */
class Graph {
    /**
     * @var array<string, array<int, Node>>
     */
    protected $nodes = [];

    /**
     * @var int
     */
    protected $id_counter = 0;

    /**
     * Create a new node in the graph.
     *
     * @param   string                      $type
     * @param   array<string,mixed>|null    $properties
     * @return  Node
     */
    public function create_node($type, array $properties = null) {
        $node = $this->build_node($this->id_counter, $type, $properties);
        if (!array_key_exists($type, $this->nodes)) {
            $this->nodes[$type] = [];
        }
        $this->nodes[$type][$this->id_counter] = $node;
        $this->id_counter++;
        return $node;
    }

    protected function build_node($id, $type, array $properties = null) {
        return new Node($id, $type, $properties);

It seems like $properties defined by parameter $properties on line 46 can also be of type array; however, Lechimp\Dicto\Graph\Node::__construct() does only seem to accept null|array<string,*>, maybe add an additional type check?

    }

    /**
     * Add a relation to the graph.
     *
     * @param   Node                $left
     * @param   string              $type
     * @param   array<string,mixed> $properties
     * @param   Node                $right
     * @return  Relation
     */
    public function add_relation(Node $left, $type, array $properties, Node $right) {
        return $left->add_relation($type, $properties, $right);
    }

    /**
     * Get nodes from the graph, maybe filtered by a filter.
     *
     * @param   Predicate|null    $filter
     * @return  Iterator <Node>
     */
    public function nodes(Predicate $filter = null) {
        if ($filter !== null) {
            return $this->filtered_nodes($filter);
        }
        else {
            return $this->all_nodes();
        }
    }

    protected function all_nodes() {
        foreach($this->nodes as $nodes) {
            foreach ($nodes as $node) {
                yield $node;
            }
        }
    }

    protected function filtered_nodes(Predicate $filter) {
        $types = $filter->for_types(array_keys($this->nodes));
        $filter = $filter->compile();
        foreach ($types as $type) {
            $nodes = $this->nodes[$type];
            foreach ($nodes as $node) {
                if ($filter($node)) {
                    yield $node;
                }
            }
        }
    }

    /**
     * Get the node with the given id.
     *
     * @param   int     $id
     * @throws  \InvalidArgumentException   if $id is unknown
     * @return  Node
     */
    public function node($id) {
        assert('is_int($id)');
        foreach ($this->nodes as $nodes) {
            if (array_key_exists($id, $nodes)) {
                return $nodes[$id];
            }
        }
        throw new \InvalidArgumentException("Unknown node id '$id'");
    }

    /**
     * Build a query on the graph.
     *
     * @return  Query
     */
    public function query() {
        return new QueryImpl($this);
    }
}