FBCLoadAdditionalContentTrait::loadAdditionalContent() - Code Metrics - Inspection of "Intermediate for testing with anax design me." - canax/content - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9eea33...054d19 )

by Mikael

created 2018-10-22 18:52 UTC

loadAdditionalContent() F

↳ Parent: FBCLoadAdditionalContentTrait

Complexity

Conditions	22
Paths	43

Size

Total Lines

116

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	506

Importance

Changes

Metric	Value
dl	0
loc	116
ccs	0
cts	81
cp	0
rs	3.3333
c	0
b	0
f	0
cc	22
nc	43
nop	3
crap	506

How to fix Long Method Complexity

<?php

namespace Anax\Content;

/**
 * File Based Content, code for loading additional content into view through
 * data["meta"].
 */
trait FBCLoadAdditionalContentTrait
{
    /**
     * 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);
                        $this->orderToc($baseRoute, $meta);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        list($next, $previous) = $this->findNextAndPrevious($routeIndex);
                        $views[$id]["data"]["next"] = $next;
                        $views[$id]["data"]["previous"] = $previous;
                        break;

                    case "single": // OBSOLETE
                    case "content":
                        $route = $this->getActiveRoute($meta["route"], $routeIndex);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                        // Load and parse route as view. Load meta view
                        // if any.
                        // Current view details preceds the loaded once.
                        $view = $this->loadAndParseRoute($route);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        $views[$id] = array_merge_recursive_distinct($view, $views[$id]);
                        break;

                    case "columns":
                        // Each column is an own view set with details
                        // Process as meta view and load additional content
                        $template = isset($meta["template"])
                            ? $meta["template"]
                            : null;
                        $columns = $meta["columns"];
                        foreach ($columns as $key => $view) {
                            $views2 = [ "main" => $view ];
                            $this->loadAdditionalContent($views2, $route, $routeIndex);
                            $columns[$key] = $views2["main"];
                            
                            if ($template) {
                                $columns[$key]["template"] = $template;
                            }
                        }
                        $views[$id]["data"]["columns"] = $columns;
                        break;

                    case "toc-sort":
                        $baseRoute = dirname($routeIndex);
                        $this->orderToc($baseRoute, $meta);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        break;

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

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

                    case "toc-route":
                        // Get the toc for a specific route
                        $route = $this->getActiveRoute($meta["route"], $routeIndex);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        $routeIndex2 = $this->mapRoute2IndexKey($route);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        $baseRoute = dirname($routeIndex2);

                        // Include support for ordering
                        if (isset($meta["orderby"])
                            || isset($meta["orderorder"])) {
                            $this->orderToc($baseRoute, $meta);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        }

                        // Same as toc
                        $toc = $this->meta[$baseRoute]["__toc__"];
                        $this->limitToc($toc, $meta, $baseRoute);
                        $views[$id]["data"]["toc"] = $toc;
                        $views[$id]["data"]["meta"] = $meta;
                        break;

                    case "book-toc":
                        $toc = $this->meta[$baseRoute]["__toc__"];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                        $views[$id]["data"]["toc"] = $toc;
                        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;

                    case "copy":
                        $viewToCopy = $views[$id]["data"]["meta"]["view"];
                        $views[$id]["data"] = array_merge_recursive_distinct(
                            $views[$viewToCopy]["data"],
                            $views[$id]["data"]
                        );
                        break;

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



    /**
     * 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"];
            $isLinkable = $values[$i]["linkable"]; // ?? null;
            $isInternal = $values[$i]["internal"];
            if (($isSectionHeader && !$isLinkable) || $isInternal) {
                continue;
            }
            $previous = $values[$i];
            $previous["route"] = $index2Key[$i];
            break;
        }
        
        $next = null;
        for ($i = $current + 1; $i < $count; $i++) {

            $isSectionHeader = $values[$i]["sectionHeader"];
            $isLinkable = $values[$i]["linkable"]; // ?? null;
            $isInternal = $values[$i]["internal"];
            if (($isSectionHeader && !$isLinkable) || $isInternal) {
                continue;
            }
            $next = $values[$i];
            $next["route"] = $index2Key[$i];
            break;
        }

        return [$next, $previous];
    }



    /**
     * Order toc items.
     *
     * @param string $baseRoute route to use to find __toc__.
     * @param string $meta on how to order toc.
     *
     * @return void.

     */
    private function orderToc($baseRoute, $meta)
    {
        $defaults = [
            "orderby" => "section",
            "orderorder" => "asc",
        ];
        $options = array_merge($defaults, $meta);
        $orderby = $options["orderby"];
        $order   = $options["orderorder"];
        $toc = $this->meta[$baseRoute]["__toc__"];

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

                $asc = $order == "asc" ? 1 : -1;
                
            if ($a == $b) {
                return 0;
            } elseif ($a > $b) {
                return $asc;
            }
                return -$asc;
        });

        $this->meta[$baseRoute]["__toc__"] = $toc;
    }


    /**
     * Limit and paginate toc items.
     *
     * @param string &$toc      array with current toc.
     * @param string &$meta     on how to order and limit toc.
     * @param string $baseRoute prepend to next & previous urls.
     *
     * @return void.

     */
    private function limitToc(&$toc, &$meta, $baseRoute = null)
    {
        $defaults = [
            "items" => 7,
            "offset" => 0,
        ];
        $options = array_merge($defaults, $meta);

        // Check if pagination is currently used
        if ($this->currentPage) {
            $options["offset"] = ($this->currentPage - 1) * $options["items"];
class MyClass { }

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

        $meta["totalItems"] = count($toc);
        $meta["currentPage"] = (int) floor($options["offset"] / $options["items"]) + 1;
        $meta["totalPages"] = (int) floor($meta["totalItems"] / $options["items"] + 1);

        // Next and previous page
        $pagination = $this->config["pagination"];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $meta["nextPageUrl"] = null;
        $meta["previousPageUrl"] = null;
        $baseRoute = isset($baseRoute)
            ? $baseRoute
            : $this->baseRoute;
class MyClass { }

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

        if ($meta["currentPage"] > 1 && $meta["totalPages"] > 1) {
            $previousPage = $meta["currentPage"] - 1;
            $previous = "";
            if ($previousPage != 1) {
                $previous = "$pagination/$previousPage";
            }
            $meta["previousPageUrl"] = "$baseRoute/$previous";
        }

        if ($meta["currentPage"] < $meta["totalPages"]) {
            $nextPage = $meta["currentPage"] + 1;
            $meta["nextPageUrl"] = "$baseRoute/$pagination/$nextPage";
        }


        // Only use slice of toc
        $startSlice = ($meta["currentPage"] - 1) * $options["items"];
        $toc = array_slice($toc, $startSlice, $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 FBCLoadAdditionalContentTrait
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 2018-10-11 16:55 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 2018-10-11 16:55 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);

canax / content

Push — master ( 9eea33...054d19 )

loadAdditionalContent() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like