Apparat\Resource\Infrastructure\Model\Part\CommonMarkPart

Complexity

Total Complexity

4

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getHtml()	0	13	2
A	environment()	0	9	1
A	initializeEnvironment()	0	7	1

<?php

/**
 * apparat-resource
 *
 * @category    Apparat
 * @package     Apparat\Resource
 * @subpackage  Apparat\Resource\Infrastructure
 * @author      Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Resource\Infrastructure\Model\Part;

use Apparat\Kernel\Tests\Kernel;
use League\CommonMark\DocParser;
use League\CommonMark\Environment;
use League\CommonMark\HtmlRenderer;

/**
 * CommonMark resource part
 *
 * @package     Apparat\Resource
 * @subpackage  Apparat\Resource\Infrastructure
 */
class CommonMarkPart extends TextPart
{
    /**
     * Media type
     *
     * @var string
     */
    const MEDIA_TYPE = 'text/markdown; charset=UTF-8; variant=CommonMark';

    /**
     * Convert the CommonMark source to HTML
     *
     * @return string CommonMark HTML
     */
    public function getHtml()
    {
        $html = '';

        if (strlen($this->content)) {
            $environment = $this->environment();
            $parser = Kernel::create(DocParser::class, [$environment]);
            $renderer = Kernel::create(HtmlRenderer::class, [$environment]);
            $html = $renderer->renderBlock($parser->parse($this->content));
        }

        return $html;
    }

    /*******************************************************************************
     * PRIVATE METHODS
     *******************************************************************************/

    /**
     * Create and return a CommonMark environment
     *
     * @return Environment CommonMark environment
     */
    protected function environment()
    {

        // Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go
        $environment = Environment::createCommonMarkEnvironment();

        // Custom environment initialization
        return $this->initializeEnvironment($environment);
    }

    /**
     * Custom environment initialization
     *
     * Overwrite this method in subclasses to register your own parsers/renderers.
     *
     * @param Environment $environment CommonMark environment
     * @return Environment CommonMark environment
     */
    protected function initializeEnvironment(Environment $environment)
    {
        // Optional: Add your own parsers/renderers here, if desired
        // For example:  $environment->addInlineParser(Kernel::create(TwitterHandleParser::class));

        return $environment;
    }
}