TFBCLoadAdditionalContent::findNextAndPrevious() - Code Metrics - Inspection of "add author info" - mosbth/anax - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b28ef5...58dbbf )

by Mikael

created 2016-04-15 15:39 UTC

TFBCLoadAdditionalContent::findNextAndPrevious() D

↳ Parent: TFBCLoadAdditionalContent

Complexity

Conditions	9
Paths	11

Size

Total Lines	44
Code Lines	31

Duplication

Lines	20
Ratio	45.45 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	20
loc	44
rs	4.909
cc	9
eloc	31
nc	11
nop	1

<?php

namespace Anax\Content;

/**
 * File Based Content, code for loading additional content into view through 
 * data["meta"].
 */
trait TFBCLoadAdditionalContent
{
    /**
     * Load extra info into views based of meta information provided in each
     * view.
     *
     * @param array  &$views     with all views.
     * @param string $route      current route
     * @param string $routeIndex route with appended /index
     *
     * @throws NotFoundException when mapping can not be done.
     *
     * @return void.

     */
    private function loadAdditionalContent(&$views, $route, $routeIndex)
    {
        foreach ($views as $id => $view) {
            $meta = isset($view["data"]["meta"])
                ? $view["data"]["meta"]
                : null;

            if (is_array($meta)) {
                switch ($meta["type"]) {
                    case "article-toc":
                        $content = $views["main"]["data"]["content"];
                        $views[$id]["data"]["articleToc"] = $this->di->textFilter->createToc($content);
class MyClass { }

$x = new MyClass();
$x->foo = true;
                        break;

                    case "breadcrumb":
                        $views[$id]["data"]["breadcrumb"] = $this->createBreadcrumb($route);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        break;

                    case "next-previous":

                        $baseRoute = dirname($routeIndex);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                        list($next, $previous) = $this->findNextAndPrevious($routeIndex);
                        $views[$id]["data"]["next"] = $next;
                        $views[$id]["data"]["previous"] = $previous;
                        break;

                    case "single": // OBSOLETE
                    case "content":
                        $data = $this->getDataForAdditionalRoute($meta["route"]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        $views[$id]["data"] = array_merge_recursive_distinct($views[$id]["data"], $data);
                        break;

                    case "columns":
                        $columns = $meta["columns"];
                        foreach ($columns as $key => $value) {
                            $data = $this->getDataForAdditionalRoute($value["route"]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                            $columns[$key] = $data;
                        }
                        $views[$id]["data"]["columns"] = $columns;
                        break;

                    case "toc":

                        $baseRoute = dirname($routeIndex);
                        $toc = $this->meta[$baseRoute]["__toc__"];
class MyClass { }

$x = new MyClass();
$x->foo = true;
                        $this->orderAndlimitToc($toc, $meta);
                        $views[$id]["data"]["toc"] = $toc;
                        $views[$id]["data"]["meta"] = $meta;
                        break;

                    case "author":
                        if (isset($views["main"]["data"]["author"])) {
                            $views[$id]["data"]["author"] = $this->loadAuthorDetails($views["main"]["data"]["author"]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        }
                        break;

                    default:
                        throw new Exception(t("Unsupported data/meta/type '!TYPE' for additional content.", ["!TYPE" => $meta["type"]]));
                }
            }
        }
    }



    /**
     * Find next and previous links of current content.
     *
     * @param string $routeIndex target route to find next and previous for.
     *
     * @return array with next and previous if found.
     */
    private function findNextAndPrevious($routeIndex)
    {
        $key = dirname($routeIndex);
        if (!isset($this->meta[$key]["__toc__"])) {
            return [null, null];
        }

        $toc = $this->meta[$key]["__toc__"];
        if (!isset($toc[$routeIndex])) {
            return [null, null];
        }

        $index2Key = array_keys($toc);
        $keys = array_flip($index2Key);
        $values = array_values($toc);
        $count = count($keys);

        $current = $keys[$routeIndex];
        $previous = null;
        for ($i = $current - 1; $i >= 0; $i--) {

            $isSectionHeader = $values[$i]["sectionHeader"];
            $isInternal = $values[$i]["internal"];
            if ($isSectionHeader || $isInternal) {
                continue;
            }
            $previous = $values[$i];
            $previous["route"] = $index2Key[$i];
            break;
        }
        
        $next = null;
        for ($i = $current + 1; $i < $count; $i++) {

            $isSectionHeader = $values[$i]["sectionHeader"];
            $isInternal = $values[$i]["internal"];
            if ($isSectionHeader || $isInternal) {
                continue;
            }
            $next = $values[$i];
            $next["route"] = $index2Key[$i];
            break;
        }

        return [$next, $previous];
    }



    /**
     * Order and limit toc items.
     *
     * @param string &$toc  array with current toc.
     * @param string &$meta on how to order and limit toc.
     *
     * @return void.

     */
    private function orderAndlimitToc(&$toc, &$meta)
    {
        $defaults = [
            "items" => 7,
            "offset" => 0,
            "orderby" => "section",
            "orderorder" => "asc",
        ];
        $options = array_merge($defaults, $meta);
        $orderby = $options["orderby"];
        $order   = $options["orderorder"];

        $meta["totalItems"] = count($toc);

        // TODO support pagination by adding entries to $meta

        uksort($toc, function ($a, $b) use ($toc, $orderby, $order) {
            $a = $toc[$a][$orderby];
            $b = $toc[$b][$orderby];

            if ($order == "asc") {
                return strcmp($a, $b);
            }
            return strcmp($b, $a);
        });

        $toc = array_slice($toc, $options["offset"], $options["items"]);
        $meta["displayedItems"] = count($toc);
    }
}


1		<?php
2
3		namespace Anax\Content;
4
5		/**
6		* File Based Content, code for loading additional content into view through
7		* data["meta"].
8		*/
9		trait TFBCLoadAdditionalContent
10		{
11		/**
12		* Load extra info into views based of meta information provided in each
13		* view.
14		*
15		* @param array &$views with all views.
16		* @param string $route current route
17		* @param string $routeIndex route with appended /index
18		*
19		* @throws NotFoundException when mapping can not be done.
20		*
21		* @return void.
		0 ignored issues – show Documentation introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report The doc-type `void.` could not be parsed: Unknown type name "void." at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
22		*/
23		private function loadAdditionalContent(&$views, $route, $routeIndex)
24		{
25		foreach ($views as $id => $view) {
26		$meta = isset($view["data"]["meta"])
27		? $view["data"]["meta"]
28		: null;
29
30		if (is_array($meta)) {
31		switch ($meta["type"]) {
32		case "article-toc":
33		$content = $views["main"]["data"]["content"];
34		$views[$id]["data"]["articleToc"] = $this->di->textFilter->createToc($content);
		0 ignored issues – show Bug introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report The property `di` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
35		break;
36
37		case "breadcrumb":
38		$views[$id]["data"]["breadcrumb"] = $this->createBreadcrumb($route);
		0 ignored issues – show Bug introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report It seems like `createBreadcrumb()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
39		break;
40
41	View Code Duplication	case "next-previous":
		0 ignored issues – show Duplication introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
42		$baseRoute = dirname($routeIndex);
		0 ignored issues – show Unused Code introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report `$baseRoute` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
43		list($next, $previous) = $this->findNextAndPrevious($routeIndex);
44		$views[$id]["data"]["next"] = $next;
45		$views[$id]["data"]["previous"] = $previous;
46		break;
47
48		case "single": // OBSOLETE
49		case "content":
50		$data = $this->getDataForAdditionalRoute($meta["route"]);
		0 ignored issues – show Bug introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report It seems like `getDataForAdditionalRoute()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
51		$views[$id]["data"] = array_merge_recursive_distinct($views[$id]["data"], $data);
52		break;
53
54		case "columns":
55		$columns = $meta["columns"];
56		foreach ($columns as $key => $value) {
57		$data = $this->getDataForAdditionalRoute($value["route"]);
		0 ignored issues – show Bug introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report It seems like `getDataForAdditionalRoute()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
58		$columns[$key] = $data;
59		}
60		$views[$id]["data"]["columns"] = $columns;
61		break;
62
63	View Code Duplication	case "toc":
		0 ignored issues – show Duplication introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
64		$baseRoute = dirname($routeIndex);
65		$toc = $this->meta[$baseRoute]["__toc__"];
		0 ignored issues – show Bug introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report The property `meta` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
66		$this->orderAndlimitToc($toc, $meta);
67		$views[$id]["data"]["toc"] = $toc;
68		$views[$id]["data"]["meta"] = $meta;
69		break;
70
71		case "author":
72		if (isset($views["main"]["data"]["author"])) {
73		$views[$id]["data"]["author"] = $this->loadAuthorDetails($views["main"]["data"]["author"]);
		0 ignored issues – show Bug introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report It seems like `loadAuthorDetails()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
74		}
75		break;
76
77		default:
78		throw new Exception(t("Unsupported data/meta/type '!TYPE' for additional content.", ["!TYPE" => $meta["type"]]));
79		}
80		}
81		}
82		}
83
84
85
86		/**
87		* Find next and previous links of current content.
88		*
89		* @param string $routeIndex target route to find next and previous for.
90		*
91		* @return array with next and previous if found.
92		*/
93		private function findNextAndPrevious($routeIndex)
94		{
95		$key = dirname($routeIndex);
96		if (!isset($this->meta[$key]["__toc__"])) {
97		return [null, null];
98		}
99
100		$toc = $this->meta[$key]["__toc__"];
101		if (!isset($toc[$routeIndex])) {
102		return [null, null];
103		}
104
105		$index2Key = array_keys($toc);
106		$keys = array_flip($index2Key);
107		$values = array_values($toc);
108		$count = count($keys);
109
110		$current = $keys[$routeIndex];
111		$previous = null;
112	View Code Duplication	for ($i = $current - 1; $i >= 0; $i--) {
		0 ignored issues – show Duplication introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113		$isSectionHeader = $values[$i]["sectionHeader"];
114		$isInternal = $values[$i]["internal"];
115		if ($isSectionHeader \|\| $isInternal) {
116		continue;
117		}
118		$previous = $values[$i];
119		$previous["route"] = $index2Key[$i];
120		break;
121		}
122
123		$next = null;
124	View Code Duplication	for ($i = $current + 1; $i < $count; $i++) {
		0 ignored issues – show Duplication introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
125		$isSectionHeader = $values[$i]["sectionHeader"];
126		$isInternal = $values[$i]["internal"];
127		if ($isSectionHeader \|\| $isInternal) {
128		continue;
129		}
130		$next = $values[$i];
131		$next["route"] = $index2Key[$i];
132		break;
133		}
134
135		return [$next, $previous];
136		}
137
138
139
140		/**
141		* Order and limit toc items.
142		*
143		* @param string &$toc array with current toc.
144		* @param string &$meta on how to order and limit toc.
145		*
146		* @return void.
		0 ignored issues – show Documentation introduced 2016-04-15 15:42 UTC by Report Bug Copy Issue Report The doc-type `void.` could not be parsed: Unknown type name "void." at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
147		*/
148		private function orderAndlimitToc(&$toc, &$meta)
149		{
150		$defaults = [
151		"items" => 7,
152		"offset" => 0,
153		"orderby" => "section",
154		"orderorder" => "asc",
155		];
156		$options = array_merge($defaults, $meta);
157		$orderby = $options["orderby"];
158		$order = $options["orderorder"];
159
160		$meta["totalItems"] = count($toc);
161
162		// TODO support pagination by adding entries to $meta
163
164		uksort($toc, function ($a, $b) use ($toc, $orderby, $order) {
165		$a = $toc[$a][$orderby];
166		$b = $toc[$b][$orderby];
167
168		if ($order == "asc") {
169		return strcmp($a, $b);
170		}
171		return strcmp($b, $a);
172		});
173
174		$toc = array_slice($toc, $options["offset"], $options["items"]);
175		$meta["displayedItems"] = count($toc);
176		}
177		}
178

mosbth / anax

Push — master ( b28ef5...58dbbf )

TFBCLoadAdditionalContent::findNextAndPrevious() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like