Jaxon\Ui\Dialog\Library\DialogLibraryTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setResponse()	0	3	1
A	response()	0	3	1
A	setReturnCode()	0	4	1
A	returnCode()	0	3	1

<?php

/**
 * DialogLibraryTrait.php
 *
 * @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\Ui\Dialog\Library;

use Jaxon\Response\Response;
use Jaxon\Ui\Dialog\MessageInterface;

trait DialogLibraryTrait

Missing doc comment for trait DialogLibraryTrait

{
    /**
     * The dialog library helper
     *
     * @var DialogLibraryHelper
     */
    protected $xHelper;

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

    /**
     * @var Response
     */
    protected $xResponse = null;

    /**
     * For MessageInterface, tells if the calls to the functions shall
     * add commands to the response or return the js code. By default, they add commands.
     *
     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $bReturnCode = false;

    /**
     * Set the response to attach the messages to.
     *
     * @param Response $xResponse    Whether to return the code

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    final public function setResponse(Response $xResponse)

Expected 2 blank lines before function; 1 found

    {
        $this->xResponse = $xResponse;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the <Jaxon\Response\Response> object
     *
     * @return Response
     */
    final protected function response(): Response
    {
        return $this->xResponse;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param bool $bReturnCode

Missing parameter comment

     *
     * @return MessageInterface
     */
    final public function setReturnCode(bool $bReturnCode): MessageInterface
    {
        $this->bReturnCode = $bReturnCode;
        return $this;

The expression return $this returns the type Jaxon\Ui\Dialog\Library\DialogLibraryTrait which is incompatible with the type-hinted return Jaxon\Ui\Dialog\MessageInterface.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the library should return the js code or run it in the browser.
     *
     * @return bool
     */
    final protected function returnCode(): bool
    {
        return $this->bReturnCode;
    }

Expected 2 blank lines after function; 0 found

}