DM\AjaxCom\Handler

Complexity

Total Complexity

11

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	5
Bugs	0	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isEmpty()	0	4	1
A	register()	0	6	1
A	unregister()	0	9	2
A	flashMessage()	0	10	1
A	container()	0	7	1
A	modal()	0	7	1
A	callback()	0	7	1
A	changeUrl()	0	7	1
A	respond()	0	10	2

<?php

namespace DM\AjaxCom;

use DM\AjaxCom\Responder\Callback;
use DM\AjaxCom\Responder\ChangeUrl;
use DM\AjaxCom\Responder\Container\Container;
use DM\AjaxCom\Responder\Container\FlashMessage;
use DM\AjaxCom\Responder\Modal;
use DM\AjaxCom\Responder\ResponderInterface;

class Handler
{
    /**
     * Collection of ResponderInterface objects
     *
     * @var array $queue
     */
    private $queue = array();

    /**
     * Return true if queue is empty, otherwise false
     *
     * @return bool
     */
    public function isEmpty()
    {
        return empty($this->queue);
    }

    /**
     * Add ResponderInterface object to the queue
     *
     * @var ResponderInterface $responder
     * @return Handler
     */
    public function register(ResponderInterface $responder)
    {
        $this->queue[] = $responder;

        return $this;
    }

    /**
     * Remove ResponderInterface object from the queue
     *
     * @var ResponderInterface $responder
     * @return Handler
     */
    public function unregister(ResponderInterface $responder)
    {
        $key = array_search($responder, $this->queue, true);
        if ($key !== false) {
            unset($this->queue[$key]);
        }

        return $this;
    }

    /**
     * Create a FlashMessage and register it to the queue
     *
     * Convenience method to allow for a fluent interface
     *
     * @var string $message
     * @param string $type
     * @param string $method
     * @return FlashMessage
     */
    public function flashMessage(
        $message,
        $type = FlashMessage::TYPE_SUCCESS,
        $method = FlashMessage::METHOD_APPEND
    ) {
        $message = new FlashMessage($message, $type, $method);
        $this->register($message);

        return $message;
    }

    /**
     * Create a Container and register it to the queue
     *
     * Convenience method to allow for a fluent interface
     *
     * @var string $identifier
     * @return Container
     */
    public function container($identifier)
    {
        $container = new Container($identifier);
        $this->register($container);

        return $container;
    }

    /**
     * Create a Modal and register it to the queue
     *
     * Convenience method to allow for a fluent interface
     *
     * @var string html
     * @var string type
     * @return Modal
     */
    public function modal($html, $type = Modal::DEFAULT_TYPE)
    {
        $modal = new Modal($html, $type);
        $this->register($modal);

        return $modal;
    }

    /**
     * Create a Callback and register it to the queue
     *
     * Convenience method to allow for a fluent interface
     *
     * @var string $function
     * @var mixed $params Parameters sent to the callback function
     * @return Callback
     */
    public function callback($function, $params = null)
    {
        $callback = new Callback($function, $params);
        $this->register($callback);

        return $callback;
    }

    /**
     * Create a ChangeUrl and register it to the queue
     *
     * Convenience method to allow for a fluent interface
     *
     * @var string $url
     * @var string $method push|replace|redirect
     * @var int $wait - wait before action
     * @return ChangeUrl
     */
    public function changeUrl($url, $method = ChangeUrl::PUSH, $wait = 0)
    {
        $changeUrl = new ChangeUrl($url, $method, $wait);
        $this->register($changeUrl);

        return $changeUrl;
    }

    /**
     * Generates response
     * @return array
     */
    public function respond()
    {
        $response = array();

        foreach ($this->queue as $object) {
            $response[] = $object->render();
        }

        return array('ajaxcom' => $response);
    }
}