Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 202 lines (177 sloc) 3.563 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
<?php
/**
* @package Joomla.Platform
* @subpackage View
*
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/

defined('JPATH_PLATFORM') or die;

jimport('joomla.filesystem.path');

/**
* Joomla Platform HTML View Class
*
* @package Joomla.Platform
* @subpackage View
* @since 12.1
*/
abstract class JViewHtml extends JViewBase
{
/**
* The view layout.
*
* @var string
* @since 12.1
*/
protected $layout = 'default';

/**
* The paths queue.
*
* @var SplPriorityQueue
* @since 12.1
*/
protected $paths;

/**
* Method to instantiate the view.
*
* @param JModel $model The model object.
* @param SplPriorityQueue $paths The paths queue.
*
* @since 12.1
*/
public function __construct(JModel $model, SplPriorityQueue $paths = null)
{
parent::__construct($model);

// Setup dependencies.
$this->paths = isset($paths) ? $paths : $this->loadPaths();
}

/**
* Magic toString method that is a proxy for the render method.
*
* @return string
*
* @since 12.1
*/
public function __toString()
{
return $this->render();
}

/**
* Method to escape output.
*
* @param string $output The output to escape.
*
* @return string The escaped output.
*
* @see JView::escape()
* @since 12.1
*/
public function escape($output)
{
// Escape the output.
return htmlspecialchars($output, ENT_COMPAT, 'UTF-8');
}

/**
* Method to get the view layout.
*
* @return string The layout name.
*
* @since 12.1
*/
public function getLayout()
{
return $this->layout;
}

/**
* Method to get the layout path.
*
* @param string $layout The layout name.
*
* @return mixed The layout file name if found, false otherwise.
*
* @since 12.1
*/
public function getPath($layout)
{
// Get the layout file name.
$file = JPath::clean($layout . '.php');

// Find the layout file path.
$path = JPath::find(clone($this->paths), $file);

return $path;
}

/**
* Method to get the view paths.
*
* @return SplPriorityQueue The paths queue.
*
* @since 12.1
*/
public function getPaths()
{
return $this->paths;
}

/**
* Method to render the view.
*
* @return string The rendered view.
*
* @since 12.1
* @throws RuntimeException
*/
public function render()
{
// Get the layout path.
$path = $this->getPath($this->getLayout());

// Check if the layout path was found.
if (!$path)
{
throw new RuntimeException('Layout Path Not Found');
}

// Start an output buffer.
ob_start();

// Load the layout.
include $path;

// Get the layout contents.
$output = ob_get_clean();

return $output;
}

/**
* Method to set the view layout.
*
* @param string $layout The layout name.
*
* @return JViewHtml Method supports chaining.
*
* @since 12.1
*/
public function setLayout($layout)
{
$this->layout = $layout;

return $this;
}

/**
* Method to set the view paths.
*
* @param SplPriorityQueue $paths The paths queue.
*
* @return JViewHtml Method supports chaining.
*
* @since 12.1
*/
public function setPaths(SplPriorityQueue $paths)
{
$this->paths = $paths;

return $this;
}

/**
* Method to load the paths queue.
*
* @return SplPriorityQueue The paths queue.
*
* @since 12.1
*/
protected function loadPaths()
{
return new SplPriorityQueue;
}
}
Something went wrong with that request. Please try again.