Doku_Parser_Mode_smiley::preConnect() - Code Metrics - Inspection of "split out parser modes into their own files" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2 ( de3699...36dc94 )

by Andreas

created 2018-04-28 10:14 UTC

Doku_Parser_Mode_smiley::preConnect() A

↳ Parent: Project

Complexity

Conditions	4
Paths	3

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

use dokuwiki\ParserMode\Base;
use dokuwiki\ParserMode\ModeInterface;

/**
 * Define various types of modes used by the parser - they are used to
 * populate the list of modes another mode accepts
 */
global $PARSER_MODES;
$PARSER_MODES = array(
    // containers are complex modes that can contain many other modes
    // hr breaks the principle but they shouldn't be used in tables / lists
    // so they are put here
    'container'    => array('listblock','table','quote','hr'),

    // some mode are allowed inside the base mode only
    'baseonly'     => array('header'),

    // modes for styling text -- footnote behaves similar to styling
    'formatting'   => array('strong', 'emphasis', 'underline', 'monospace',
                            'subscript', 'superscript', 'deleted', 'footnote'),

    // modes where the token is simply replaced - they can not contain any
    // other modes
    'substition'   => array('acronym','smiley','wordblock','entity',
                            'camelcaselink', 'internallink','media',
                            'externallink','linebreak','emaillink',
                            'windowssharelink','filelink','notoc',
                            'nocache','multiplyentity','quotes','rss'),

    // modes which have a start and end token but inside which
    // no other modes should be applied
    'protected'    => array('preformatted','code','file','php','html','htmlblock','phpblock'),

    // inside this mode no wiki markup should be applied but lineendings
    // and whitespace isn't preserved
    'disabled'     => array('unformatted'),

    // used to mark paragraph boundaries
    'paragraphs'   => array('eol')
);

//-------------------------------------------------------------------

/**
 * Sets up the Lexer with modes and points it to the Handler
 * For an intro to the Lexer see: wiki:parser
 */
class Doku_Parser {

    var $Handler;

    /**
     * @var Doku_Lexer $Lexer
     */
    var $Lexer;

    var $modes = array();

    var $connected = false;

