Package::factory() - Code Metrics - Inspection of "Tests on registration with Jaxon App." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e82656...5198fb )

by Thierry

created 2022-04-01 13:20 UTC

Package::factory() A

↳ Parent: Package

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Package.php
 *
 * Package.
 *
 * @package jaxon-core

 * @author 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;

use Jaxon\Plugin\Contract\CodeGeneratorInterface;
use Jaxon\Request\Factory;
use Jaxon\Ui\View\ViewRenderer;
use Jaxon\Utils\Config\Config;

abstract class Package implements CodeGeneratorInterface

{
    /**
     * The configuration options of the package
     *
     * @var Config
     */
    protected $xPkgConfig;


    /**
     * The request factory
     * 
     * @var Factory
     */
    protected $xFactory;

    /**
     * The view renderer
     *
     * @var ViewRenderer
     */
    protected $xRenderer;

    /**
     * Whether to include the getReadyScript() in the generated code.
     *
     * @var bool

     */
    protected $bReadyEnabled = false;

    /**
     * Get the path to the config file, or the config options in an array.
     *
     * @return string|array
     */
    abstract public static function config();


    /**
     * Get the value of a given package option
     *
     * @param string $sOption    The option name

     * @param mixed $xDefault    The default value

     *
     * @return mixed
     */
    public function getOption(string $sOption, $xDefault = null)
    {
        return $this->xPkgConfig->getOption($sOption, $xDefault);
    }


    /**
     * Get the request factory
     *
     * @return Factory
     */
    public function factory(): Factory
    {
        return $this->xFactory;
    }


    /**
     * Get the view renderer
     *
     * @return ViewRenderer
     */
    public function view(): ViewRenderer
    {
        return $this->xRenderer;
    }


    /**
     * Include the getReadyScript() in the generated code.
     *
     * @return void
     */
    public function ready()
    {
        $this->bReadyEnabled = true;
    }


    /**
     * @inheritDoc
     */

    public function readyEnabled(): bool
    {
        return $this->bReadyEnabled;
    }


    /**
     * @inheritDoc
     */

    public final function readyInlined(): bool
    {
        // For packages, the getReadyScript() is never exported to external files.
        return true;
    }


    /**
     * @inheritDoc
     */

    public final function getHash(): string
    {
        // Packages do not generate hash on their own. So we make this method final.
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getCss(): string
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getJs(): string
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getScript(): string
    {
        return '';
    }


    /**
     * @inheritDoc
     */

    public function getReadyScript(): string
    {
        return '';
    }


    /**
     * Get the HTML code of the package home page
     *
     * @return string
     */
    abstract public function getHtml(): string;


    /**
     * Get the HTML code of the package home page
     *
     * This method is an alias for getHtml().
     *
     * @return string
     */
    public function html(): string
    {
        return $this->getHtml();
    }

}


1			<?php
2
3			/**
4			* Package.php
5			*
6			* Package.
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 Thierry Feuzeu <[email protected]>
10			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
11			* @link https://github.com/jaxon-php/jaxon-core
12			*/
			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...
13
14			namespace Jaxon\Plugin;
15
16			use Jaxon\Plugin\Contract\CodeGeneratorInterface;
17			use Jaxon\Request\Factory;
18			use Jaxon\Ui\View\ViewRenderer;
19			use Jaxon\Utils\Config\Config;
20
21			abstract class Package implements CodeGeneratorInterface
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing doc comment for class Package Loading history...
22			{
23			/**
24			* The configuration options of the package
25			*
26			* @var Config
27			*/
28			protected $xPkgConfig;
			0 ignored issues – show Coding Style introduced 2019-12-14 10:40 UTC by Report Bug Copy Issue Report Expected 1 blank line(s) before first member var; 0 found Loading history...
29
30			/**
31			* The request factory
32			*
33			* @var Factory
34			*/
35			protected $xFactory;
36
37			/**
38			* The view renderer
39			*
40			* @var ViewRenderer
41			*/
42			protected $xRenderer;
43
44			/**
45			* Whether to include the getReadyScript() in the generated code.
46			*
47			* @var bool
			0 ignored issues – show Bug introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected "boolean" but found "bool" for @var tag in member variable comment Loading history...
48			*/
49			protected $bReadyEnabled = false;
50
51			/**
52			* Get the path to the config file, or the config options in an array.
53			*
54			* @return string\|array
55			*/
56			abstract public static function config();
			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... Coding Style introduced 2019-12-14 10:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
57
58			/**
59			* Get the value of a given package option
60			*
61			* @param string $sOption The option name
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 4 found Loading history...
62			* @param mixed $xDefault The default value
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history... Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 4 found Loading history...
63			*
64			* @return mixed
65			*/
66			public function getOption(string $sOption, $xDefault = null)
67			{
68			return $this->xPkgConfig->getOption($sOption, $xDefault);
69			}
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
70
71			/**
72			* Get the request factory
73			*
74			* @return Factory
75			*/
76			public function factory(): Factory
77			{
78			return $this->xFactory;
79			}
			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...
80
81			/**
82			* Get the view renderer
83			*
84			* @return ViewRenderer
85			*/
86			public function view(): ViewRenderer
87			{
88			return $this->xRenderer;
89			}
			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...
90
91			/**
92			* Include the getReadyScript() in the generated code.
93			*
94			* @return void
95			*/
96			public function ready()
97			{
98			$this->bReadyEnabled = true;
99			}
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
100
101			/**
102			* @inheritDoc
103			*/
			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...
104			public function readyEnabled(): bool
105			{
106			return $this->bReadyEnabled;
107			}
			0 ignored issues – show Coding Style introduced 2019-12-14 15:02 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
108
109			/**
110			* @inheritDoc
111			*/
			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...
112			public final function readyInlined(): bool
113			{
114			// For packages, the getReadyScript() is never exported to external files.
115			return true;
116			}
			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...
117
118			/**
119			* @inheritDoc
120			*/
			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...
121			public final function getHash(): string
122			{
123			// Packages do not generate hash on their own. So we make this method final.
124			return '';
125			}
			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...
126
127			/**
128			* @inheritDoc
129			*/
			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...
130			public function getCss(): string
131			{
132			return '';
133			}
			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...
134
135			/**
136			* @inheritDoc
137			*/
			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...
138			public function getJs(): string
139			{
140			return '';
141			}
			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...
142
143			/**
144			* @inheritDoc
145			*/
			0 ignored issues – show Coding Style introduced 2019-12-11 23:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
146			public function getScript(): string
147			{
148			return '';
149			}
			0 ignored issues – show Coding Style introduced 2019-12-11 23:56 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
150
151			/**
152			* @inheritDoc
153			*/
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
154			public function getReadyScript(): string
155			{
156			return '';
157			}
			0 ignored issues – show Coding Style introduced 2022-04-01 13:22 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
158
159			/**
160			* Get the HTML code of the package home page
161			*
162			* @return string
163			*/
164			abstract public function getHtml(): string;
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
165
166			/**
167			* Get the HTML code of the package home page
168			*
169			* This method is an alias for getHtml().
170			*
171			* @return string
172			*/
173			public function html(): string
174			{
175			return $this->getHtml();
176			}
			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...
177			}
178

jaxon-php / jaxon-core

Push — master ( e82656...5198fb )

Package::factory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like