jaxon-php / jaxon-core

src/App/AppInterface.php

<?php

/**
 * AppInterface.php
 *
 * The Jaxon app functions.
 *
 * @package jaxon-core

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

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2022 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\App;

use Jaxon\Plugin\Package;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Request\Factory\Factory;
use Jaxon\Request\Factory\RequestFactory;
use Jaxon\Request\Handler\CallbackManager;
use Jaxon\Response\ResponseInterface;
use Jaxon\Utils\Http\UriException;
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerInterface;
use Closure;

interface AppInterface

Missing doc comment for interface AppInterface

{
    /**
     * Set the logger.
     *
     * @param LoggerInterface $logger

Missing parameter comment

     *
     * @return void
     */
    public function setLogger(LoggerInterface $logger);

Expected 2 blank lines before function; 0 found

Expected 2 blank lines after function; 1 found

    /**
     * Set the value of a config option
     *
     * @param string $sName    The option name

Expected 2 spaces after parameter name; 4 found

     * @param mixed $sValue    The option value

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function setOption(string $sName, $sValue);

Expected 2 blank lines after function; 1 found

    /**
     * Get the value of a config option
     *
     * @param string $sName    The option name

Expected 5 spaces after parameter type; 1 found

     * @param mixed|null $xDefault    The default value, to be returned if the option is not defined

Expected 1 spaces after parameter name; 4 found

     *
     * @return mixed
     */
    public function getOption(string $sName, $xDefault = null);

Expected 2 blank lines after function; 1 found

    /**
     * Check the presence of a config option
     *
     * @param string $sName    The option name

Expected 1 spaces after parameter name; 4 found

     *
     * @return bool
     */
    public function hasOption(string $sName): bool;

Expected 2 blank lines after function; 1 found

    /**
     * Get the configured character encoding
     *
     * @return string
     */
    public function getCharacterEncoding(): string;

Expected 2 blank lines after function; 1 found

    /**
     * Get the content type of the HTTP response
     *
     * @return string
     */
    public function getContentType(): string;

Expected 2 blank lines after function; 1 found

    /**
     * @return Factory
     */
    public function factory(): Factory;

Expected 2 blank lines after function; 1 found

    /**
     * Get a request to a registered class
     *
     * @param string $sClassName The class name
     *
     * @return RequestFactory|null
     */
    public function request(string $sClassName = ''): ?RequestFactory;

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon javascript files into the page.
     *
     * @return string
     */
    public function getJs(): string;

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon javascript files into the page.
     *
     * @return string  the javascript code
     */
    public function js(): string;

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon CSS code and files into the page.
     *
     * @return string
     */
    public function getCss(): string;

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTML tags to include Jaxon CSS code and files into the page.
     *
     * @return string  the javascript code
     */
    public function css(): string;

Expected 2 blank lines after function; 1 found

    /**
     * Returns the js header and wrapper code to be printed into the page
     *
     * The javascript code returned by this function is dependent on the plugins
     * that are included and the functions and classes that are registered.
     *
     * @param bool $bIncludeJs    Also get the JS files

Expected 2 spaces after parameter name; 4 found

     * @param bool $bIncludeCss    Also get the CSS files

Expected 1 spaces after parameter name; 4 found

     *
     * @return string
     */
    public function getScript(bool $bIncludeJs = false, bool $bIncludeCss = false): string;

Expected 2 blank lines after function; 1 found

    /**
     * Returns the js header and wrapper code to be printed into the page
     *
     * @param bool $bIncludeJs    Also get the JS files

Expected 2 spaces after parameter name; 4 found

     * @param bool $bIncludeCss    Also get the CSS files

Expected 1 spaces after parameter name; 4 found

     *
     * @return string  the javascript code
     * @throws UriException
     */
    public function script(bool $bIncludeJs = false, bool $bIncludeCss = false): string;

Expected 2 blank lines after function; 1 found

    /**
     * Determine if a call is a jaxon request or a page load request
     *
     * @return bool
     */
    public function canProcessRequest(): bool;

Expected 2 blank lines after function; 1 found

    /**
     * Process an incoming Jaxon request, and return the response.
     *
     * @return void
     */
    public function processRequest();

Expected 2 blank lines after function; 1 found

    /**
     * Get the Jaxon ajax response
     *
     * @return ResponseInterface
     */
    public function ajaxResponse(): ResponseInterface;

Expected 2 blank lines after function; 1 found

    /**
     * Get the HTTP response
     *
     * @param string $sCode    The HTTP response code

Expected 1 spaces after parameter name; 4 found

     *
     * @return mixed
     */
    public function httpResponse(string $sCode = '200');

Expected 2 blank lines after function; 1 found

    /**
     * Get a registered response plugin
     *
     * @param string $sName    The name of the plugin

Expected 1 spaces after parameter name; 4 found

     *
     * @return ResponsePlugin|null
     */
    public function plugin(string $sName): ?ResponsePlugin;

Expected 2 blank lines after function; 1 found

    /**
     * Get a package instance
     *
     * @param string $sClassName    The package class name

Expected 1 spaces after parameter name; 4 found

     *
     * @return Package|null
     */
    public function package(string $sClassName): ?Package;

Expected 2 blank lines after function; 1 found

    /**
     * @return CallbackManager
     */
    public function callback(): CallbackManager;

Expected 2 blank lines after function; 1 found

    /**
     * @param Closure $xClosure    A closure to create the session manager instance

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function setSessionManager(Closure $xClosure);

Expected 2 blank lines after function; 1 found

    /**
     * Set the container provided by the integrated framework
     *
     * @param ContainerInterface $xContainer    The container implementation

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function setContainer(ContainerInterface $xContainer);

Expected 2 blank lines after function; 1 found

    /**
     * Add a view renderer with an id
     *
     * @param string $sRenderer    The renderer name

Expected 2 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     * @param string $sExtension    The extension to append to template names

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param Closure $xClosure    A closure to create the view instance

Expected 3 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function addViewRenderer(string $sRenderer, string $sExtension, Closure $xClosure);

Expected 2 blank lines after function; 1 found

    /**
     * Set the javascript asset
     *
     * @param bool $bExport    Whether to export the js code in a file

Expected 3 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param bool $bMinify    Whether to minify the exported js file

Expected 3 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param string $sUri    The URI to access the js file
     * @param string $sDir    The directory where to create the js file
     *
     * @return void
     */
    public function asset(bool $bExport, bool $bMinify, string $sUri = '', string $sDir = '');

Expected 2 blank lines after function; 1 found

    /**
     * Read config options from a config file and set up the library
     *
     * @param string $sConfigFile    The full path to the config file

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function setup(string $sConfigFile);

Expected 2 blank lines after function; 0 found

}