1186364424

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/tattersoftware/codeigniter4-alerts/commit/<a class=hub.com/tattersoftware/codeigniter4-alerts/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-alerts/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c789206a48f452">decba2609<a href="https://github.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c789206a48f452">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c789206a48f452&quot;&gt;decba2609&lt;/a&gt;&lt;a href=&quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c789206a48f452&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c78920&lt;/a&gt;6a48f452&quot;&gt;&amp;quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/<a class="double-link" href="https://github.com/tattersoftware/codeigniter4-alerts/commit/32bab7c7bd027390c3f2e902c55d52fdab27ce3d">32bab7c7b</a><a href="https://github.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c789206a48f452">&amp;quot;&amp;gt;32bab7c7b&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;32bab7c7b&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/decba2609dd9760612a2fc06e9c789206a48f&lt;/a&gt;452&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-alerts/commit/<a class="double-link" href="https://github.com/tattersoftware/codeigniter4-alerts/commit/5f71e15be">5f71e15be">5f71e15be</a>

Pull Request Pull Request #13: Update Tools & Styles

Run Details

12 of 46 new or added lines in 5 files covered. (26.09%)

12 of 46 relevant lines covered (26.09%)

0.26 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

23.53

/src/Alerts.php

<?php

/**
 * This file is part of Tatter Alerts.
 *
 * (c) 2021 Tatter Software
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Tatter\Alerts;

use CodeIgniter\Session\Session;
use CodeIgniter\View\RendererInterface;
use Config\Services;
use Tatter\Alerts\Config\Alerts as AlertsConfig;
use Tatter\Alerts\Exceptions\AlertsException;

class Alerts
{
    /**
     * Our configuration instance.
     *
     * @var AlertsConfig
     */
    protected $config;

    /**
     * The view engine to render the alerts with.
     *
     * @var RendererInterface
     */
    protected $view;

    /**
     * The active user session, for loading and storing alerts.
     *
     * @var Session
     */
    protected $session;

    // initiate library, check for existing session
    public function __construct(AlertsConfig $config, RendererInterface $view = null)
    {
        // save configuration
        $this->config = $config;

        // initiate the Session library
        $this->session = Services::session();

        // verify renderer
        if ($view instanceof RendererInterface) {
            $this->view = $view;
        } else {
            $this->view = Services::renderer();
        }

        // validations
        if (empty($this->config->template)) {
            throw AlertsException::forInvalidTemplate('');
        }

        $locator = Services::locator();
        if (! $locator->locateFile($this->config->template)) {
            throw AlertsException::forMissingTemplateView($this->config->template);
        }
    }

    // add a new alert to the queue
    public function add($class, $text)
    {
        $alert = [
            'class' => $class,
            'text'  => $text,
        ];

        // start the queue if it doesn't exist
        if (! $this->session->has($this->config->prefix . 'queue')) {
            $this->session->set($this->config->prefix . 'queue', [$alert]);
        }

        // push onto the queue if it was already there
        else {
            $this->session->push($this->config->prefix . 'queue', [$alert]);
        }
    }

    // clears the queue and returns template formatted alerts
    public function display()
    {
        // get any alerts
        $alerts = $this->session->get($this->config->prefix . 'queue') ?? [];

        // clear alerts
        $this->session->remove($this->config->prefix . 'queue');

        // Check for flashdata (if configured)
        if ($this->config->getflash) {
            if ($message = $this->session->getFlashdata('message')) {
                $alerts[] = ['class' => 'info', 'text' => $message];
            } elseif ($error = $this->session->getFlashdata('error')) {
                $alerts[] = ['class' => 'danger', 'text' => $error];
            } elseif ($errors = $this->session->getFlashdata('errors')) {
                foreach ($errors as $error) {
                    $alerts[] = ['class' => 'danger', 'text' => $error];
                }
            }
        }

        if (empty($alerts)) {
            return;
        }
        // render the specified view template
        return $this->view->setVar('prefix', $this->config->prefix)
            ->setVar('alerts', $alerts)
            ->render($this->config->template);
    }

    // returns default CSS as inline style sheet
    // should be injected into <head>
    public function css()
    {
        return $this->view->setVar('prefix', $this->config->prefix)->render('Tatter\Alerts\Views\css');
    }
}

