Cornford\Alerter\AlertDisplay

Complexity

Total Complexity

8

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	2
A	getDirectoryIterator()	0	6	1
A	findDisplayViewFile()	0	12	3
A	isDisplayViewFile()	0	4	1
A	display()	0	7	1

<?php namespace Cornford\Alerter;

use Cornford\Alerter\Contracts\DisplayableInterface;
use Cornford\Alerter\Exceptions\AlertDisplayViewException;
use Cornford\Alerter\Exceptions\AlertDisplayViewPathException;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;

class AlertDisplay implements DisplayableInterface {

    const VIEW_SIMPLE = 'simple';
    const VIEW_LIST = 'list';
    const VIEW_BOOTSTRAP = 'bootstrap';
    const VIEW_BOOTSTRAP_CLOSABLE = 'bootstrap-closeable';
    const VIEW_FOUNDATION = 'foundation';
    const VIEW_FOUNDATION_CLOSABLE = 'foundation-closable';
    const VIEW_PURE = 'pure';
    const VIEW_PURE_CLOSABLE = 'pure-closable';

    /**
     * The views base folder.
     *
     * @var string
     */
    protected $viewPath;

    /**
     * The Alert object.
     *
     * @var Alert
     */
    private $alert;

    /**
     * The view name.
     *
     * @var string
     */
    private $view;

    /**
     * Construct class with an alert object, a display view, and a view path.
     *
     * @param Alert  $alert
     * @param string $view
     * @param string $viewPath
     *
     * @return self

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     *
     * @throws \Cornford\Alerter\Exceptions\AlertDisplayViewPathException
     */
    public function __construct(Alert $alert, $viewPath, $view)
    {
        $this->alert = $alert;

        if (!is_dir($viewPath)) {
            throw new AlertDisplayViewPathException('Could not locate the view path.');
        }

        $this->viewPath = $viewPath;
        $this->view = $view;

        $this->view = $this->findDisplayViewFile();
    }

    /**
     * Get the directory iterator.
     *
     * @return RecursiveIteratorIterator
     */
    protected function getDirectoryIterator()
    {
        return new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($this->viewPath)
        );
    }

    /**
     * Track down the display view file.
     *
     * @return string
     *
     * @throws \Cornford\Alerter\Exceptions\AlertDisplayViewException
     */
    protected function findDisplayViewFile()
    {
        foreach($this->getDirectoryIterator() as $file) {
            $name = $file->getFilename();

            if ($this->isDisplayViewFile($name)) {
                return $file->getPathname();
            }
        }

        throw new AlertDisplayViewException('Could not locate the view file.');
    }

    /**
     * Is the given file a display view file?
     *
     * @param string $name
     *
     * @return bool
     */
    protected function isDisplayViewFile($name)
    {
        return preg_match('/' . $this->view . '.php$/i', $name);
    }

    /**
     * Return a compiled alert display view.
     *
     * @return string
     */
    public function display()
    {
        ob_start();
        require $this->view;

        return ob_get_clean();
    }

}