syntax_plugin_backlinks::render() - Code Metrics - Inspection of "use trusty test environment (#20)" - mprins/dokuwiki-plugin-backlinks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ad505...5b32c8 )

by Mark

created 2017-08-17 12:58 UTC

syntax_plugin_backlinks::render() B

↳ Parent: syntax_plugin_backlinks

Complexity

Conditions	8
Paths	7

Size

Total Lines	56
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	7.3333
c	0
b	0
f	0
cc	8
eloc	35
nc	7
nop	3

How to fix Long Method

<?php
/**
 * DokuWiki Syntax Plugin Backlinks.
 *
 * Shows a list of pages that link back to a given page.
 *
 * Syntax:  {{backlinks>[pagename][#filterNS|!#filterNS]}}
 *
 *   [pagename] - a valid wiki pagename or a . for the current page
 *   [filterNS] - a valid,absolute namespace name, optionally prepended with ! to exclude
 *
 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author  Michael Klier <[email protected]>
 * @author  Mark C. Prins <[email protected]>
 */
if (!defined('DOKU_INC')) {
    die();
}

if (!defined('DOKU_PLUGIN')) {
    define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
}
if (!defined('DW_LF')) {
    define('DW_LF', "\n");
}

require_once(DOKU_PLUGIN.'syntax.php');
require_once(DOKU_INC.'inc/parserutils.php');

