Jaxon\Plugin\Request\CallableClass\CallableDirPlugin

Complexity

Total Complexity

12

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	checkDirectory()	0	8	2
A	__construct()	0	4	1
A	register()	0	9	2
A	getCallable()	0	3	1
A	checkOptions()	0	27	5
A	getName()	0	3	1

<?php

/**
 * CallableDirPlugin.php - Jaxon callable dir plugin
 *
 * This class registers directories containing user defined callable classes,
 * and generates client side javascript code.
 *
 * @package jaxon-core

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

 * @author Jared White

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author J. Max Wilson

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Joseph Woolley

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Steffen Konerow

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

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

@copyright tag must contain a year and the name of the copyright holder

 * @copyright 2016 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\Request\CallableClass;

use Jaxon\Jaxon;
use Jaxon\App\I18n\Translator;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\CallableRegistryInterface;
use Jaxon\Plugin\PluginInterface;

use function is_array;
use function is_dir;
use function is_string;
use function realpath;
use function rtrim;
use function str_replace;
use function trim;

class CallableDirPlugin implements PluginInterface, CallableRegistryInterface

Missing doc comment for class CallableDirPlugin

{
    /**
     * The callable registry
     *
     * @var CallableRegistry
     */
    protected $xRegistry;

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

    /**
     * @var Translator
     */
    protected $xTranslator;

    /**
     * The class constructor
     *
     * @param CallableRegistry  $xRegistry

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param Translator  $xTranslator

Missing parameter comment

Expected 7 spaces after parameter type; 2 found

     */
    public function __construct(CallableRegistry $xRegistry, Translator $xTranslator)

Expected 2 blank lines before function; 1 found

    {
        $this->xRegistry = $xRegistry;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $this->xTranslator = $xTranslator;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return Jaxon::CALLABLE_DIR;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check the directory
     *
     * @param string $sDirectory    The path of teh directory being registered

Expected 1 spaces after parameter name; 4 found

     *
     * @return string
     * @throws SetupException
     */
    private function checkDirectory(string $sDirectory): string
    {
        $sDirectory = rtrim(trim($sDirectory), '/\\');
        if(!is_dir($sDirectory))
        {
            throw new SetupException($this->xTranslator->trans('errors.objects.invalid-declaration'));
        }
        return realpath($sDirectory);
    }

Expected 2 blank lines after function; 1 found

    /**

Parameter $sCallable should have a doc-comment as per coding-style.

Parameter $xOptions should have a doc-comment as per coding-style.

     * @inheritDoc
     * @throws SetupException
     */

Missing @return tag in function comment

    public function checkOptions(string $sCallable, $xOptions): array
    {
        if(is_string($xOptions))
        {
            $xOptions = ['namespace' => $xOptions];
        }
        if(!is_array($xOptions))
        {
            throw new SetupException($this->xTranslator->trans('errors.objects.invalid-declaration'));
        }
        // Check the directory
        $xOptions['directory'] = $this->checkDirectory($sCallable);
        // Check the namespace
        $sNamespace = $xOptions['namespace'] ?? '';
        if(!($xOptions['namespace'] = trim($sNamespace, ' \\')))

Variable assignment found within a condition. Did you mean to do a comparison ?

        {
            $xOptions['namespace'] = '';
        }

        // Change the keys in $xOptions to have "\" as separator
        $_aOptions = [];
        foreach($xOptions as $sName => $aOption)
        {
            $sName = trim(str_replace('.', '\\', $sName), ' \\');

Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space

            $_aOptions[$sName] = $aOption;
        }
        return $_aOptions;
    }

Expected 2 blank lines after function; 1 found

    /**

Parameter $sType should have a doc-comment as per coding-style.

Parameter $sCallable should have a doc-comment as per coding-style.

Parameter $aOptions should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function register(string $sType, string $sCallable, array $aOptions): bool
    {
        if(($aOptions['namespace']))
        {
            $this->xRegistry->addNamespace($aOptions['namespace'], $aOptions);
            return true;
        }
        $this->xRegistry->addDirectory($aOptions['directory'], $aOptions);
        return true;
    }

Expected 2 blank lines after function; 1 found

    /**

Parameter $sCallable should have a doc-comment as per coding-style.

     * @inheritDoc
     * @throws SetupException
     */

Missing @return tag in function comment

    public function getCallable(string $sCallable)
    {
        return $this->xRegistry->getCallableObject($sCallable);
    }

Expected 2 blank lines after function; 0 found

}