syntax_plugin_description::handle() - Code Metrics - Inspection of "Some refactoring and reformatting" - mprins/dokuwiki-plugin-description - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

by Mark

created 2025-02-06 22:00 UTC

syntax_plugin_description::handle() A

↳ Parent: syntax_plugin_description

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	3
c	1
b	0
f	0
dl	0
loc	6
rs	10
cc	1
nc	1
nop	4

<?php

/**
 * Description plugin.
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Matthias Schulte <[email protected]>
 * @author     Mark C. Prins <[email protected]>
 *
 * @phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
 * @noinspection AutoloadingIssuesInspection
 */

use dokuwiki\Extension\SyntaxPlugin;
filter:
    dependency_paths: ["lib/*"]

class syntax_plugin_description extends SyntaxPlugin
{
    final  public function getType(): string
    {
        return 'substition';
    }

    final public function getPType(): string
    {
        return 'block';
    }

    final  public function getSort(): int
    {
        return 98;
    }

    final  public function connectTo($mode): void
    {
        $this->Lexer->addSpecialPattern('\{\{description>.+?\}\}', $mode, 'plugin_description');
    }

    final public function handle($match, $state, $pos, Doku_Handler $handler): array
filter:
    dependency_paths: ["lib/*"]
    {
        $match = substr($match, 14, -2); // strip markup
        $match = hsc($match);

        return [$match];
    }

    final public function render($format, Doku_Renderer $renderer, $data): bool
filter:
    dependency_paths: ["lib/*"]
    {
        $description = $data[0];
        if (empty($description)) {
            return false;
        }

        if ($format === 'metadata') {
            $renderer->meta['plugin_description']['keywords'] = $description;
            return true;
        }
        return false;
    }
}


1			<?php
2
3			/**
4			* Description plugin.
5			*
6			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
7			* @author Matthias Schulte <[email protected]>
8			* @author Mark C. Prins <[email protected]>
9			*
10			* @phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
11			* @noinspection AutoloadingIssuesInspection
12			*/
13
14			use dokuwiki\Extension\SyntaxPlugin;
			1 ignored issue – show Bug introduced 2025-02-03 11:08 UTC by Report Bug Copy Issue Report The type `dokuwiki\Extension\SyntaxPlugin` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15
16			class syntax_plugin_description extends SyntaxPlugin
17			{
18			final public function getType(): string
19			{
20			return 'substition';
21			}
22
23			final public function getPType(): string
24			{
25			return 'block';
26			}
27
28			final public function getSort(): int
29			{
30			return 98;
31			}
32
33			final public function connectTo($mode): void
34			{
35			$this->Lexer->addSpecialPattern('\{\{description>.+?\}\}', $mode, 'plugin_description');
36			}
37
38			final public function handle($match, $state, $pos, Doku_Handler $handler): array
			1 ignored issue – show Bug introduced 2025-02-03 10:54 UTC by Report Bug Copy Issue Report The type `Doku_Handler` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
39			{
40			$match = substr($match, 14, -2); // strip markup
41			$match = hsc($match);
42
43			return [$match];
44			}
45
46			final public function render($format, Doku_Renderer $renderer, $data): bool
			1 ignored issue – show Bug introduced 2025-02-03 10:54 UTC by Report Bug Copy Issue Report The type `Doku_Renderer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
47			{
48			$description = $data[0];
49			if (empty($description)) {
50			return false;
51			}
52
53			if ($format === 'metadata') {
54			$renderer->meta['plugin_description']['keywords'] = $description;
55			return true;
56			}
57			return false;
58			}
59			}
60

mprins / dokuwiki-plugin-description

Pull Request — master (#4)

syntax_plugin_description::handle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like