jaxon-php / jaxon-core

src/App/Dialog/Library/AlertLibrary.php

<?php

/**
 * AlertLibrary.php
 *
 * Implements the dialog message and question features using the js alert and confirm functions.
 *
 * @package jaxon-core

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

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

use Jaxon\App\Dialog\LibraryInterface;
use Jaxon\App\Dialog\MessageInterface;
use Jaxon\App\Dialog\QuestionInterface;

class AlertLibrary implements LibraryInterface, MessageInterface, QuestionInterface

Missing doc comment for class AlertLibrary

{
    use DialogLibraryTrait;

    /**
     * Get the library name
     *
     * @return string
     */
    public function getName(): string

Expected 2 blank lines before function; 1 found

    {
        return ''; // No name
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the script which makes a call only if the user answers yes to the given question
     *
     * @param string  $sQuestion

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param string  $sYesScript

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param string  $sNoScript

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     *
     * @return string
     */
    public function confirm(string $sQuestion, string $sYesScript, string $sNoScript): string
    {
        return empty($sNoScript) ? 'if(confirm(' . $sQuestion . ')){' . $sYesScript . ';}' :

Expected 1 space after ":"; newline found

            'if(confirm(' . $sQuestion . ')){' . $sYesScript . ';}else{' . $sNoScript . ';}';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Print an alert message.
     *
     * @param string $sMessage    The text of the message

Expected 1 spaces after parameter name; 4 found

     * @param string $sTitle    The title of the message

Expected 3 spaces after parameter name; 4 found

     *
     * @return string
     */
    private function alert(string $sMessage, string $sTitle): string
    {
        if(!empty($sTitle))
        {
            $sMessage = '<b>' . $sTitle . '</b><br/>' . $sMessage;
        }
        if($this->returnCode())
        {
            return 'alert(' . $sMessage . ')';
        }
        $this->xResponse->alert($sMessage, $sTitle);

The call to Jaxon\Response\Response::alert() has too many arguments starting with $sTitle.

        return '';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Print a success message.
     *
     * @param string $sMessage    The text of the message

Expected 1 spaces after parameter name; 4 found

     * @param string $sTitle    The title of the message

Expected 3 spaces after parameter name; 4 found

     *
     * @return string
     */
    public function success(string $sMessage, string $sTitle = ''): string
    {
        return $this->alert($sMessage, $sTitle);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Print an information message.
     *
     * @param string $sMessage    The text of the message

Expected 1 spaces after parameter name; 4 found

     * @param string $sTitle    The title of the message

Expected 3 spaces after parameter name; 4 found

     *
     * @return string
     */
    public function info(string $sMessage, string $sTitle = ''): string
    {
        return $this->alert($sMessage, $sTitle);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Print a warning message.
     *
     * @param string $sMessage    The text of the message

Expected 1 spaces after parameter name; 4 found

     * @param string $sTitle    The title of the message

Expected 3 spaces after parameter name; 4 found

     *
     * @return string
     */
    public function warning(string $sMessage, string $sTitle = ''): string
    {
        return $this->alert($sMessage, $sTitle);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Print an error message.
     *
     * @param string $sMessage    The text of the message

Expected 1 spaces after parameter name; 4 found

     * @param string $sTitle    The title of the message

Expected 3 spaces after parameter name; 4 found

     *
     * @return string
     */
    public function error(string $sMessage, string $sTitle = ''): string
    {
        return $this->alert($sMessage, $sTitle);
    }

Expected 2 blank lines after function; 0 found

}