Jaxon\Plugin\Request\CallableFunction\CallableFunction

Complexity

Total Complexity

11

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	call()	0	13	4
A	getJsName()	0	3	1
A	__construct()	0	5	1
A	getName()	0	3	1
A	getOptions()	0	3	1
A	configure()	0	13	3

<?php

/**
 * CallableFunction.php - Jaxon user function
 *
 * This class stores a reference to a user defined function which can be called from the client via an Jaxon request
 *
 * @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\CallableFunction;

class CallableFunction

Missing doc comment for class CallableFunction

{
    /**
     * The name of the function in the ajax call
     *
     * @var string
     */
    private $sFunction;

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

    /**
     * The name of the generated javascript function
     *
     * @var string
     */
    private $sJsFunction;

    /**
     * A string or an array which defines the registered PHP function
     *
     * @var string|array
     */
    private $xPhpFunction;

    /**
     * The path and file name of the include file where the function is defined
     *
     * @var string
     */
    private $sInclude;

    /**
     * An associative array containing call options that will be sent
     * to the browser curing client script generation
     *
     * @var array
     */
    private $aOptions = [];

    /**
     * The constructor
     *
     * @param string $sFunction

Missing parameter comment

     * @param string $sJsFunction

Missing parameter comment

     * @param string $sPhpFunction

Missing parameter comment

     */
    public function __construct(string $sFunction, string $sJsFunction, string $sPhpFunction)

Expected 2 blank lines before function; 1 found

    {
        $this->sFunction = $sFunction;

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

        $this->sJsFunction = $sJsFunction;
        $this->xPhpFunction = $sPhpFunction;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the name of the function being referenced
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->sFunction;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get name of the corresponding javascript function
     *
     * @return string
     */
    public function getJsName(): string
    {
        return $this->sJsFunction;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the config options of the function being referenced
     *
     * @return array
     */
    public function getOptions(): array
    {
        return $this->aOptions;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set call options for this instance
     *
     * @param string $sName    The name of the configuration option

Expected 2 spaces after parameter name; 4 found

     * @param string $sValue    The value of the configuration option

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function configure(string $sName, string $sValue)
    {
        switch($sName)
        {
        case 'class': // The user function is a method in the given class
            $this->xPhpFunction = [$sValue, $this->xPhpFunction];
            break;
        case 'include':
            $this->sInclude = $sValue;
            break;
        default:
            $this->aOptions[$sName] = $sValue;
            break;
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Call the registered user function, including an external file if needed
     * and passing along the specified arguments
     *
     * @param array $aArgs    The function arguments

Expected 1 spaces after parameter name; 4 found

     *
     * @return mixed
     */
    public function call(array $aArgs = [])
    {
        if(($this->sInclude))
        {
            require_once $this->sInclude;
        }
        // If the function is an alias for a class method, then instantiate the class
        if(is_array($this->xPhpFunction) && is_string($this->xPhpFunction[0]))
        {
            $sClassName = $this->xPhpFunction[0];

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

            $this->xPhpFunction[0] = new $sClassName;
        }
        return call_user_func_array($this->xPhpFunction, $aArgs);
    }

Expected 2 blank lines after function; 0 found

}