jaxon-php / jaxon-core

src/App/Dialog/ModalInterface.php

<?php

/**
 * ModalInterface.php - Interface for modal dialogs.
 *
 * @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\Dialog;

interface ModalInterface extends LibraryInterface

Missing doc comment for interface ModalInterface

{
    /**
     * Show a modal dialog.
     *
     * @param string $sTitle The title of the dialog

Expected 3 spaces after parameter name; 1 found

     * @param string $sContent The content of the dialog
     * @param array $aButtons The buttons of the dialog

Expected 2 spaces after parameter type; 1 found

     * @param array $aOptions The options of the dialog

Expected 2 spaces after parameter type; 1 found

     *
     * Each button is an array with the following entries:

Parameter comment not aligned correctly; expected 24 spaces but found 1

     * - title: the text to be printed in the button

Parameter comment not aligned correctly; expected 24 spaces but found 1

     * - class: the CSS class of the button

Parameter comment not aligned correctly; expected 24 spaces but found 1

     * - click: the javascript function to be called when the button is clicked

Parameter comment not aligned correctly; expected 24 spaces but found 1

     * If the click value is set to "close", then the button closes the dialog.

Parameter comment not aligned correctly; expected 24 spaces but found 1

     *
     * The content of the $aOptions depends on the javascript library in use.

Parameter comment not aligned correctly; expected 24 spaces but found 1

     * Check their specific documentation for more information.

Parameter comment not aligned correctly; expected 24 spaces but found 1

     *
     * @return void
     */
    public function show(string $sTitle, string $sContent, array $aButtons, array $aOptions = []);

Expected 2 blank lines before function; 0 found

Expected 2 blank lines after function; 1 found

    /**
     * Hide the modal dialog.
     *
     * @return void
     */
    public function hide();

Expected 2 blank lines after function; 0 found

}