Plugin::readyEnabled() - Code Metrics - Inspection of "Updated version." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b8ef91...1702ae )

by Thierry

created 2019-12-08 04:43 UTC

Plugin::readyEnabled() A

↳ Parent: Plugin

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
c	0
b	0
f	0
cc	1
nc	1
nop	0
rs	10

<?php

/**
 * Plugin.php - Plugin interface
 *
 * Generic interface for all Jaxon plugins.
 *
 * @package jaxon-core

 * @author Jared White

 * @author J. Max Wilson

 * @author Joseph Woolley

 * @author Steffen Konerow

 * @author Thierry Feuzeu <[email protected]>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

 * @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson

 * @copyright 2016 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */


namespace Jaxon\Plugin;

abstract class Plugin implements Code\Contracts\Generator

{
    use \Jaxon\Features\Config;

    /**
     * Check if the assets of this plugin shall be included in Jaxon generated code.
     *
     * @return boolean
     */
    protected function includeAssets()

    {
        $sPluginOptionName = 'assets.include.' . $this->getName();
        if($this->hasOption($sPluginOptionName) && !$this->getOption($sPluginOptionName))
        {
            return false;
        }
        if($this->hasOption('assets.include.all') && !$this->getOption('assets.include.all'))
        {
            return false;
        }
        return true;
    }


    /**
     * Get a unique name to identify the plugin.
     *
     * @return string
     */
    abstract public function getName();


    /**
     * @inheritDoc
     */

    public final function readyEnabled()
    {
        // For plugins, the getReadyScript() is always included in the generated code.
        return true;
    }


    /**
     * @inheritDoc
     */

    public function getHash()
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getCss()
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getJs()
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getScript()
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getReadyScript()
    {
        return '';
    }

}


1			<?php
2
3			/**
4			* Plugin.php - Plugin interface
5			*
6			* Generic interface for all Jaxon plugins.
7			*
8			* @package jaxon-core
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Package name "jaxon-core" is not valid; consider "Jaxoncore" instead Loading history...
9			* @author Jared White
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
10			* @author J. Max Wilson
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
11			* @author Joseph Woolley
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
12			* @author Steffen Konerow
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
13			* @author Thierry Feuzeu <[email protected]>
14			* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
15			* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
16			* @copyright 2016 Thierry Feuzeu <[email protected]>
17			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
18			* @link https://github.com/jaxon-php/jaxon-core
19			*/
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history...
20
21			namespace Jaxon\Plugin;
22
23			abstract class Plugin implements Code\Contracts\Generator
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing doc comment for class Plugin Loading history...
24			{
25			use \Jaxon\Features\Config;
26
27			/**
28			* Check if the assets of this plugin shall be included in Jaxon generated code.
29			*
30			* @return boolean
31			*/
32			protected function includeAssets()
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
33			{
34			$sPluginOptionName = 'assets.include.' . $this->getName();
35			if($this->hasOption($sPluginOptionName) && !$this->getOption($sPluginOptionName))
36			{
37			return false;
38			}
39			if($this->hasOption('assets.include.all') && !$this->getOption('assets.include.all'))
40			{
41			return false;
42			}
43			return true;
44			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
45
46			/**
47			* Get a unique name to identify the plugin.
48			*
49			* @return string
50			*/
51			abstract public function getName();
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
52
53			/**
54			* @inheritDoc
55			*/
			0 ignored issues – show Coding Style introduced 2019-12-08 04:45 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
56			public final function readyEnabled()
57			{
58			// For plugins, the getReadyScript() is always included in the generated code.
59			return true;
60			}
			0 ignored issues – show Coding Style introduced 2019-12-08 04:45 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
61
62			/**
63			* @inheritDoc
64			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
65			public function getHash()
66			{
67			return '';
68			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
69
70			/**
71			* @inheritDoc
72			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
73			public function getCss()
74			{
75			return '';
76			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
77
78			/**
79			* @inheritDoc
80			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
81			public function getJs()
82			{
83			return '';
84			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
85
86			/**
87			* @inheritDoc
88			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
89			public function getScript()
90			{
91			return '';
92			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
93
94			/**
95			* @inheritDoc
96			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
97			public function getReadyScript()
98			{
99			return '';
100			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history...
101			}
102

jaxon-php / jaxon-core

Push — master ( b8ef91...1702ae )

Plugin::readyEnabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like