Jaxon\Plugin\RequestPlugin

Complexity

Total Complexity

2

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getTarget()	0	3	1
A	register()	0	3	1

<?php

/**
 * RequestPlugin.php - Jaxon Request interface
 *
 * Interface for Jaxon Request plugins.
 *
 * Request plugins handle the registration, client script generation and processing of jaxon enabled requests.
 * Each plugin should have a unique signature for both the registration and processing of requests.
 * During registration, the user will specify a type which will allow the plugin to detect and handle it.
 * During client script generation, the plugin will generate a <jaxon.request> stub with the prescribed call options and request signature.
 * During request processing, the plugin will detect the signature generated previously and process the request accordingly.
 *
 * @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;

use Jaxon\Request\Target;

abstract class RequestPlugin extends Plugin

Missing doc comment for class RequestPlugin

{
    /**
     * Check if the provided options are correct, and convert them into an array.
     *
     * @param string $sCallable

Missing parameter comment

     * @param mixed $xOptions

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return array
     */
    abstract public function checkOptions(string $sCallable, $xOptions): array;

Expected 2 blank lines before function; 0 found

Expected 2 blank lines after function; 1 found

    /**
     * Register a function, an event or an object.
     *
     * Called by the <Jaxon\Plugin\PluginManager> when a user script
     * when a function or callable object is to be registered.
     * Additional plugins may support other registration types.
     *
     * @param string $sType    The type of request handler being registered

Expected 5 spaces after parameter name; 4 found

     * @param string $sCallable    The callable entity being registered

Expected 1 spaces after parameter name; 4 found

     * @param array $aOptions    The associated options

Expected 2 spaces after parameter name; 4 found

Expected 2 spaces after parameter type; 1 found

     *
     * @return bool
     */
    public function register(string $sType, string $sCallable, array $aOptions): bool

The parameter $sType is not used and could be removed.

The parameter $aOptions is not used and could be removed.

The parameter $sCallable is not used and could be removed.

    {
        return false;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the target function or class and method
     *
     * @return Target|null
     */
    public function getTarget(): ?Target
    {
        return null;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if this plugin can process the current request
     *
     * Called by the <Jaxon\Plugin\PluginManager> when a request has been received to determine
     * if the request is destinated to this request plugin.
     *
     * @return bool
     */
    abstract public function canProcessRequest(): bool;

Expected 2 blank lines after function; 1 found

    /**
     * Process the current request
     *
     * Called by the <Jaxon\Plugin\PluginManager> when a request is being processed.
     * This will only occur when <Jaxon> has determined that the current request
     * is a valid (registered) jaxon enabled function via <jaxon->canProcessRequest>.
     *
     * @return bool
     */
    abstract public function processRequest(): bool;

Expected 2 blank lines after function; 0 found

}