Pilipinews\Common\Converters\ParagraphConverter

Complexity

Total Complexity

14

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Test Coverage

Coverage

97.56%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	escapeSpecialCharacters()	0	7	1
A	getSupportedTags()	0	3	1
A	convert()	0	20	3
A	escapeFirstCharacters()	0	14	3
A	escapeOtherCharactersRegex()	0	17	3
A	escapeOtherCharacters()	0	14	3

<?php

namespace Pilipinews\Common\Converters;

use League\HTMLToMarkdown\Converter\ConverterInterface;
use League\HTMLToMarkdown\ElementInterface;

/**
 * Paragraph Converter
 *
 * @package Pilipinews
 * @author  Rougin Gutib <rougingutib@gmail.com>
 */
class ParagraphConverter implements ConverterInterface
{
    /**
     * Converts the specified element into a parsed string.
     *
     * @param  \League\HTMLToMarkdown\ElementInterface $element
     * @return string
     */
    public function convert(ElementInterface $element)
    {
        $value = $element->getValue();

        $markdown = '';

        $lines = preg_split('/\r\n|\r|\n/', $value);

        foreach ($lines as $line)
        {
            /*
             * Some special characters need to be escaped based on the position that they appear
             * The following function will deal with those special cases.
             */

            $markdown .= $this->escapeSpecialCharacters($line);
            $markdown .= "\n";
        }

        return trim($markdown) !== '' ? "\n" . rtrim(ltrim($markdown)) . "\n" : '';
    }

    /**
     * Returns the supported HTML tags.
     *
     * @return string[]
     */
    public function getSupportedTags()
    {
        return array('p');
    }

    /**
     * @param string $line
     *
     * @return string
     */
    private function escapeSpecialCharacters($line)
    {
        $line = $this->escapeFirstCharacters($line);

        $line = $this->escapeOtherCharacters($line);

        return $this->escapeOtherCharactersRegex($line);
    }

    /**
     * @param string $line
     *
     * @return string
     */
    private function escapeFirstCharacters($line)
    {
        $escapable = array('>', '- ', '+ ', '--', '~~~', '---', '- - -');

        foreach ($escapable as $i)
        {
            if (strpos(ltrim($line), $i) === 0)
            {
                // Found a character that must be escaped, adding a backslash before
                return '\\' . ltrim($line);
            }
        }

        return $line;
    }

    /**
     * @param string $line
     *
     * @return string
     */
    private function escapeOtherCharacters($line)
    {
        $escapable = array('<!--');

        foreach ($escapable as $i)
        {
            if (strpos($line, $i) !== false)
            {
                // Found an escapable character, escaping it
                $line = substr_replace($line, '\\', strpos($line, $i), 0);
            }
        }

        return $line;
    }

    /**
     * @param string $line
     *
     * @return string
     */
    private function escapeOtherCharactersRegex($line)
    {
        // Match numbers ending on ')' or '.' that are at the beginning of the line.
        $regExs = array('/^[0-9]+(?=\)|\.)/');

        foreach ($regExs as $i)
        {
            if (preg_match($i, $line, $match))
            {
                // Matched an escapable character, adding a backslash on
                // the string before the offending character

                $line = substr_replace($line, '\\', strlen($match[0]), 0);
            }
        }

        return $line;
    }
}