Flynt\Utils\AdminNotices\AdminNoticeManager

Complexity

Total Complexity

11

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	7	2
A	__clone()	0	3	1
A	__construct()	0	3	1
B	addNotice()	0	35	6
A	getAll()	0	4	1

<?php

namespace Flynt\Utils\AdminNotices;

// # TODO make strings translatable

/**
 * AdminNoticeManager is to be used in other features to enable an easy-to-use interface for the display of admin notices.
 *
 * Example usage:
 * use Flynt\Utils\AdminNotices\AdminNoticeManager;
 * // get the singleton instance of the manager
 * $manager = AdminNoticeManager::getInstance();
 *
 * // Prepare the admin notice
 * $message = ['This notice will show up in the admin backend.'];
 * $options = [
 *   'type' => 'info',
 *   'title' => 'Flynt Notice',
 *   'dismissible' => true,
 *   'filenames' => 'related-file.php, another.json'
 * ];
 */
class AdminNoticeManager
{
    protected static $instance = null;
    protected static $notices = [];

    const DEFAULT_OPTIONS = [
        'type' => 'info',
        'title' => 'Flynt - Oops, something went wrong',
        'dismissible' => true,
        'filenames' => ''
    ];

    public static function getInstance()
    {
        if (null === self::$instance) {
            self::$instance = new self;
        }
        return self::$instance;
    }

    /**
     * clone
     *
     * Prevent cloning with 'protected' keyword
    **/
    protected function __clone()
    {
    }

    /**
     * constructor
     *
     * Prevent instantiation with 'protected' keyword
    **/
    protected function __construct()
    {
    }

    public function addNotice($messages = [], $options = [])
    {
        if (empty($messages)) {
            return;
        }

        $options = array_merge(self::DEFAULT_OPTIONS, $options);

        $cssClasses = 'notice';
        $cssClasses .= $options['dismissible'] ? ' is-dismissible' : '';
        $cssClasses .= !empty($options['type']) ? " notice-{$options['type']}" : '';

        $files = !empty($options['filenames']) ? " ({$options['filenames']}) " : ' ';

        $msg = '';

        foreach ($messages as $message) {
            $msg .= '<p>' . $message . '</p>';
        }

        $msg .= '<p><i>To resolve this issue either follow the steps above'
        . " or remove the Feature{$files}requiring this functionality in your theme.</i></p>";
        $msg = "<div class=\"{$cssClasses}\">"
        . "<p><strong>{$options['title']}</strong></p>"
        . $msg . '</div>';

        add_action('admin_notices', function () use ($msg) {
            echo $msg;
        });

        array_push(self::$notices, [
            'options' => $options,
            'message' => $msg
        ]);
    }

    public function getAll()
    {
        return self::$notices;
    }
}