/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_backlinks extends DokuWiki_Syntax_Plugin {
    /**
     * Syntax Type.
     *
     * Needs to return one of the mode types defined in $PARSER_MODES in parser.php
     * @see DokuWiki_Syntax_Plugin::getType()
     */
    function getType() { return 'substition'; }


    /**
     * @see DokuWiki_Syntax_Plugin::getPType()
     */
    function getPType() { return 'block'; }


    /**
     * @see Doku_Parser_Mode::getSort()
     */
    function getSort() { return 304; }


    /**
     * Connect pattern to lexer.
     * @see Doku_Parser_Mode::connectTo()
     */
    function connectTo($mode) {

        $this->Lexer->addSpecialPattern('\{\{backlinks>.+?\}\}', $mode, 'plugin_backlinks');
    }

    /**
     * Handler to prepare matched data for the rendering process.
     * @see DokuWiki_Syntax_Plugin::handle()
     */
    function handle($match, $state, $pos, Doku_Handler $handler) {

        // Take the id of the source
        // It can be a rendering of a sidebar
        global $INFO;
        global $ID;
        $id = $ID;
        // If it's a sidebar, get the original id.
        if ($INFO != null) {
            $id = $INFO['id'];
        }

        // strip {{backlinks> from start and }} from end
        $match = substr($match, 12, -2);

        if (strstr($match, "#")) {
            $includeNS = substr(strstr($match, "#", FALSE), 1);
            $match = strstr($match, "#", TRUE);
        }

        $match = ($match == '.') ? $id : $match;

        if (strstr($match, ".:")) {
            resolve_pageid(getNS($id), $match, $exists);

        }

        return (array($match, $includeNS));
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Handles the actual output creation.
     * @see DokuWiki_Syntax_Plugin::render()
     */
    function render($mode, Doku_Renderer $renderer, $data) {

        global $lang;

        if ($mode == 'xhtml') {
            $renderer->info['cache'] = false;

            @require_once(DOKU_INC.'inc/fulltext.php');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            $backlinks = ft_backlinks($data[0]);

            dbglog($backlinks, "backlinks: all backlinks to: $data[0]");

            $renderer->doc .= '<div id="plugin__backlinks">'.DW_LF;

            $filterNS = $data[1];
            if (!empty($backlinks) && !empty($filterNS)) {
                if (stripos($filterNS, "!", 0) === 0) {
                    $filterNS = substr($filterNS, 1);
                    dbglog($filterNS, "backlinks: exluding all of namespace: $filterNS");
                    $backlinks = array_filter($backlinks, function($ns) use($filterNS) {
                        return stripos($ns, $filterNS, 0) !== 0;
                    });
                } else {
                    dbglog($filterNS, "backlinks: including namespace: $filterNS only");
                    $backlinks = array_filter($backlinks, function($ns) use($filterNS) {
                        return stripos($ns, $filterNS, 0) === 0;
                    });
                }
            }

            dbglog($backlinks, "backlinks: all backlinks to be rendered");

            if (!empty($backlinks)) {

                $renderer->doc .= '<ul class="idx">';

                foreach ($backlinks as $backlink) {
                    $name = p_get_metadata($backlink, 'title');
                    if (empty($name)) {
                        $name = $backlink;
                    }
                    $renderer->doc .= '<li><div class="li">';
                    $renderer->doc .= html_wikilink(':'.$backlink, $name);
                    $renderer->doc .= '</div></li>'.DW_LF;
                }

                $renderer->doc .= '</ul>'.DW_LF;
            } else {
                $renderer->doc .= "<strong>Plugin Backlinks: ".$lang['nothingfound']."</strong>".DW_LF;
            }

            $renderer->doc .= '</div>'.DW_LF;

            return true;
        }
        return false;
    }
}


1			<?php
2			/**
3			* DokuWiki Syntax Plugin Backlinks.
4			*
5			* Shows a list of pages that link back to a given page.
6			*
7			* Syntax: {{backlinks>[pagename][#filterNS\|!#filterNS]}}
8			*
9			* [pagename] - a valid wiki pagename or a . for the current page
10			* [filterNS] - a valid,absolute namespace name, optionally prepended with ! to exclude
11			*
12			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
13			* @author Michael Klier <[email protected]>
14			* @author Mark C. Prins <[email protected]>
15			*/
16			if (!defined('DOKU_INC')) {
17			die();
18			}
19
20			if (!defined('DOKU_PLUGIN')) {
21			define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
22			}
23			if (!defined('DW_LF')) {
24			define('DW_LF', "\n");
25			}
26
27			require_once(DOKU_PLUGIN.'syntax.php');
28			require_once(DOKU_INC.'inc/parserutils.php');
29
30			/**
31			* All DokuWiki plugins to extend the parser/rendering mechanism
32			* need to inherit from this class
33			*/
34			class syntax_plugin_backlinks extends DokuWiki_Syntax_Plugin {
35			/**
36			* Syntax Type.
37			*
38			* Needs to return one of the mode types defined in $PARSER_MODES in parser.php
39			* @see DokuWiki_Syntax_Plugin::getType()
40			*/
41			function getType() { return 'substition'; }
			0 ignored issues – show Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
42
43			/**
44			* @see DokuWiki_Syntax_Plugin::getPType()
45			*/
46			function getPType() { return 'block'; }
			0 ignored issues – show Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
47
48			/**
49			* @see Doku_Parser_Mode::getSort()
50			*/
51			function getSort() { return 304; }
			0 ignored issues – show Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
52
53			/**
54			* Connect pattern to lexer.
55			* @see Doku_Parser_Mode::connectTo()
56			*/
57			function connectTo($mode) {
			0 ignored issues – show Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
58			$this->Lexer->addSpecialPattern('\{\{backlinks>.+?\}\}', $mode, 'plugin_backlinks');
59			}
60
61			/**
62			* Handler to prepare matched data for the rendering process.
63			* @see DokuWiki_Syntax_Plugin::handle()
64			*/
65			function handle($match, $state, $pos, Doku_Handler $handler) {
			0 ignored issues – show Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
66			// Take the id of the source
67			// It can be a rendering of a sidebar
68			global $INFO;
69			global $ID;
70			$id = $ID;
71			// If it's a sidebar, get the original id.
72			if ($INFO != null) {
73			$id = $INFO['id'];
74			}
75
76			// strip {{backlinks> from start and }} from end
77			$match = substr($match, 12, -2);
78
79			if (strstr($match, "#")) {
80			$includeNS = substr(strstr($match, "#", FALSE), 1);
81			$match = strstr($match, "#", TRUE);
82			}
83
84			$match = ($match == '.') ? $id : $match;
85
86			if (strstr($match, ".:")) {
87			resolve_pageid(getNS($id), $match, $exists);
			0 ignored issues – show Bug introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report The variable `$exists` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
88			}
89
90			return (array($match, $includeNS));
			0 ignored issues – show Bug introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report The variable `$includeNS` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
91			}
92
93			/**
94			* Handles the actual output creation.
95			* @see DokuWiki_Syntax_Plugin::render()
96			*/
97			function render($mode, Doku_Renderer $renderer, $data) {
			0 ignored issues – show Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
98			global $lang;
99
100			if ($mode == 'xhtml') {
101			$renderer->info['cache'] = false;
102
103			@require_once(DOKU_INC.'inc/fulltext.php');
			0 ignored issues – show Security Best Practice introduced 2016-05-14 14:22 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
104			$backlinks = ft_backlinks($data[0]);
105
106			dbglog($backlinks, "backlinks: all backlinks to: $data[0]");
107
108			$renderer->doc .= '<div id="plugin__backlinks">'.DW_LF;
109
110			$filterNS = $data[1];
111			if (!empty($backlinks) && !empty($filterNS)) {
112			if (stripos($filterNS, "!", 0) === 0) {
113			$filterNS = substr($filterNS, 1);
114			dbglog($filterNS, "backlinks: exluding all of namespace: $filterNS");
115			$backlinks = array_filter($backlinks, function($ns) use($filterNS) {
116			return stripos($ns, $filterNS, 0) !== 0;
117			});
118			} else {
119			dbglog($filterNS, "backlinks: including namespace: $filterNS only");
120			$backlinks = array_filter($backlinks, function($ns) use($filterNS) {
121			return stripos($ns, $filterNS, 0) === 0;
122			});
123			}
124			}
125
126			dbglog($backlinks, "backlinks: all backlinks to be rendered");
127
128			if (!empty($backlinks)) {
129
130			$renderer->doc .= '<ul class="idx">';
131
132			foreach ($backlinks as $backlink) {
133			$name = p_get_metadata($backlink, 'title');
134			if (empty($name)) {
135			$name = $backlink;
136			}
137			$renderer->doc .= '<li><div class="li">';
138			$renderer->doc .= html_wikilink(':'.$backlink, $name);
139			$renderer->doc .= '</div></li>'.DW_LF;
140			}
141
142			$renderer->doc .= '</ul>'.DW_LF;
143			} else {
144			$renderer->doc .= "<strong>Plugin Backlinks: ".$lang['nothingfound']."</strong>".DW_LF;
145			}
146
147			$renderer->doc .= '</div>'.DW_LF;
148
149			return true;
150			}
151			return false;
152			}
153			}
154

mprins / dokuwiki-plugin-backlinks

Push — master ( 5ad505...5b32c8 )

syntax_plugin_backlinks::render() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like