Anax\Content\TFBCUtilities

Complexity

Total Complexity

11

Size/Duplication

Total Lines	208
Duplicated Lines	12.5 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getActiveRoute()	0	8	2
B	processContentPhaseTwo()	0	24	2
B	loadAndParseRoute()	0	33	2
B	getDataForAdditionalRoute()	0	36	2
A	addBaseurl2AnchorUrls()	13	13	1
A	addBaseurl2ImageSource()	13	13	1
A	getPublishTime()	0	5	1

<?php

namespace Anax\Content;

/**
 * File Based Content, code for loading additional content into view through
 * data["meta"].
 */
trait TFBCUtilities
{
    /**
     * Support relative routes.
     *
     * @param string $route      to load.
     * @param string $routeIndex to use.
     *
     * @return string with active route.
     */
    private function getActiveRoute($route, $routeIndex)

This method is not used, and could be removed.

    {
        if (substr_compare($route, "./", 0, 2) === 0) {
            $route = dirname($routeIndex) . "/" . substr($route, 2);
        }

        return $route;
    }



    /**
     * Process content phase 2 and merge with new frontmatter into
     * view structure.
     *
     * @param string &$views array to load view info into.
     * @param string  $route to load meta from.

There is no parameter named $route. Was it maybe removed?

     *
     * @return void
     */
    private function processContentPhaseTwo(&$filtered)
    {
        $filter     = $this->config["textfilter"];

The property config does not exist. Did you maybe forget to declare it?

        $textFilter = $this->di->get("textFilter");

The property di does not exist. Did you maybe forget to declare it?

        // Get new filtered content (and updated frontmatter)
        $new = $textFilter->parse($filtered->text, $filter);
        $filtered->text = $new->text;
        $filtered->frontmatter = array_merge_recursive_distinct(
            $filtered->frontmatter,
            $new->frontmatter
        );

        // Update all anchor urls to use baseurl, needs info about baseurl
        // from merged frontmatter
        $baseurl = isset($filtered->frontmatter["baseurl"])
           ? $filtered->frontmatter["baseurl"]
           : null;
        $this->addBaseurl2AnchorUrls($filtered, $baseurl);
        $this->addBaseurl2ImageSource($filtered, $baseurl);

        // Add excerpt and hasMore, if available
        $textFilter->addExcerpt($filtered);
    }




    /**
     * Load view details for additional route, merged with meta if any.
     *
     * @param string $route to load.
     *
     * @return array with view data details.
     */
    private function loadAndParseRoute($route)

This method is not used, and could be removed.

    {
         // Get meta into view structure
         $meta = $this->getMetaForRoute($route);

It seems like getMetaForRoute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

         unset($meta["__toc__"]);
         unset($meta["views"]);

        // Get filtered content from route
        list($routeIndex, , $filtered) =
            $this->mapRoute2Content($route);

It seems like mapRoute2Content() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Merge frontmatter with meta
        // then merge frontmatter base into views main
        $filtered->frontmatter = array_merge_recursive_distinct(
            $meta,
            $filtered->frontmatter
        );

        // Do phase 2 processing to get new filtered content
        // (and updated frontmatter)
        $this->processContentPhaseTwo($filtered);

        // Create complete frontmatter, inluding content
        $filtered->frontmatter["data"]["content"] = isset($filtered->text)
            ? $filtered->text
            : null;

        // Load additional content for view, based on data-meta
        $view = ["main" => $filtered->frontmatter];
        $this->loadAdditionalContent($view, $route, $routeIndex);

It seems like loadAdditionalContent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $view["main"];
    }



    /**
     * Load view data for additional route, merged with meta if any.
     *
     * @param string $route to load.
     *
     * @return array with view data details.
     */
    private function getDataForAdditionalRoute($route)
    {
         $filter     = $this->config["textfilter"];
         $textFilter = $this->di->get("textFilter");

        // Get filtered content from route
        list($routeIndex, , $filtered) =
            $this->mapRoute2Content($route);

It seems like mapRoute2Content() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Get meta, remove unneeded details
        $meta = $this->getMetaForRoute($route);

It seems like getMetaForRoute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        unset($meta["__toc__"]);
        unset($meta["views"]);

        // Do phase 2 processing to get new filtered content
        // (and updated frontmatter)
        $new = $textFilter->parse($filtered->text, $filter);
        $new->frontmatter = array_merge_recursive_distinct($filtered->frontmatter, $new->frontmatter);

        // Creates urls based on baseurl
        $baseurl = isset($new->frontmatter["data"]["baseurl"])
            ? isset($new->frontmatter["data"]["baseurl"])
            : null;
        $this->addBaseurl2AnchorUrls($new, $baseurl);

$baseurl is of type boolean|null, but the function expects a string.

        $this->addBaseurl2ImageSource($new, $baseurl);

$baseurl is of type boolean|null, but the function expects a string.

        // Create complete frontmatter, inluding content
        $frontmatter = $new->frontmatter;
        $frontmatter["data"]["content"] = $new->text;

        // Load additional content for view, based on data-meta
        $view = ["main" => $frontmatter];
        $this->loadAdditionalContent($view, $route, $routeIndex);

It seems like loadAdditionalContent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $view["main"];
    }



    /**
     * Parse text, find and update all a href to use baseurl.
     *
     * @param object &$filtered with text and excerpt to process.
     * @param string $baseurl   add as baseurl for all relative urls.
     *
     * @return void.

The doc-type void. could not be parsed: Unknown type name "void." at position 0. (view supported doc-types)

     */
    private function addBaseurl2AnchorUrls(&$filtered, $baseurl)

This method seems to be duplicated in your project.

    {
        $textf  = $this->di->get("textFilter");
        $url    = $this->di->get("url");

        // Use callback to url->create() instead of string concat
        $callback = function ($route) use ($url, $baseurl) {
            return $url->create($route, $baseurl);
        };

        $filtered->text =
            $textf->addBaseurlToRelativeLinks($filtered->text, $baseurl, $callback);
    }



    /**
     * Parse text, find and update all image source to use baseurl.
     *
     * @param object &$filtered with text and excerpt to process.
     * @param string $baseurl   add as baseurl for all relative urls.
     *
     * @return void.

The doc-type void. could not be parsed: Unknown type name "void." at position 0. (view supported doc-types)

     */
    private function addBaseurl2ImageSource(&$filtered, $baseurl)

This method seems to be duplicated in your project.

    {
        $textf  = $this->di->get("textFilter");
        $url    = $this->di->get("url");

        // Use callback to url->create() instead of string concat
        $callback = function ($route) use ($url, $baseurl) {
            return $url->create($route, $baseurl);
        };

        $filtered->text =
            $textf->addBaseurlToImageSource($filtered->text, $baseurl, $callback);
    }



    /**
     * Get published date.
     *
     * @param array $frontmatter with details on dates.
     *
     * @return integer as time for publish time.
     */
    private function getPublishTime($frontmatter)
    {
        list(, $date) = $this->di->get("view")->getPublishedDate($frontmatter);
        return strtotime($date);
    }
}