Ingenerator\KohanaView\Renderer\PageLayoutRenderer

Complexity

Total Complexity

9

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	shouldUseLayout()	0	12	4
A	setUseLayout()	0	4	1
A	__construct()	0	5	1
A	render()	0	9	2
A	renderInLayout()	0	6	1

<?php
/**
 * @author     Andrew Coulton <andrew@ingenerator.com>
 * @copyright  2015 inGenerator Ltd
 * @license    http://kohanaframework.org/license
 */

namespace Ingenerator\KohanaView\Renderer;


use Ingenerator\KohanaView\Renderer;
use Ingenerator\KohanaView\ViewModel\PageContentView;
use Ingenerator\KohanaView\ViewModel\PageLayoutView;


/**
 * Renders a PageContentView and - when appropriate - renders the generated output inside a PageLayoutView. By
 * default it will render the layout on normal requests (or when no request is present) but not on AJAX requests.
 * This behaviour can be customised by calling the setUseLayout method.
 *
 * For example, from a controller:
 *
 *    public function action_login()
 *    {
 *       $layout  = new DefaultPageLayout;
 *       $content = new LoginView($layout);
 *       $renderer = new PageLayoutRenderer(new HTMLRenderer, $this->request);
 *       $this->response->body($renderer->render($content));
 *    }
 *
 * Obviously in real life the creation of the views and renderers would happen in your dependency container.
 *
 * @package Ingenerator\KohanaView\Renderer
 */
class PageLayoutRenderer
{
    /**
     * @var bool Whether to force (or not force) embedding the content in the layout
     */
    protected $use_layout;

    /**
     * @var Renderer
     */
    protected $view_renderer;

    /**
     * @var \Request
     */
    protected $current_request;

    public function __construct(Renderer $view_renderer, \Request $current_request = NULL)
    {
        $this->view_renderer   = $view_renderer;
        $this->current_request = $current_request;
    }

    /**
     * @param PageContentView $content_view
     *
     * @return string
     */
    public function render(PageContentView $content_view)
    {
        $content = $this->view_renderer->render($content_view);
        if ($this->shouldUseLayout()) {
            return $this->renderInLayout($content_view->var_page(), $content);
        } else {
            return $content;
        }
    }

    /**
     * @return bool
     */
    protected function shouldUseLayout()
    {
        if ($this->use_layout !== NULL) {
            return $this->use_layout;
        }

        if ($this->current_request AND $this->current_request->is_ajax()) {
            return FALSE;
        } else {
            return TRUE;
        }
    }

    /**
     * @param PageLayoutView $layout
     * @param string         $content
     *
     * @return string
     */
    protected function renderInLayout(PageLayoutView $layout, $content)
    {
        $layout->setBodyHTML($content);

        return $this->view_renderer->render($layout);
    }

    /**
     * Configure whether to always wrap the content in the layout (TRUE), never (FALSE) or automatically for
     * non-AJAX requests (NULL)
     *
     * @param bool $use_layout
     *
     * @return void
     */
    public function setUseLayout($use_layout)
    {
        $this->use_layout = $use_layout;
    }

}