1	<?php
2
3	/**
4	* This file is part of Tatter Alerts.
5	*
6	* (c) 2021 Tatter Software
7	*
8	* For the full copyright and license information, please view
9	* the LICENSE file that was distributed with this source code.
10	*/
11
12	namespace Tatter\Alerts;
13
14	use CodeIgniter\Session\Session;
15	use CodeIgniter\View\RendererInterface;
16	use Config\Services;
17	use Tatter\Alerts\Config\Alerts as AlertsConfig;
18	use Tatter\Alerts\Exceptions\AlertsException;
19
20	class Alerts
21	{
22	/**
23	* Our configuration instance.
24	*
25	* @var AlertsConfig
26	*/
27	protected $config;
28
29	/**
30	* The view engine to render the alerts with.
31	*
32	* @var RendererInterface
33	*/
34	protected $view;
35
36	/**
37	* The active user session, for loading and storing alerts.
38	*
39	* @var Session
40	*/
41	protected $session;
42
43	// initiate library, check for existing session
44	public function __construct(AlertsConfig $config, RendererInterface $view = null)
45	{
46	// save configuration
47	$this->config = $config;	1✔
48
49	// initiate the Session library
50	$this->session = Services::session();	1✔
51
52	// verify renderer
53	if ($view instanceof RendererInterface) {	1✔
NEW 54	$this->view = $view;	×
55	} else {
56	$this->view = Services::renderer();	1✔
57	}
58
59	// validations
60	if (empty($this->config->template)) {	1✔
NEW 61	throw AlertsException::forInvalidTemplate('');	×
62	}
63
64	$locator = Services::locator();	1✔
65	if (! $locator->locateFile($this->config->template)) {	1✔
NEW 66	throw AlertsException::forMissingTemplateView($this->config->template);	×
67	}
68	}	1✔
69
70	// add a new alert to the queue
71	public function add($class, $text)
72	{
NEW 73	$alert = [	×
NEW 74	'class' => $class,	×
NEW 75	'text' => $text,	×
76	];
77
78	// start the queue if it doesn't exist
NEW 79	if (! $this->session->has($this->config->prefix . 'queue')) {	×
NEW 80	$this->session->set($this->config->prefix . 'queue', [$alert]);	×
81	}
82
83	// push onto the queue if it was already there
84	else {
NEW 85	$this->session->push($this->config->prefix . 'queue', [$alert]);	×
86	}
NEW 87	}	×
88
89	// clears the queue and returns template formatted alerts
90	public function display()
91	{
92	// get any alerts
NEW 93	$alerts = $this->session->get($this->config->prefix . 'queue') ?? [];	×
94
95	// clear alerts
NEW 96	$this->session->remove($this->config->prefix . 'queue');	×
97
98	// Check for flashdata (if configured)
NEW 99	if ($this->config->getflash) {	×
NEW 100	if ($message = $this->session->getFlashdata('message')) {	×
NEW 101	$alerts[] = ['class' => 'info', 'text' => $message];	×
NEW 102	} elseif ($error = $this->session->getFlashdata('error')) {	×
NEW 103	$alerts[] = ['class' => 'danger', 'text' => $error];	×
NEW 104	} elseif ($errors = $this->session->getFlashdata('errors')) {	×
NEW 105	foreach ($errors as $error) {	×
NEW 106	$alerts[] = ['class' => 'danger', 'text' => $error];	×
107	}
108	}
109	}
110
NEW 111	if (empty($alerts)) {	×
NEW 112	return;	×
113	}
114	// render the specified view template
NEW 115	return $this->view->setVar('prefix', $this->config->prefix)	×
NEW 116	->setVar('alerts', $alerts)	×
NEW 117	->render($this->config->template);	×
118	}
119
120	// returns default CSS as inline style sheet
121	// should be injected into <head>
122	public function css()
123	{
NEW 124	return $this->view->setVar('prefix', $this->config->prefix)->render('Tatter\Alerts\Views\css');	×
125	}
126	}

tattersoftware / codeigniter4-alerts / 1186364424

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous