cebe\markdown\block\FooterTrait

Complexity

Total Complexity

18

Size/Duplication

Total Lines	138
Duplicated Lines	7.25 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	parse()	0	16	3
A	applyFooter()	0	14	2
A	parseFootnoteLink()	10	10	2
A	renderFootnoteLink()	0	18	4
A	identifyFootnoteList()	0	4	1
A	consumeFootnoteList()	0	25	5
A	renderFootnote()	0	4	1

<?php
/**
 * Created by Andrew Solovov.
 * User: Andrey
 * Date: 15.01.2021
 * Time: 18:36
 *
 * Project name: markdown
 *
 * @author     Andrew Solovov <pan.russian@gmail.com>
 * @copyright  1997-2021 Pan Russian solovov.ru
 */

namespace cebe\markdown\block;


trait FooterTrait
{

    protected $footnotes = [];
    protected $footnoteNum = 1;

    /**
     * @param $text
     * @return string
     */
    public function parse($text)
    {
        $absy = $this->parseBlocks(explode("\n", $text));

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

        foreach ($absy as $block) {
            if ($block[0] == 'footnote') {
                $block['num'] = $this->footnoteNum;
                $this->footnotes[] = $block;
                $this->footnoteNum++;
            }
        }
        $markup = parent::parse($text);
        $markup = $this->applyFooter($markup, $this->footnotes);

        return $markup;
    }

    /**
     * @param $content
     * @param $blocks
     * @return string
     */
    protected function applyFooter($content, $blocks)
    {
        foreach ($blocks as $block) {
            $number = $block['num'] . ". ";
            $link = '<a href="#fnref:' . $block['id'] . '" class="footnote-backref">↑</a>';
            $text = $this->renderAbsy($block['content']);

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

            $text = $this->renderAbsy($this->parseInline($text));

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

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

            $text = substr_replace($text, $number, 3, 0);
            $text = substr_replace($text, $link, -5, 0);

            $content .= '<footnotes id="fn:' . $block['id'] . '">' . $text . "</footnotes>\n";
        }
        return $content;
    }

    /**
     * Parses a footnote link indicated by `[^`.
     * @marker [^
     * @param $text
     * @return array
     */
    protected function parseFootnoteLink($text)

This method seems to be duplicated in your project.

    {
        if (preg_match('/^\[\^(.+?)\]/', $text, $matches)) {
            return [
                ['footnoteLink', $matches[1]],
                strlen($matches[0])
            ];
        }
        return [['text', $text[0]], 1];
    }

    /**
     * @param $block
     * @return string
     */
    protected function renderFootnoteLink($block)
    {
        $footnoteId = $block[1];
        $num = 0;
        $found = false;
        foreach ($this->footnotes as $footnote) {
            $num ++;
            if ($footnote['id']==$footnoteId) {
                $found = true;
                break;
            }
        }
        if (!$found)
            $num = '?';

        $text = htmlspecialchars($block[1], ENT_NOQUOTES | ENT_SUBSTITUTE, 'UTF-8');
        return '<sup id="fnref:' . $text . '"><a href="#fn:' . $text . '" class="footnote-ref" rel="footnote">[' . $num . ']</a></sup>';
    }

    /**
     * identify a line as the beginning of a footnote block
     *
     * @param $line
     * @return false|int
     */
    protected function identifyFootnoteList($line)
    {
        return preg_match('/^\[\^(.+?)\]:/', $line);
    }

    /**
     * Consume lines for a footnote
     */
    protected function consumeFootnoteList($lines, $current)
    {
        $id = '';
        $content = [];
        $count = count($lines);
        for ($i = $current; $i < $count; $i++) {
            $line = $lines[$i];

            if ($id == '') {
                if (preg_match('/^\[\^(.+?)\]:[ \t]+/', $line, $matches)) {
                    $id = $matches[1];
                    $str = substr($line, strlen($matches[0]));
                    $content[] = $str;
                }
            } else if (strlen(trim($line)) == 0) {
                break;
            } else {
                $content[] = ltrim($line);
            }
        }

        $block = ['footnote', 'id' => $id, 'content' => $this->parseBlocks($content)];

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

        return [$block, $i];
    }

    /**
     * @param $block
     * @return string
     */
    protected function renderFootnote($block)

The parameter $block is not used and could be removed.

    {
        return '';
    }


}