Flash

Complexity

Total Complexity

14

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	get_template_global_variables()	0	6	1
A	FlashMessage()	0	4	1
A	set()	0	21	4
A	get()	0	8	1
A	forTemplate()	0	7	2
A	__callStatic()	0	8	4

<?php

/**
 * Class Flash
 * @method static void info(string $message, bool $closable = null, bool $fadeOut = null)
 * @method static void success(string $message, bool $closable = null, bool $fadeOut = null)
 * @method static void warning(string $message, bool $closable = null, bool $fadeOut = null)
 * @method static void danger(string $message, bool $closable = null, bool $fadeOut = null)
 * @method static void alert(string $message, bool $closable = null, bool $fadeOut = null)
 * @method static void modal(string $message, bool $closable = null, bool $fadeOut = null)
 */
class Flash extends ViewableData implements TemplateGlobalProvider

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @config
     * @var array
     */
    private static $defaults = [

The property $defaults is not used and could be removed.

        'Type'     => 'success',
        'IsModal'  => false,
        'Closable' => true,
        'FadeOut'  => false
    ];

    /**
     * @config
     * @var array
     */
    private static $supported_methods = [

The property $supported_methods is not used and could be removed.

        'info',
        'success',
        'warning',
        'danger',
        'alert',
        'modal'
    ];

    /**
     * @config
     * @var string
     */
    private static $template = 'FlashMessage';

The property $template is not used and could be removed.

    /**
     * @config
     * @var string
     */
    private static $session_name = 'FlashMessage';

The property $session_name is not used and could be removed.

    /**
     * @config
     * @var bool
     */
    private static $load_javascript = true;

The property $load_javascript is not used and could be removed.

    /**
     * The Flash Message data
     *
     * @var array
     */
    protected $data = [];

    /**
     * @param array $data
     */
    public function __construct($data)
    {
        $this->data = (array)$data + (array)self::config()->defaults;

        parent::__construct();
    }

    /**
     * @return array
     */
    public static function get_template_global_variables()
    {
        return [
            'FlashMessage'
        ];
    }

    /**
     * @return Flash
     */
    public static function FlashMessage()
    {
        return Flash::get();
    }

    /**
     * @param $message
     * @param string $type
     * @param null $closable
     * @param null $fadeOut
     */
    public static function set($message, $type = 'success', $closable = null, $fadeOut = null)
    {
        $data = [
            'Message' => $message,
            'Type'    => $type
        ];

        if (null !== $closable) {
            $data['Closable'] = $closable;
        }

        if (null !== $fadeOut) {
            $data['FadeOut'] = $fadeOut;
        }

        if('modal' === $type) {
            $data['IsModal'] = true;
        }

        Session::set(Flash::config()->session_name, $data);

$data is of type array<string,?>, but the function expects a string.

    }

    /**
     * @return Flash
     */
    public static function get()
    {
        $key  = Flash::config()->session_name;
        $data = Session::get($key);
        Session::clear($key);

        return (new Flash($data));
    }

    /**
     * @return string

Should the return type not be HTMLText?

     */
    public function forTemplate()
    {
        if (self::config()->load_javascript) {
            Requirements::javascript('flashmessage/javascript/flashmessage.js');
        }
        return $this->customise($this->data)->renderWith(self::config()->template);
    }

    /**
     * @param $method
     * @param $args
     * @throws BadMethodCallException
     */
    public static function __callStatic($method, $args)
    {
        if (in_array($method, self::config()->supported_methods)) {
            self::set($args[0], $method, isset($args[1]) ? $args[1] : null, isset($args[2]) ? $args[2] : null);
        } else {
            throw new BadMethodCallException("Method '$method' does not exist on " . __CLASS__);
        }
    }

}