Jaxon\Plugin\Package

Complexity

Total Complexity

8

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptions()	0	4	1
A	view()	0	4	1
	getConfigFile()	0	1	?
A	ready()	0	4	1
A	readyEnabled()	0	4	1
A	getHash()	0	5	1
A	getCss()	0	4	1
A	getJs()	0	4	1
A	getScript()	0	5	1
	getHtml()	0	1	?

<?php

/**
 * Generator.php - Code generator interface
 *
 * Any class generating css or js code must implement this interface.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Plugin;

abstract class Package implements Code\Contracts\Generator

Missing doc comment for class Package

{
    /**
     * The configuration options of the package
     *
     * @var array
     */
    protected $aOptions = [];

Expected 1 blank line(s) before first member var; 0 found

    /**
     * Whether to include the getReadyScript() in the generated code.
     *
     * @var boolean
     */
    protected $bReadyEnabled = false;

    /**
     * Get package options.
     *
     * @return array
     */
    public function getOptions()

Expected 2 blank lines before function; 1 found

    {
        return $this->aOptions;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the view renderer
     *
     * @return \Jaxon\Utils\View\Renderer
     */
    public function view()
    {
        return jaxon()->view();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the path to the config file
     *
     * @return string
     */
    abstract public static function getConfigFile();

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getCss()
    {
        return '';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getJs()
    {
        return '';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public final function getScript()
    {
        // Packages do not generate script. So we make this method final.
        return '';
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 0 found

}