Jaxon\Request\Plugin\CallableDir

Complexity

Total Complexity

18

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getName()	0	4	1
A	checkDirectory()	0	13	3
A	checkOptions()	0	20	4
A	register()	0	30	5
A	generateHash()	0	4	1
A	getScript()	0	4	1
A	canProcessRequest()	0	4	1
A	processRequest()	0	4	1

<?php

/**
 * CallableDir.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\Request\Plugin;

use Jaxon\Jaxon;
use Jaxon\Plugin\Request as RequestPlugin;
use Jaxon\Request\Support\CallableRegistry;

class CallableDir extends RequestPlugin

Missing doc comment for class CallableDir

{
    use \Jaxon\Features\Translator;

    /**
     * The callable registrar
     *
     * @var CallableRegistry
     */
    protected $xRegistry;

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

Missing parameter comment

Expected 1 spaces after parameter type; 8 found

     */
    public function __construct(CallableRegistry $xRegistry)
    {
        $this->xRegistry = $xRegistry;
    }

    /**
     * Return the name of this plugin
     *
     * @return string
     */
    public function getName()
    {
        return Jaxon::CALLABLE_DIR;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 5 found

     *
     * @return string
     * @throws \Jaxon\Exception\Error
     */
    private function checkDirectory($sDirectory)
    {
        if(!is_string($sDirectory))
        {
            throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
        }
        $sDirectory = rtrim(trim($sDirectory), '/\\');

Consider using a different name than the parameter $sDirectory. This often makes code more readable.

        if(!is_dir($sDirectory))
        {
            throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
        }
        return realpath($sDirectory);
    }

    /**
     * Check the options
     *
     * @param array|string  $aOptions       The associated options

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 7 found

     *
     * @return array
     * @throws \Jaxon\Exception\Error
     */
    private function checkOptions($aOptions)
    {
        if(is_string($aOptions))
        {
            $aOptions = ['namespace' => $aOptions];

Consider using a different name than the parameter $aOptions. This often makes code more readable.

        }
        if(!is_array($aOptions))
        {
            throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
        }

        // Change the keys in $aOptions to have "\" as separator
        $_aOptions = [];
        foreach($aOptions 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;
    }

    /**
     * Register a callable class
     *
     * @param string        $sType          The type of request handler being registered

Expected 7 spaces after parameter type; 8 found

Expected 6 spaces after parameter name; 10 found

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

Expected 7 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 5 found

     * @param array|string  $aOptions       The associated options

Expected 1 spaces after parameter type; 2 found

Expected 3 spaces after parameter name; 7 found

     *
     * @return boolean
     */
    public function register($sType, $sDirectory, $aOptions)
    {
        $sType = trim($sType);

Consider using a different name than the parameter $sType. This often makes code more readable.

        if($sType != $this->getName())
        {
            return false;
        }

        $sDirectory = $this->checkDirectory($sDirectory);

Consider using a different name than the parameter $sDirectory. This often makes code more readable.

        $aOptions = $this->checkOptions($aOptions);

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

Consider using a different name than the parameter $aOptions. This often makes code more readable.

        $aOptions['directory'] = $sDirectory;

        $sNamespace = key_exists('namespace', $aOptions) ? $aOptions['namespace'] : '';
        if(!($sNamespace = trim($sNamespace, ' \\')))

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

        {
            $sNamespace = '';
        }

        if(($sNamespace))
        {
            $this->xRegistry->addNamespace($sNamespace, $aOptions);
        }
        else
        {
            $this->xRegistry->addDirectory($sDirectory, $aOptions);
        }

        return true;
    }

    /**
     * Generate a hash for the registered callable objects
     *
     * @return string
     */
    public function generateHash()
    {
        return '';
    }

    /**
     * Generate client side javascript code for the registered callable objects
     *
     * @return string
     */
    public function getScript()
    {
        return '';
    }

    /**
     * Check if this plugin can process the incoming Jaxon request
     *
     * @return boolean
     */
    public function canProcessRequest()
    {
        return false;
    }

    /**
     * Process the incoming Jaxon request
     *
     * @return boolean
     */
    public function processRequest()
    {
        return false;
    }
}