Hyde\Framework\Concerns\Internal\SetsUpMarkdownConverter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	registerPreProcessor()	0	4	3
A	registerPostProcessor()	0	4	3
A	enableDynamicExtensions()	0	8	3
A	enableConfigDefinedExtensions()	0	4	2
A	registerPostProcessors()	0	13	1
A	mergeMarkdownConfiguration()	0	3	1
A	initializeExtension()	0	3	1
A	registerPreProcessors()	0	6	1

<?php

declare(strict_types=1);

namespace Hyde\Framework\Concerns\Internal;

use Hyde\Facades\Config;
use Hyde\Markdown\Processing\BladeDownProcessor;
use Hyde\Markdown\Processing\ShortcodeProcessor;
use Hyde\Markdown\Processing\CodeblockFilepathProcessor;
use Hyde\Markdown\Processing\DynamicMarkdownLinkProcessor;
use Torchlight\Commonmark\V2\TorchlightExtension;

use function array_merge;
use function in_array;

/**
 * Sets up the Markdown converter for the Markdown service.
 *
 * @internal This trait is not covered by the backward compatibility promise.
 *
 * @see \Hyde\Framework\Services\MarkdownService
 */
trait SetsUpMarkdownConverter
{
    protected function enableDynamicExtensions(): void
    {
        if ($this->canEnableTorchlight()) {

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

            $this->addExtension(TorchlightExtension::class);

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

        }

        if (Config::getBool('markdown.allow_html', false)) {
            $this->enableAllHtmlElements();

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

        }
    }

    protected function enableConfigDefinedExtensions(): void
    {
        foreach (Config::getArray('markdown.extensions', []) as $extensionClassName) {
            $this->addExtension($extensionClassName);
        }
    }

    protected function mergeMarkdownConfiguration(): void
    {
        $this->config = array_merge(Config::getArray('markdown.config', []), $this->config);

The property config does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    public function initializeExtension(string $extensionClassName): void
    {
        $this->converter->getEnvironment()->addExtension(new $extensionClassName());
    }

    protected function registerPreProcessors(): void
    {
        $this->registerPreProcessor(BladeDownProcessor::class, Config::getBool('markdown.enable_blade', false));

        $this->registerPreProcessor(ShortcodeProcessor::class);
        $this->registerPreProcessor(CodeblockFilepathProcessor::class);
    }

    protected function registerPostProcessors(): void
    {
        $this->registerPostProcessor(
            BladeDownProcessor::class,
            Config::getBool('markdown.enable_blade', false)
        );

        $this->registerPostProcessor(
            CodeblockFilepathProcessor::class,
            Config::getBool('markdown.features.codeblock_filepaths', true)
        );

        $this->registerPostProcessor(DynamicMarkdownLinkProcessor::class);
    }

    protected function registerPreProcessor(string $class, bool $when = true): void
    {
        if (! in_array($class, $this->preprocessors) && $when) {
            $this->preprocessors[] = $class;

The property preprocessors does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }
    }

    protected function registerPostProcessor(string $class, bool $when = true): void
    {
        if (! in_array($class, $this->postprocessors) && $when) {
            $this->postprocessors[] = $class;

The property postprocessors does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }
    }
}