HasMarkdownDocumentationModuleResolverTrait::addClasses() - Code Metrics - Inspection of "Externalized markdown parser into service" - GraphQLAPI/graphql-api-for-wp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( cf39f6...a305e6 )

by Leonardo

created 2020-09-21 07:26 UTC

HasMarkdownDocumentationModuleResolverTrait::addClasses() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	2
b	0
f	0
nc	1
nop	1
dl	0
loc	9
ccs	0
cts	6
cp	0
crap	2
rs	10

<?php

declare(strict_types=1);

namespace GraphQLAPI\GraphQLAPI\ModuleResolvers;

use GraphQLAPI\GraphQLAPI\ContentProcessors\ContentParserOptions;
use InvalidArgumentException;
use GraphQLAPI\GraphQLAPI\Facades\ContentProcessors\MarkdownContentParserFacade;

trait HasMarkdownDocumentationModuleResolverTrait
{
    /**
     * The module slug
     */
    abstract public function getSlug(string $module): string;

    /**
     * The name of the Markdown filename.
     * By default, it's the same as the slug
     *
     * @param string $module
     * @return string
     */
    public function getMarkdownFilename(string $module): ?string
    {
        return $this->getSlug($module) . '.md';
    }

    /**
     * Does the module have HTML Documentation?
     *
     * @param string $module
     * @return bool
     */
    public function hasDocumentation(string $module): bool
    {
        return !empty($this->getMarkdownFilename($module));
    }

    /**
     * HTML Documentation for the module
     *
     * @param string $module
     * @return string|null
     */
    public function getDocumentation(string $module): ?string
    {
        if ($markdownFilename = $this->getMarkdownFilename($module)) {
            $markdownContentParser = MarkdownContentParserFacade::getInstance();
            try {
                return $markdownContentParser->getContent(
                    'modules',
                    $markdownFilename,
                    [
                        ContentParserOptions::TAB_CONTENT => true,
                    ]
                );
            } catch (InvalidArgumentException $e) {
                return sprintf(
                    '<p>%s</p>',
                    \__('Oops, the documentation for this module is not available', 'graphql-api')
                );
            }
        }
        return null;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace GraphQLAPI\GraphQLAPI\ModuleResolvers;
6
7			use GraphQLAPI\GraphQLAPI\ContentProcessors\ContentParserOptions;
8			use InvalidArgumentException;
9			use GraphQLAPI\GraphQLAPI\Facades\ContentProcessors\MarkdownContentParserFacade;
10
11			trait HasMarkdownDocumentationModuleResolverTrait
12			{
13			/**
14			* The module slug
15			*/
16			abstract public function getSlug(string $module): string;
17
18			/**
19			* The name of the Markdown filename.
20			* By default, it's the same as the slug
21			*
22			* @param string $module
23			* @return string
24			*/
25			public function getMarkdownFilename(string $module): ?string
26			{
27			return $this->getSlug($module) . '.md';
28			}
29
30			/**
31			* Does the module have HTML Documentation?
32			*
33			* @param string $module
34			* @return bool
35			*/
36			public function hasDocumentation(string $module): bool
37			{
38			return !empty($this->getMarkdownFilename($module));
39			}
40
41			/**
42			* HTML Documentation for the module
43			*
44			* @param string $module
45			* @return string\|null
46			*/
47			public function getDocumentation(string $module): ?string
48			{
49			if ($markdownFilename = $this->getMarkdownFilename($module)) {
50			$markdownContentParser = MarkdownContentParserFacade::getInstance();
51			try {
52			return $markdownContentParser->getContent(
53			'modules',
54			$markdownFilename,
55			[
56			ContentParserOptions::TAB_CONTENT => true,
57			]
58			);
59			} catch (InvalidArgumentException $e) {
60			return sprintf(
61			'<p>%s</p>',
62			\__('Oops, the documentation for this module is not available', 'graphql-api')
63			);
64			}
65			}
66			return null;
67			}
68			}
69

GraphQLAPI / graphql-api-for-wp

GitHub Access Token became invalid

Push — master ( cf39f6...a305e6 )

HasMarkdownDocumentationModuleResolverTrait::addClasses() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like