Current File : /home/lightco1/upgrade.lightco.com.au/libraries/fof30/Render/RenderInterface.php
<?php
/**
* @package FOF
* @copyright 2010-2017 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license GNU GPL version 2 or later
*/
namespace FOF30\Render;
use FOF30\Container\Container;
use FOF30\Model\DataModel;
use FOF30\Form\Form;
defined('_JEXEC') or die;
interface RenderInterface
{
/**
* Public constructor
*
* @param Container $container The container we are attached to
*/
function __construct(Container $container);
/**
* Returns the information about this renderer
*
* @return object
*/
function getInformation();
/**
* Echoes any HTML to show before the view template
*
* @param string $view The current view
* @param string $task The current task
*
* @return void
*/
function preRender($view, $task);
/**
* Echoes any HTML to show after the view template
*
* @param string $view The current view
* @param string $task The current task
*
* @return void
*/
function postRender($view, $task);
/**
* Renders a Form and returns the corresponding HTML
*
* @param Form &$form The form to render
* @param DataModel $model The model providing our data
* @param string $formType The form type: edit, browse or read
* @param boolean $raw If true, the raw form fields rendering (without the surrounding form tag) is
* returned.
*
* @return string The HTML rendering of the form
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderForm(Form &$form, DataModel $model, $formType = null, $raw = false);
/**
* Renders a F0FForm for a Browse view and returns the corresponding HTML
*
* @param Form &$form The form to render
* @param DataModel $model The model providing our data
*
* @return string The HTML rendering of the form
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderFormBrowse(Form &$form, DataModel $model);
/**
* Renders a F0FForm for a Read view and returns the corresponding HTML
*
* @param Form &$form The form to render
* @param DataModel $model The model providing our data
*
* @return string The HTML rendering of the form
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderFormRead(Form &$form, DataModel $model);
/**
* Renders a F0FForm for an Edit view and returns the corresponding HTML
*
* @param Form &$form The form to render
* @param DataModel $model The model providing our data
*
* @return string The HTML rendering of the form
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderFormEdit(Form &$form, DataModel $model);
/**
* Renders a F0FForm for an Edit view and returns the corresponding HTML
*
* @param Form &$form The form to render
* @param DataModel $model The model providing our data
* @param string $formType The form type: edit, browse or read
*
* @return string The HTML rendering of the form
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderFormRaw(Form &$form, DataModel $model, $formType = null);
/**
* Renders the submenu (link bar) for a category view when it is used in a
* extension
*
* Note: this function has to be called from the addSubmenu function in
* the ExtensionNameHelper class located in
* administrator/components/com_ExtensionName/helpers/Extensionname.php
*
* @return void
*/
function renderCategoryLinkbar();
/**
* Renders a raw fieldset of a F0FForm and returns the corresponding HTML
*
* @param \stdClass &$fieldset The fieldset to render
* @param Form &$form The form to render
* @param DataModel $model The model providing our data
* @param string $formType The form type e.g. 'edit' or 'read'
* @param boolean $showHeader Should I render the fieldset's header?
*
* @return string The HTML rendering of the fieldset
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderFieldset(\stdClass &$fieldset, Form &$form, DataModel $model, $formType, $showHeader = true);
/**
* Renders a label for a fieldset.
*
* @param object $field The field of the label to render
* @param Form &$form The form to render
* @param string $title The title of the label
*
* @return string The rendered label
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function renderFieldsetLabel($field, Form &$form, $title);
/**
* Checks if the fieldset defines a tab pane
*
* @param \SimpleXMLElement $fieldset
*
* @return boolean
*
* @deprecated 3.1 Support for XML forms will be removed in FOF 4
*/
function isTabFieldset($fieldset);
/**
* Set a renderer option (depends on the renderer)
*
* @param string $key The name of the option to set
* @param string $value The value of the option
*
* @return void
*/
function setOption($key, $value);
/**
* Set multiple renderer options at once (depends on the renderer)
*
* @param array $options The options to set as key => value pairs
*
* @return void
*/
function setOptions(array $options);
/**
* Get the value of a renderer option
*
* @param string $key The name of the parameter
* @param mixed $default The default value to return if the parameter is not set
*
* @return mixed The parameter value
*/
function getOption($key, $default = null);
}
Mini Shell