Trefoil\Plugins\Optional\FootnotesInlinePlugin

Complexity

Total Complexity

13

Size/Duplication

Total Lines	178
Duplicated Lines	24.16 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setFootnotes()	0	4	1
A	getFootnotes()	0	4	1
A	getSubscribedEvents()	0	8	1
A	onItemPreParse()	0	13	2
A	onItemPostParse()	0	9	1
A	onPostPublish()	0	6	1
A	processItem()	0	5	1
A	extractFootnotes()	0	39	3
A	inlineFootnotes()	43	43	1
A	saveFootnotes()	0	4	1

<?php
/*
 * This file is part of the trefoil application.
 *
 * (c) Miguel Angel Gabriel <magabriel@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Trefoil\Plugins\Optional;

use Easybook\Events\BaseEvent;
use Easybook\Events\EasybookEvents;
use Easybook\Events\ParseEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Trefoil\Plugins\BasePlugin;

/**
 * This plugin transforms Markdown footnotes markup into inline footnotes.
 * 
 * @deprecated
 * 
 * PrinceXMl manages footnotes as:
 *
 *      "text<span class="fn">Text of the footnote</span> more text"
 *
 * This plugin transforms the Markdown-generated footnotes to the PrinceXML
 * format.
 *
 * Note that one limitation is that the footnote text cannot contain block
 * elements (as paragraphs, tables, lists). The plugin overcomes this
 * partially by replacing paragraph tags with <br/> tags.
 *
 */
class FootnotesInlinePlugin extends BasePlugin implements EventSubscriberInterface
{

    /**
     * The footnotes
     *
     * @var array
     */
    protected $footnotes = array();

    /**
     * @param array $footnotes
     *
     * @internal Should be protected but made public for PHP 5.3 compat
     */
    public function setFootnotes($footnotes)
    {
        $this->footnotes = $footnotes;
    }

    /**
     * @return array
     *
     * @internal Should be protected but made public for PHP 5.3 compat
     */
    public function getFootnotes()
    {
        return $this->footnotes;
    }


    /* ********************************************************************************
     * Event handlers
     * ********************************************************************************
     */
    public static function getSubscribedEvents()
    {
        return array(
            EasybookEvents::PRE_PARSE  => array('onItemPreParse', +100),
            EasybookEvents::POST_PARSE => array('onItemPostParse'),
            EasybookEvents::POST_PUBLISH => 'onPostPublish'
        );
    }

    public function onItemPreParse(ParseEvent $event)
    {
        $this->init($event);

        if ($this->item['config']['element'] === 'footnotes') {

            $this->app['publishing.footnotes.items'] = array();

            return;
        }

        $this->saveFootnotes();
    }

    public function onItemPostParse(ParseEvent $event)
    {
        $this->init($event);

        $this->processItem();

        // reload changed item
        $event->setItem($this->item);
    }

    public function onPostPublish(BaseEvent $event)
    {
        $this->init($event);

        $this->deprecationNotice();
    }
    
    /* ********************************************************************************
     * Implementation
     * ********************************************************************************
     */

    /**
     * For a content item to be processed, extract generated footnotes.
     */
    protected function processItem()
    {
        $this->extractFootnotes();
        $this->inlineFootnotes();
    }

    protected function extractFootnotes()
    {
        $content = $this->item['content'];

        $regExp = '/';
        $regExp .= '<div class="footnotes">.*<ol>(?<fns>.*)<\/ol>.*<\/div>';
        $regExp .= '/Ums'; // Ungreedy, multiline, dotall

        // PHP 5.3 compat
        $me = $this;

        $content = preg_replace_callback(
            $regExp,
            function ($matches) use ($me) {

                $regExp2 = '/';
                $regExp2 .= '<li.*id="(?<id>.*)">.*';
                $regExp2 .= '<p>(?<text>.*)&#160;<a .*href="#(?<backref>.*)"';
                $regExp2 .= '/Ums'; // Ungreedy, multiline, dotall

                preg_match_all($regExp2, $matches[0], $matches2, PREG_SET_ORDER);

                if ($matches2) {
                    foreach ($matches2 as $match2) {
                        $footnotes = $me->getFootnotes();
                        $footnotes[$match2['id']] = array(
                            'text' => $match2['text']
                        );
                        $me->setFootnotes($footnotes);
                    }
                }

                return '';
            },
            $content
        );

        $this->item['content'] = $content;
    }

    protected function inlineFootnotes()
    {
        $content = $this->item['content'];

        $regExp = '/';
        $regExp .= '<sup id="(?<supid>fnref.?:.*)">';
        $regExp .= '<a(?<prev>.*)href="#(?<href>fn:.*)"(?<post>.*)>(?<number>.*)<\/a><\/sup>';
        $regExp .= '/Ums'; // Ungreedy, multiline, dotall

        // PHP 5.3 compat
        $me = $this;

        $content = preg_replace_callback(
            $regExp,
            function ($matches) use ($me) {
                $footnotes = $me->getFootnotes();
                $footnote = $footnotes[$matches['href']];
                $text = $footnote['text'];

                // replace <p>...</p> with <br/> because no block elements are 
                // allowed inside a <span>.
                // The paragraph contents are also put inside a fake paragraph <span>
                // so they can be styled.

                $text = str_replace(
                    ['<p>', '</p>'],
                    ['<span class="p">', '<br/></span>'],
                    $text
                );
                $text = '<span class="p" >' . $text . '</span>';

                $html = sprintf(
                    '<span class="fn">%s</span>',
                    $text
                );

                return $html;
            },
            $content
        );

        $this->item['content'] = $content;
    }

    protected function saveFootnotes()
    {
        $this->app['publishing.footnotes.items'] = $this->footnotes;
    }
}