    /**
     * @param Base $BaseMode
     */
    function addBaseMode($BaseMode) {

        $this->modes['base'] = $BaseMode;
        if ( !$this->Lexer ) {
            $this->Lexer = new Doku_Lexer($this->Handler,'base', true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        $this->modes['base']->Lexer = $this->Lexer;
    }

    /**
     * PHP preserves order of associative elements
     * Mode sequence is important
     *
     * @param string $name
     * @param ModeInterface $Mode
     */
    function addMode($name, ModeInterface $Mode) {

        if ( !isset($this->modes['base']) ) {
            $this->addBaseMode(new Base());
        }
        $Mode->Lexer = $this->Lexer;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $this->modes[$name] = $Mode;
    }

    function connectModes() {


        if ( $this->connected ) {
            return;
        }

        foreach ( array_keys($this->modes) as $mode ) {

            // Base isn't connected to anything
            if ( $mode == 'base' ) {
                continue;
            }
            $this->modes[$mode]->preConnect();

            foreach ( array_keys($this->modes) as $cm ) {

                if ( $this->modes[$cm]->accepts($mode) ) {
                    $this->modes[$mode]->connectTo($cm);
                }

            }

            $this->modes[$mode]->postConnect();
        }

        $this->connected = true;
    }

    function parse($doc) {

        if ( $this->Lexer ) {
            $this->connectModes();
            // Normalize CRs and pad doc
            $doc = "\n".str_replace("\r\n","\n",$doc)."\n";
            $this->Lexer->parse($doc);
            $this->Handler->_finalize();
            return $this->Handler->calls;
        } else {
            return false;
        }
    }

}


//Setup VIM: ex: et ts=4 :


1			<?php
2
3			use dokuwiki\ParserMode\Base;
4			use dokuwiki\ParserMode\ModeInterface;
5
6			/**
7			* Define various types of modes used by the parser - they are used to
8			* populate the list of modes another mode accepts
9			*/
10			global $PARSER_MODES;
11			$PARSER_MODES = array(
12			// containers are complex modes that can contain many other modes
13			// hr breaks the principle but they shouldn't be used in tables / lists
14			// so they are put here
15			'container' => array('listblock','table','quote','hr'),
16
17			// some mode are allowed inside the base mode only
18			'baseonly' => array('header'),
19
20			// modes for styling text -- footnote behaves similar to styling
21			'formatting' => array('strong', 'emphasis', 'underline', 'monospace',
22			'subscript', 'superscript', 'deleted', 'footnote'),
23
24			// modes where the token is simply replaced - they can not contain any
25			// other modes
26			'substition' => array('acronym','smiley','wordblock','entity',
27			'camelcaselink', 'internallink','media',
28			'externallink','linebreak','emaillink',
29			'windowssharelink','filelink','notoc',
30			'nocache','multiplyentity','quotes','rss'),
31
32			// modes which have a start and end token but inside which
33			// no other modes should be applied
34			'protected' => array('preformatted','code','file','php','html','htmlblock','phpblock'),
35
36			// inside this mode no wiki markup should be applied but lineendings
37			// and whitespace isn't preserved
38			'disabled' => array('unformatted'),
39
40			// used to mark paragraph boundaries
41			'paragraphs' => array('eol')
42			);
43
44			//-------------------------------------------------------------------
45
46			/**
47			* Sets up the Lexer with modes and points it to the Handler
48			* For an intro to the Lexer see: wiki:parser
49			*/
50			class Doku_Parser {
51
52			var $Handler;
53
54			/**
55			* @var Doku_Lexer $Lexer
56			*/
57			var $Lexer;
58
59			var $modes = array();
60
61			var $connected = false;
62
63			/**
64			* @param Base $BaseMode
65			*/
66			function addBaseMode($BaseMode) {
			0 ignored issues – show Best Practice introduced 2015-11-25 07:06 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...
67			$this->modes['base'] = $BaseMode;
68			if ( !$this->Lexer ) {
69			$this->Lexer = new Doku_Lexer($this->Handler,'base', true);
			0 ignored issues – show Documentation introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report `$this->Handler` is of type `object<Doku_Handler>`, but the function expects a `object<Doku_Parser>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
70			}
71			$this->modes['base']->Lexer = $this->Lexer;
72			}
73
74			/**
75			* PHP preserves order of associative elements
76			* Mode sequence is important
77			*
78			* @param string $name
79			* @param ModeInterface $Mode
80			*/
81			function addMode($name, ModeInterface $Mode) {
			0 ignored issues – show Best Practice introduced 2018-04-28 10:18 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...
82			if ( !isset($this->modes['base']) ) {
83			$this->addBaseMode(new Base());
84			}
85			$Mode->Lexer = $this->Lexer;
			0 ignored issues – show Bug introduced 2018-04-28 10:18 UTC by Report Bug Copy Issue Report Accessing `Lexer` on the interface `dokuwiki\ParserMode\ModeInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
86			$this->modes[$name] = $Mode;
87			}
88
89			function connectModes() {
			0 ignored issues – show Best Practice introduced 2015-11-25 07:06 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...
90
91			if ( $this->connected ) {
92			return;
93			}
94
95			foreach ( array_keys($this->modes) as $mode ) {
96
97			// Base isn't connected to anything
98			if ( $mode == 'base' ) {
99			continue;
100			}
101			$this->modes[$mode]->preConnect();
102
103			foreach ( array_keys($this->modes) as $cm ) {
104
105			if ( $this->modes[$cm]->accepts($mode) ) {
106			$this->modes[$mode]->connectTo($cm);
107			}
108
109			}
110
111			$this->modes[$mode]->postConnect();
112			}
113
114			$this->connected = true;
115			}
116
117			function parse($doc) {
			0 ignored issues – show Best Practice introduced 2015-11-25 07:06 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...
118			if ( $this->Lexer ) {
119			$this->connectModes();
120			// Normalize CRs and pad doc
121			$doc = "\n".str_replace("\r\n","\n",$doc)."\n";
122			$this->Lexer->parse($doc);
123			$this->Handler->_finalize();
124			return $this->Handler->calls;
125			} else {
126			return false;
127			}
128			}
129
130			}
131
132
133			//Setup VIM: ex: et ts=4 :
134

splitbrain / dokuwiki

Push — psr2 ( de3699...36dc94 )

Doku_Parser_Mode_smiley::preConnect() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like