joomla/patchtester
33
0
Fork 0
mirror of https://github.com/joomla-extensions/patchtester.git synced 2025-01-22 22:58:27 +00:00
Code Issues Releases Activity

Break view class inheritance

Browse Source
This commit is contained in:
Michael Babker 2019-08-27 20:05:12 -05:00
parent 208dfdda42
commit 8a515def27
3 changed files with 274 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

220
administrator/components/com_patchtester/PatchTester/View/AbstractHtmlView.php Normal file
View File

@ -0,0 +1,220 @@
<?php
/**
* Patch testing component for the Joomla! CMS
*
* @copyright Copyright (C) 2011 - 2012 Ian MacLennan, Copyright (C) 2013 - 2018 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later
*/
namespace PatchTester\View;
use PatchTester\Model\AbstractModel;
/**
* Base HTML view for the patch testing component
*
* @since __DEPLOY_VERSION__
*/
abstract class AbstractHtmlView extends AbstractView
{
/**
* The view layout.
*
* @var string
* @since __DEPLOY_VERSION__
*/
protected $layout = 'default';
/**
* The paths queue.
*
* @var SplPriorityQueue
* @since __DEPLOY_VERSION__
*/
protected $paths;
/**
* Method to instantiate the view.
*
* @param AbstractModel $model The model object.
* @param SplPriorityQueue $paths The paths queue.
*
* @since __DEPLOY_VERSION__
*/
public function __construct(AbstractModel $model, \SplPriorityQueue $paths = null)
{
parent::__construct($model);
// Setup dependencies.
$this->paths = $paths ?: new \SplPriorityQueue;
}
/**
* Method to escape output.
*
* @param string $output The output to escape.
*
* @return string The escaped output.
*
* @since __DEPLOY_VERSION__
*/
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 __DEPLOY_VERSION__
*/
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 __DEPLOY_VERSION__
*/
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 __DEPLOY_VERSION__
*/
public function getPaths()
{
return $this->paths;
}
/**
* Load a template file -- first look in the templates folder for an override
*
* @param string $tpl The name of the template source file; automatically searches the template paths and compiles as needed.
*
* @return string The output of the the template script.
*
* @since __DEPLOY_VERSION__
* @throws \RuntimeException
*/
public function loadTemplate($tpl = null)
{
// Get the path to the file
$file = $this->getLayout();
if (isset($tpl))
{
$file .= '_' . $tpl;
}
$path = $this->getPath($file);
if (!$path)
{
throw new \RuntimeException(\JText::sprintf('JLIB_APPLICATION_ERROR_LAYOUTFILE_NOT_FOUND', $file), 500);
}
// Unset so as not to introduce into template scope
unset($tpl);
unset($file);
// Never allow a 'this' property
if (isset($this->this))
{
unset($this->this);
}
// Start an output buffer.
ob_start();
// Load the template.
include $path;
// Get the layout contents.
return ob_get_clean();
}
/**
* Method to render the view.
*
* @return string The rendered view.
*
* @since __DEPLOY_VERSION__
* @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 $this
*
* @since __DEPLOY_VERSION__
*/
public function setLayout($layout)
{
$this->layout = $layout;
return $this;
}
/**
* Method to set the view paths.
*
* @param \SplPriorityQueue $paths The paths queue.
*
* @return $this
*
* @since __DEPLOY_VERSION__
*/
public function setPaths(\SplPriorityQueue $paths)
{
$this->paths = $paths;
return $this;
}
}

53
administrator/components/com_patchtester/PatchTester/View/AbstractView.php Normal file
View File

@ -0,0 +1,53 @@
<?php
/**
* Patch testing component for the Joomla! CMS
*
* @copyright Copyright (C) 2011 - 2012 Ian MacLennan, Copyright (C) 2013 - 2018 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later
*/
namespace PatchTester\View;
use PatchTester\Model\AbstractModel;
/**
* Base view for the patch testing component
*
* @since __DEPLOY_VERSION__
*/
abstract class AbstractView
{
/**
* The model object.
*
* @var AbstractModel
* @since __DEPLOY_VERSION__
*/
protected $model;
/**
* Method to instantiate the view.
*
* @param AbstractModel $model The model object.
*
* @since __DEPLOY_VERSION__
*/
public function __construct(AbstractModel $model)
{
$this->model = $model;
}
/**
* Method to escape output.
*
* @param string $output The output to escape.
*
* @return string The escaped output.
*
* @since __DEPLOY_VERSION__
*/
public function escape($output)
{
return $output;
}
}

48
administrator/components/com_patchtester/PatchTester/View/DefaultHtmlView.php
View File

@ -13,52 +13,6 @@ namespace PatchTester\View;
*
* @since 2.0
*/
class DefaultHtmlView extends \JViewHtml
class DefaultHtmlView extends AbstractHtmlView
{
/**
* Load a template file -- first look in the templates folder for an override
*
* @param string $tpl The name of the template source file; automatically searches the template paths and compiles as needed.
*
* @return string The output of the the template script.
*
* @since 2.0
* @throws \RuntimeException
*/
public function loadTemplate($tpl = null)
{
// Get the path to the file
$file = $this->getLayout();
if (isset($tpl))
{
$file .= '_' . $tpl;
}
$path = $this->getPath($file);
if (!$path)
{
throw new \RuntimeException(\JText::sprintf('JLIB_APPLICATION_ERROR_LAYOUTFILE_NOT_FOUND', $file), 500);
}
// Unset so as not to introduce into template scope
unset($tpl);
unset($file);
// Never allow a 'this' property
if (isset($this->this))
{
unset($this->this);
}
// Start an output buffer.
ob_start();
// Load the template.
include $path;
// Get the layout contents.
return ob_get_clean();
}
}