TechPivot\Phalcon\Enterprise\Dispatcher\Plugins\AjaxRouteHandler

Complexity

Total Complexity

5

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes	2
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	afterExecuteRoute()	0	29	5

<?php

namespace TechPivot\Phalcon\Enterprise\Dispatcher\Plugins;

use Phalcon\Events\Event;
use Phalcon\Mvc\Dispatcher;
use Phalcon\Mvc\User\Plugin;

/**
 * AjaxRouteHandler.
 *
 * This plugin provides consistent behavior for handling return content for AJAX requests by using
 * the return value from the route's action.
 *
 * Routes simply need to return data that should be returned as json. For example:
 *
 *  <code>
 *      public function ajaxAction()
 *      {
 *          return [
 *              'ok' => true
 *          ];
 *      }
 *  </code>
 *
 * Will result in the actual response that contains the formatted JSON:
 *
 *  <pre>{"ok":true}</pre>
 *
 * Note: Automatic view disabling is appropriately handled.
 *
 * Note: If the response is AJAX and the return value is <tt>null</tt>, the HTTP response will be an empty
 *       response with status code 204.
 */
class AjaxRouteHandler extends Plugin
{
    /**
     * Automatically handle ajax return data.
     *
     * @param \Phalcon\Events\Event   $event       The beforeDispatchLoop event.
     * @param \Phalcon\Mvc\Dispatcher $dispatcher  The application dispatcher instance.
     *
     * @return \Phalcon\Http\Response|void
     */
    public function afterExecuteRoute(Event $event, Dispatcher $dispatcher)
    {
        /** @var \Phalcon\Http\Request $request */
        $request = $this->getDI()->getShared('request');

        if ($request->isAjax()) {
            /** @var \Phalcon\Mvc\View $view */
            $view = $this->getDI()->getShared('view');
            $view->disable();

            /** @var \Phalcon\Http\Response $response */
            $response = $this->getDI()->getShared('response');
            if ($response->isSent() === false && $response->getStatusCode() === false) {
                $data = $dispatcher->getReturnedValue();

                if ($data === null) {
                    $response->setStatusCode(204);
                } else {
                    $response->setJsonContent($data);

                    // Phalcon 2.0.x requires setting of the content type. Phalcon >= 2.1.x automatically includes
                    // this method upon setting of the JSON content.
                    $response->setContentType('application/json', 'UTF-8');
                }

                return $response->send();
            }
        }
    }
}