Spade
Mini Shell
| Directory:~$ /home/lmsyaran/public_html/joomla4/ |
| [Home] [System Details] [Kill Me] |
abstract.php000064400000017160147362420740007076 0ustar00<?php
/**
* @package FrameworkOnFramework
* @subpackage render
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba
Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
*/
defined('FOF_INCLUDED') or die;
/**
* Abstract view renderer class. The renderer is what turns XML view
templates
* into actual HTML code, renders the submenu links and potentially wraps
the
* HTML output in a div with a component-specific ID.
*
* @package FrameworkOnFramework
* @since 2.0
*/
abstract class FOFRenderAbstract
{
/** @var int Priority of this renderer. Higher means more important */
protected $priority = 50;
/** @var int Is this renderer enabled? */
protected $enabled = false;
/**
* Returns the information about this renderer
*
* @return object
*/
public function getInformation()
{
return (object) array(
'priority' => $this->priority,
'enabled' => $this->enabled,
);
}
/**
* Echoes any HTML to show before the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
abstract public function preRender($view, $task, $input, $config =
array());
/**
* Echoes any HTML to show after the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
abstract public function postRender($view, $task, $input, $config =
array());
/**
* Renders a FOFForm and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @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
*/
public function renderForm(FOFForm &$form, FOFModel $model, FOFInput
$input, $formType = null, $raw = false)
{
if (is_null($formType))
{
$formType = $form->getAttribute('type', 'edit');
}
else
{
$formType = strtolower($formType);
}
switch ($formType)
{
case 'browse':
return $this->renderFormBrowse($form, $model, $input);
break;
case 'read':
if ($raw)
{
return $this->renderFormRaw($form, $model, $input,
'read');
}
else
{
return $this->renderFormRead($form, $model, $input);
}
break;
default:
if ($raw)
{
return $this->renderFormRaw($form, $model, $input,
'edit');
}
else
{
return $this->renderFormEdit($form, $model, $input);
}
break;
}
}
/**
* 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
*
* Example Code:
*
* class ExtensionNameHelper
* {
* public static function addSubmenu($vName)
* {
* // Load FOF
* include_once JPATH_LIBRARIES . '/fof/include.php';
*
* if (!defined('FOF_INCLUDED'))
* {
* JError::raiseError('500', 'FOF is not
installed');
* }
*
* if (version_compare(JVERSION, '3.0', 'ge'))
* {
* $strapper = new FOFRenderJoomla3;
* }
* else
* {
* $strapper = new FOFRenderJoomla;
* }
*
* $strapper->renderCategoryLinkbar('com_babioonevent');
* }
* }
*
* @param string $extension The name of the extension
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
public function renderCategoryLinkbar($extension, $config = array())
{
// On command line don't do anything
if (FOFPlatform::getInstance()->isCli())
{
return;
}
// Do not render a category submenu unless we are in the the admin area
if (!FOFPlatform::getInstance()->isBackend())
{
return;
}
$toolbar = FOFToolbar::getAnInstance($extension, $config);
$toolbar->renderSubmenu();
$this->renderLinkbarItems($toolbar);
}
/**
* Renders a FOFForm for a Browse view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
abstract protected function renderFormBrowse(FOFForm &$form, FOFModel
$model, FOFInput $input);
/**
* Renders a FOFForm for a Read view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
abstract protected function renderFormRead(FOFForm &$form, FOFModel
$model, FOFInput $input);
/**
* Renders a FOFForm for an Edit view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
abstract protected function renderFormEdit(FOFForm &$form, FOFModel
$model, FOFInput $input);
/**
* Renders a raw FOFForm and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @param string $formType The form type e.g. 'edit' or
'read'
*
* @return string The HTML rendering of the form
*/
abstract protected function renderFormRaw(FOFForm &$form, FOFModel
$model, FOFInput $input, $formType);
/**
* Renders a raw fieldset of a FOFForm and returns the corresponding HTML
*
* @TODO: Convert to an abstract method or interface at FOF3
*
* @param stdClass &$fieldset The fieldset to render
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @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
*/
protected function renderFieldset(stdClass &$fieldset, FOFForm
&$form, FOFModel $model, FOFInput $input, $formType, $showHeader =
true)
{
}
/**
* Renders a label for a fieldset.
*
* @TODO: Convert to an abstract method or interface at FOF3
*
* @param object $field The field of the label to render
* @param FOFForm &$form The form to render
* @param string $title The title of the label
*
* @return string The rendered label
*/
protected function renderFieldsetLabel($field, FOFForm &$form, $title)
{
}
/**
* Checks if the fieldset defines a tab pane
*
* @param SimpleXMLElement $fieldset
*
* @return boolean
*/
protected function isTabFieldset($fieldset)
{
if (!isset($fieldset->class) || !$fieldset->class)
{
return false;
}
$class = $fieldset->class;
$classes = explode(' ', $class);
if (!in_array('tab-pane', $classes))
{
return false;
}
else
{
return in_array('active', $classes) ? 2 : 1;
}
}
}
joomla.php000064400000052471147362420740006560 0ustar00<?php
/**
* @package FrameworkOnFramework
* @subpackage render
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba
Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
* @note This file has been modified by the Joomla! Project and no
longer reflects the original work of its author.
*/
defined('FOF_INCLUDED') or die;
/**
* Default Joomla! 1.5, 1.7, 2.5 view renderer class
*
* @package FrameworkOnFramework
* @since 2.0
*/
class FOFRenderJoomla extends FOFRenderAbstract
{
/**
* Public constructor. Determines the priority of this class and if it
should be enabled
*/
public function __construct()
{
$this->priority = 50;
$this->enabled = true;
}
/**
* Echoes any HTML to show before the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
public function preRender($view, $task, $input, $config = array())
{
$format = $input->getCmd('format', 'html');
if (empty($format))
{
$format = 'html';
}
if ($format != 'html')
{
return;
}
$platform = FOFPlatform::getInstance();
if ($platform->isCli())
{
return;
}
if (version_compare(JVERSION, '3.0.0', 'lt'))
{
JHtml::_('behavior.framework');
}
else
{
if (version_compare(JVERSION, '3.3.0', 'ge'))
{
JHtml::_('behavior.core');
}
else
{
JHtml::_('behavior.framework', true);
}
JHtml::_('jquery.framework');
}
// Wrap output in various classes
$version = new JVersion;
$versionParts = explode('.', $version->RELEASE);
$minorVersion = str_replace('.', '',
$version->RELEASE);
$majorVersion = array_shift($versionParts);
if ($platform->isBackend())
{
$area = $platform->isBackend() ? 'admin' :
'site';
$option = $input->getCmd('option', '');
$view = $input->getCmd('view', '');
$layout = $input->getCmd('layout', '');
$task = $input->getCmd('task', '');
$classes = array(
'joomla-version-' . $majorVersion,
'joomla-version-' . $minorVersion,
$area,
$option,
'view-' . $view,
'layout-' . $layout,
'task-' . $task,
);
}
elseif ($platform->isFrontend())
{
// @TODO: Remove the frontend Joomla! version classes in FOF 3
$classes = array(
'joomla-version-' . $majorVersion,
'joomla-version-' . $minorVersion,
);
}
echo '<div id="akeeba-renderjoomla" class="'
. implode(' ', $classes) . "\">\n";
// Render submenu and toolbar (only if asked to)
if ($input->getBool('render_toolbar', true))
{
$this->renderButtons($view, $task, $input, $config);
$this->renderLinkbar($view, $task, $input, $config);
}
}
/**
* Echoes any HTML to show after the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
public function postRender($view, $task, $input, $config = array())
{
$format = $input->getCmd('format', 'html');
if (empty($format))
{
$format = 'html';
}
if ($format != 'html')
{
return;
}
// Closing tag only if we're not in CLI
if (FOFPlatform::getInstance()->isCli())
{
return;
}
echo "</div>\n"; // Closes akeeba-renderjoomla div
}
/**
* Renders a FOFForm for a Browse view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
protected function renderFormBrowse(FOFForm &$form, FOFModel $model,
FOFInput $input)
{
JHtml::_('behavior.multiselect');
// Getting all header row elements
$headerFields = $form->getHeaderset();
// Start the form
$html = '';
$filter_order = $form->getView()->getLists()->order;
$filter_order_Dir = $form->getView()->getLists()->order_Dir;
$actionUrl = FOFPlatform::getInstance()->isBackend() ?
'index.php' : JUri::root().'index.php';
if (FOFPlatform::getInstance()->isFrontend() &&
($input->getCmd('Itemid', 0) != 0))
{
$itemid = $input->getCmd('Itemid', 0);
$uri = new JUri($actionUrl);
if ($itemid)
{
$uri->setVar('Itemid', $itemid);
}
$actionUrl = JRoute::_($uri->toString());
}
$html .= '<form action="'.$actionUrl.'"
method="post" name="adminForm"
id="adminForm">' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="option" value="' .
$input->getCmd('option') . '" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="view" value="' .
FOFInflector::pluralize($input->getCmd('view')) . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="task" value="" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="layout" value="' .
$input->getCmd('layout', '') . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="boxchecked" value="" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="hidemainmenu" value="" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="filter_order" value="' . $filter_order .
'" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="filter_order_Dir" value="' . $filter_order_Dir .
'" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="' . JFactory::getSession()->getFormToken() .
'" value="1" />' . PHP_EOL;
// Start the table output
$html .= "\t\t" . '<table class="adminlist"
id="adminList">' . PHP_EOL;
// Get form parameters
$show_header = $form->getAttribute('show_header', 1);
$show_filters = $form->getAttribute('show_filters', 1);
$show_pagination = $form->getAttribute('show_pagination',
1);
$norows_placeholder =
$form->getAttribute('norows_placeholder', '');
// Open the table header region if required
if ($show_header || $show_filters)
{
$html .= "\t\t\t<thead>" . PHP_EOL;
}
// Pre-render the header and filter rows
if ($show_header || $show_filters)
{
$header_html = '';
$filter_html = '';
foreach ($headerFields as $header)
{
// Make sure we have a header field. Under Joomla! 2.5 we cannot
// render filter-only fields.
$tmpHeader = $header->header;
if (empty($tmpHeader))
{
continue;
}
$tdwidth = $header->tdwidth;
if (!empty($tdwidth))
{
$tdwidth = 'width="' . $tdwidth . '"';
}
else
{
$tdwidth = '';
}
$header_html .= "\t\t\t\t\t<th $tdwidth>" . PHP_EOL;
$header_html .= "\t\t\t\t\t\t" . $tmpHeader;
$header_html .= "\t\t\t\t\t</th>" . PHP_EOL;
$filter = $header->filter;
$buttons = $header->buttons;
$options = $header->options;
$filter_html .= "\t\t\t\t\t<td>" . PHP_EOL;
if (!empty($filter))
{
$filter_html .= "\t\t\t\t\t\t$filter" . PHP_EOL;
if (!empty($buttons))
{
$filter_html .=
"\t\t\t\t\t\t<nobr>$buttons</nobr>" . PHP_EOL;
}
}
elseif (!empty($options))
{
$label = $header->label;
$emptyOption = JHtml::_('select.option', '',
'- ' . JText::_($label) . ' -');
array_unshift($options, $emptyOption);
$attribs = array(
'onchange' => 'document.adminForm.submit();'
);
$filter = JHtml::_('select.genericlist', $options,
$header->name, $attribs, 'value', 'text',
$header->value, false, true);
$filter_html .= "\t\t\t\t\t\t$filter" . PHP_EOL;
}
$filter_html .= "\t\t\t\t\t</td>" . PHP_EOL;
}
}
// Render header if enabled
if ($show_header)
{
$html .= "\t\t\t\t<tr>" . PHP_EOL;
$html .= $header_html;
$html .= "\t\t\t\t</tr>" . PHP_EOL;
}
// Render filter row if enabled
if ($show_filters)
{
$html .= "\t\t\t\t<tr>";
$html .= $filter_html;
$html .= "\t\t\t\t</tr>";
}
// Close the table header region if required
if ($show_header || $show_filters)
{
$html .= "\t\t\t</thead>" . PHP_EOL;
}
// Loop through rows and fields, or show placeholder for no rows
$html .= "\t\t\t<tbody>" . PHP_EOL;
$fields = $form->getFieldset('items');
$num_columns = count($fields);
$items = $form->getModel()->getItemList();
if ($count = count($items))
{
$m = 1;
foreach ($items as $i => $item)
{
$table_item = $form->getModel()->getTable();
$table_item->reset();
$table_item->bind($item);
$form->bind($item);
$m = 1 - $m;
$class = 'row' . $m;
$html .= "\t\t\t\t<tr class=\"$class\">" .
PHP_EOL;
$fields = $form->getFieldset('items');
foreach ($fields as $field)
{
$field->rowid = $i;
$field->item = $table_item;
$labelClass = $field->labelClass ? $field->labelClass :
$field->labelclass; // Joomla! 2.5/3.x use different case for the same
name
$class = $labelClass ? 'class ="' . $labelClass .
'"' : '';
$html .= "\t\t\t\t\t<td $class>" .
$field->getRepeatable() . '</td>' . PHP_EOL;
}
$html .= "\t\t\t\t</tr>" . PHP_EOL;
}
}
elseif ($norows_placeholder)
{
$html .= "\t\t\t\t<tr><td
colspan=\"$num_columns\">";
$html .= JText::_($norows_placeholder);
$html .= "</td></tr>\n";
}
$html .= "\t\t\t</tbody>" . PHP_EOL;
// Render the pagination bar, if enabled
if ($show_pagination)
{
$pagination = $form->getModel()->getPagination();
$html .= "\t\t\t<tfoot>" . PHP_EOL;
$html .= "\t\t\t\t<tr><td
colspan=\"$num_columns\">";
if (($pagination->total > 0))
{
$html .= $pagination->getListFooter();
}
$html .= "</td></tr>\n";
$html .= "\t\t\t</tfoot>" . PHP_EOL;
}
// End the table output
$html .= "\t\t" . '</table>' . PHP_EOL;
// End the form
$html .= '</form>' . PHP_EOL;
return $html;
}
/**
* Renders a FOFForm for a Read view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
protected function renderFormRead(FOFForm &$form, FOFModel $model,
FOFInput $input)
{
$html = $this->renderFormRaw($form, $model, $input, 'read');
return $html;
}
/**
* Renders a FOFForm for an Edit view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
protected function renderFormEdit(FOFForm &$form, FOFModel $model,
FOFInput $input)
{
// Get the key for this model's table
$key = $model->getTable()->getKeyName();
$keyValue = $model->getId();
JHTML::_('behavior.tooltip');
$html = '';
$validate = strtolower($form->getAttribute('validate'));
$class = '';
if (in_array($validate, array('true', 'yes',
'1', 'on')))
{
JHtml::_('behavior.formvalidation');
$class = 'form-validate ';
$this->loadValidationScript($form);
}
// Check form enctype. Use enctype="multipart/form-data" to
upload binary files in your form.
$template_form_enctype = $form->getAttribute('enctype');
if (!empty($template_form_enctype))
{
$enctype = ' enctype="' .
$form->getAttribute('enctype') . '" ';
}
else
{
$enctype = '';
}
// Check form name. Use name="yourformname" to modify the name
of your form.
$formname = $form->getAttribute('name');
if (empty($formname))
{
$formname = 'adminForm';
}
// Check form ID. Use id="yourformname" to modify the id of
your form.
$formid = $form->getAttribute('name');
if (empty($formid))
{
$formid = 'adminForm';
}
// Check if we have a custom task
$customTask = $form->getAttribute('customTask');
if (empty($customTask))
{
$customTask = '';
}
// Get the form action URL
$actionUrl = FOFPlatform::getInstance()->isBackend() ?
'index.php' : JUri::root().'index.php';
if (FOFPlatform::getInstance()->isFrontend() &&
($input->getCmd('Itemid', 0) != 0))
{
$itemid = $input->getCmd('Itemid', 0);
$uri = new JUri($actionUrl);
if ($itemid)
{
$uri->setVar('Itemid', $itemid);
}
$actionUrl = JRoute::_($uri->toString());
}
$html .= '<form action="'.$actionUrl.'"
method="post" name="' . $formname .
'" id="' . $formid . '"' . $enctype .
' class="' . $class .
'">' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="option" value="' .
$input->getCmd('option') . '" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="view" value="' .
$input->getCmd('view', 'edit') . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="task" value="' . $customTask . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="' . $key . '" value="' . $keyValue .
'" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="' . JFactory::getSession()->getFormToken() .
'" value="1" />' . PHP_EOL;
$html .= $this->renderFormRaw($form, $model, $input,
'edit');
$html .= '</form>';
return $html;
}
/**
* Renders a raw FOFForm and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @param string $formType The form type e.g. 'edit' or
'read'
*
* @return string The HTML rendering of the form
*/
protected function renderFormRaw(FOFForm &$form, FOFModel $model,
FOFInput $input, $formType)
{
$html = '';
foreach ($form->getFieldsets() as $fieldset)
{
$html .= $this->renderFieldset($fieldset, $form, $model, $input,
$formType, false);
}
return $html;
}
/**
* Renders a raw fieldset of a FOFForm and returns the corresponding HTML
*
* @param stdClass &$fieldset The fieldset to render
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @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
*/
protected function renderFieldset(stdClass &$fieldset, FOFForm
&$form, FOFModel $model, FOFInput $input, $formType, $showHeader =
true)
{
$html = '';
$fields = $form->getFieldset($fieldset->name);
if (isset($fieldset->class))
{
$class = 'class="' . $fieldset->class .
'"';
}
else
{
$class = '';
}
$element = empty($fields) ? 'div' : 'fieldset';
$html .= "\t" . '<' . $element . '
id="' . $fieldset->name . '" ' . $class .
'>' . PHP_EOL;
$isTabbedFieldset = $this->isTabFieldset($fieldset);
if (isset($fieldset->label) && !empty($fieldset->label)
&& !$isTabbedFieldset)
{
$html .= "\t\t" . '<h3>' .
JText::_($fieldset->label) . '</h3>' . PHP_EOL;
}
foreach ($fields as $field)
{
$groupClass = $form->getFieldAttribute($field->fieldname,
'groupclass', '', $field->group);
// Auto-generate label and description if needed
// Field label
$title = $form->getFieldAttribute($field->fieldname,
'label', '', $field->group);
$emptylabel = $form->getFieldAttribute($field->fieldname,
'emptylabel', false, $field->group);
if (empty($title) && !$emptylabel)
{
$model->getName();
$title = strtoupper($input->get('option') . '_'
. $model->getName() . '_' . $field->id .
'_LABEL');
}
// Field description
$description = $form->getFieldAttribute($field->fieldname,
'description', '', $field->group);
/**
* The following code is backwards incompatible. Most forms don't
require a description in their form
* fields. Having to use emptydescription="1" on each one of
them is an overkill. Removed.
*/
/*
$emptydescription = $form->getFieldAttribute($field->fieldname,
'emptydescription', false, $field->group);
if (empty($description) && !$emptydescription)
{
$description = strtoupper($input->get('option') .
'_' . $model->getName() . '_' . $field->id .
'_DESC');
}
*/
if ($formType == 'read')
{
$inputField = $field->static;
}
elseif ($formType == 'edit')
{
$inputField = $field->input;
}
if (empty($title))
{
$html .= "\t\t\t" . $inputField . PHP_EOL;
if (!empty($description) && $formType == 'edit')
{
$html .= "\t\t\t\t" . '<span
class="help-block">';
$html .= JText::_($description) . '</span>' . PHP_EOL;
}
}
else
{
$html .= "\t\t\t" . '<div class="fof-row '
. $groupClass . '">' . PHP_EOL;
$html .= $this->renderFieldsetLabel($field, $form, $title);
$html .= "\t\t\t\t" . $inputField . PHP_EOL;
if (!empty($description))
{
$html .= "\t\t\t\t" . '<span
class="help-block">';
$html .= JText::_($description) . '</span>' . PHP_EOL;
}
$html .= "\t\t\t" . '</div>' . PHP_EOL;
}
}
$element = empty($fields) ? 'div' : 'fieldset';
$html .= "\t" . '</' . $element . '>'
. PHP_EOL;
return $html;
}
/**
* Renders a label for a fieldset.
*
* @param object $field The field of the label to render
* @param FOFForm &$form The form to render
* @param string $title The title of the label
*
* @return string The rendered label
*/
protected function renderFieldsetLabel($field, FOFForm &$form, $title)
{
$html = '';
$labelClass = $field->labelClass ? $field->labelClass :
$field->labelclass; // Joomla! 2.5/3.x use different case for the same
name
$required = $field->required;
if ($required)
{
$labelClass .= ' required';
}
$tooltip = $form->getFieldAttribute($field->fieldname,
'tooltip', '', $field->group);
if (!empty($tooltip))
{
JHtml::_('behavior.tooltip');
$tooltipText = JText::_($title) . '::' . JText::_($tooltip);
$labelClass .= ' hasTip';
$html .= "\t\t\t\t" . '<label id="' .
$field->id . '-lbl" class="' . $labelClass .
'" for="' . $field->id . '"
title="' . $tooltipText . '"
rel="tooltip">';
}
else
{
$html .= "\t\t\t\t" . '<label class="' .
$labelClass . '" for="' . $field->id .
'">';
}
$html .= JText::_($title);
if ($required)
{
$html .= '<span
class="star"> *</span>';
}
$html .= "\t\t\t\t" . '</label>' . PHP_EOL;
return $html;
}
/**
* Loads the validation script for an edit form
*
* @param FOFForm &$form The form we are rendering
*
* @return void
*/
protected function loadValidationScript(FOFForm &$form)
{
$message =
$form->getView()->escape(JText::_('JGLOBAL_VALIDATION_FORM_FAILED'));
$js = <<<JS
Joomla.submitbutton = function(task)
{
if (task == 'cancel' ||
document.formvalidator.isValid(document.id('adminForm')))
{
Joomla.submitform(task, document.getElementById('adminForm'));
}
else {
alert('$message');
}
};
JS;
$document = FOFPlatform::getInstance()->getDocument();
if ($document instanceof JDocument)
{
$document->addScriptDeclaration($js);
}
}
/**
* Renders the submenu (link bar)
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderLinkbar($view, $task, $input, $config = array())
{
// On command line don't do anything
if (FOFPlatform::getInstance()->isCli())
{
return;
}
// Do not render a submenu unless we are in the the admin area
$toolbar =
FOFToolbar::getAnInstance($input->getCmd('option',
'com_foobar'), $config);
$renderFrontendSubmenu = $toolbar->getRenderFrontendSubmenu();
if (!FOFPlatform::getInstance()->isBackend() &&
!$renderFrontendSubmenu)
{
return;
}
$this->renderLinkbarItems($toolbar);
}
/**
* do the rendering job for the linkbar
*
* @param FOFToolbar $toolbar A toolbar object
*
* @return void
*/
protected function renderLinkbarItems($toolbar)
{
$links = $toolbar->getLinks();
if (!empty($links))
{
foreach ($links as $link)
{
JSubMenuHelper::addEntry($link['name'],
$link['link'], $link['active']);
}
}
}
/**
* Renders the toolbar buttons
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderButtons($view, $task, $input, $config = array())
{
// On command line don't do anything
if (FOFPlatform::getInstance()->isCli())
{
return;
}
// Do not render buttons unless we are in the the frontend area and we
are asked to do so
$toolbar =
FOFToolbar::getAnInstance($input->getCmd('option',
'com_foobar'), $config);
$renderFrontendButtons = $toolbar->getRenderFrontendButtons();
if (FOFPlatform::getInstance()->isBackend() ||
!$renderFrontendButtons)
{
return;
}
// Load main backend language, in order to display toolbar strings
// (JTOOLBAR_BACK, JTOOLBAR_PUBLISH etc etc)
FOFPlatform::getInstance()->loadTranslations('joomla');
$title =
JFactory::getApplication()->get('JComponentTitle');
$bar = JToolbar::getInstance('toolbar');
// Delete faux links, since if SEF is on, Joomla will follow the link
instead of submitting the form
$bar_content = str_replace('href="#"', '',
$bar->render());
echo '<div id="FOFHeaderHolder">',
$bar_content, $title, '<div
style="clear:both"></div>',
'</div>';
}
}
joomla3.php000064400000012027147362420740006634 0ustar00<?php
/**
* @package FrameworkOnFramework
* @subpackage render
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba
Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
* @note This file has been modified by the Joomla! Project and no
longer reflects the original work of its author.
*/
defined('FOF_INCLUDED') or die;
/**
* Joomla! 3 view renderer class
*
* @package FrameworkOnFramework
* @since 2.0
*/
class FOFRenderJoomla3 extends FOFRenderStrapper
{
/**
* Public constructor. Determines the priority of this class and if it
should be enabled
*/
public function __construct()
{
$this->priority = 55;
$this->enabled = version_compare(JVERSION, '3.0',
'ge');
}
/**
* Echoes any HTML to show before the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
public function preRender($view, $task, $input, $config = array())
{
$format = $input->getCmd('format', 'html');
if (empty($format))
{
$format = 'html';
}
if ($format != 'html')
{
return;
}
$platform = FOFPlatform::getInstance();
if ($platform->isCli())
{
return;
}
if (version_compare(JVERSION, '3.3.0', 'ge'))
{
JHtml::_('behavior.core');
}
else
{
JHtml::_('behavior.framework', true);
}
JHtml::_('jquery.framework');
if ($platform->isBackend())
{
// Wrap output in various classes
$version = new JVersion;
$versionParts = explode('.', $version->RELEASE);
$minorVersion = str_replace('.', '',
$version->RELEASE);
$majorVersion = array_shift($versionParts);
$option = $input->getCmd('option', '');
$view = $input->getCmd('view', '');
$layout = $input->getCmd('layout', '');
$task = $input->getCmd('task', '');
$classes = ' class="' . implode(
' ',
array(
'joomla-version-' . $majorVersion,
'joomla-version-' . $minorVersion,
'admin',
$option,
'view-' . $view,
'layout-' . $layout,
'task-' . $task,
)
) . '"';
}
else
{
$classes = '';
}
echo '<div id="akeeba-renderjoomla"' . $classes .
">\n";
// Render the submenu and toolbar
if ($input->getBool('render_toolbar', true))
{
$this->renderButtons($view, $task, $input, $config);
$this->renderLinkbar($view, $task, $input, $config);
}
}
/**
* Echoes any HTML to show after the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
public function postRender($view, $task, $input, $config = array())
{
$format = $input->getCmd('format', 'html');
if (empty($format))
{
$format = 'html';
}
if ($format != 'html')
{
return;
}
// Closing tag only if we're not in CLI
if (FOFPlatform::getInstance()->isCli())
{
return;
}
echo "</div>\n"; // Closes akeeba-renderjoomla div
}
/**
* Renders the submenu (link bar)
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderLinkbar($view, $task, $input, $config = array())
{
$style = 'joomla';
if (array_key_exists('linkbar_style', $config))
{
$style = $config['linkbar_style'];
}
switch ($style)
{
case 'joomla':
$this->renderLinkbar_joomla($view, $task, $input);
break;
case 'classic':
default:
$this->renderLinkbar_classic($view, $task, $input);
break;
}
}
/**
* Renders a label for a fieldset.
*
* @param object $field The field of the label to render
* @param FOFForm &$form The form to render
* @param string $title The title of the label
*
* @return string The rendered label
*/
protected function renderFieldsetLabel($field, FOFForm &$form, $title)
{
$html = '';
$labelClass = $field->labelClass ? $field->labelClass :
$field->labelclass; // Joomla! 2.5/3.x use different case for the same
name
$required = $field->required;
$tooltip = $form->getFieldAttribute($field->fieldname,
'tooltip', '', $field->group);
if (!empty($tooltip))
{
JHtml::_('bootstrap.tooltip');
$tooltipText = '<strong>' . JText::_($title) .
'</strong><br />' . JText::_($tooltip);
$html .= "\t\t\t\t" . '<label
class="control-label hasTooltip ' . $labelClass . '"
for="' . $field->id . '" title="' .
$tooltipText . '" rel="tooltip">';
}
else
{
$html .= "\t\t\t\t" . '<label
class="control-label ' . $labelClass . '"
for="' . $field->id . '">';
}
$html .= JText::_($title);
if ($required)
{
$html .= ' *';
}
$html .= '</label>' . PHP_EOL;
return $html;
}
}
strapper.php000064400000111302147362420740007124 0ustar00<?php
/**
* @package FrameworkOnFramework
* @subpackage render
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba
Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
* @note This file has been modified by the Joomla! Project and no
longer reflects the original work of its author.
*/
defined('FOF_INCLUDED') or die;
/**
* Akeeba Strapper view renderer class.
*
* @package FrameworkOnFramework
* @since 2.0
*/
class FOFRenderStrapper extends FOFRenderAbstract
{
/**
* Public constructor. Determines the priority of this class and if it
should be enabled
*/
public function __construct()
{
$this->priority = 60;
$this->enabled = class_exists('AkeebaStrapper');
}
/**
* Echoes any HTML to show before the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
public function preRender($view, $task, $input, $config = array())
{
$format = $input->getCmd('format', 'html');
if (empty($format))
{
$format = 'html';
}
if ($format != 'html')
{
return;
}
$platform = FOFPlatform::getInstance();
if ($platform->isCli())
{
return;
}
if (version_compare(JVERSION, '3.0.0', 'lt'))
{
JHtml::_('behavior.framework');
}
else
{
if (version_compare(JVERSION, '3.3.0', 'ge'))
{
JHtml::_('behavior.core');
}
else
{
JHtml::_('behavior.framework', true);
}
JHtml::_('jquery.framework');
}
// Wrap output in various classes
$version = new JVersion;
$versionParts = explode('.', $version->RELEASE);
$minorVersion = str_replace('.', '',
$version->RELEASE);
$majorVersion = array_shift($versionParts);
if ($platform->isBackend())
{
$area = $platform->isBackend() ? 'admin' :
'site';
$option = $input->getCmd('option', '');
$view = $input->getCmd('view', '');
$layout = $input->getCmd('layout', '');
$task = $input->getCmd('task', '');
$classes = array(
'joomla-version-' . $majorVersion,
'joomla-version-' . $minorVersion,
$area,
$option,
'view-' . $view,
'layout-' . $layout,
'task-' . $task,
// We have a floating sidebar, they said. It looks great, they said.
They must've been blind, I say!
'j-toggle-main',
'j-toggle-transition',
'span12',
);
}
elseif ($platform->isFrontend())
{
// @TODO: Remove the frontend Joomla! version classes in FOF 3
$classes = array(
'joomla-version-' . $majorVersion,
'joomla-version-' . $minorVersion,
);
}
// Wrap output in divs
echo '<div id="akeeba-bootstrap" class="' .
implode(' ', $classes) . "\">\n";
echo "<div class=\"akeeba-bootstrap\">\n";
echo "<div class=\"row-fluid\">\n";
// Render submenu and toolbar (only if asked to)
if ($input->getBool('render_toolbar', true))
{
$this->renderButtons($view, $task, $input, $config);
$this->renderLinkbar($view, $task, $input, $config);
}
}
/**
* Echoes any HTML to show after the view template
*
* @param string $view The current view
* @param string $task The current task
* @param FOFInput $input The input array (request parameters)
* @param array $config The view configuration array
*
* @return void
*/
public function postRender($view, $task, $input, $config = array())
{
$format = $input->getCmd('format', 'html');
if ($format != 'html' ||
FOFPlatform::getInstance()->isCli())
{
return;
}
if (!FOFPlatform::getInstance()->isCli() &&
version_compare(JVERSION, '3.0', 'ge'))
{
$sidebarEntries = JHtmlSidebar::getEntries();
if (!empty($sidebarEntries))
{
echo '</div>';
}
}
echo "</div>\n"; // Closes row-fluid div
echo "</div>\n"; // Closes akeeba-bootstrap div
echo "</div>\n"; // Closes joomla-version div
}
/**
* Loads the validation script for an edit form
*
* @param FOFForm &$form The form we are rendering
*
* @return void
*/
protected function loadValidationScript(FOFForm &$form)
{
$message =
$form->getView()->escape(JText::_('JGLOBAL_VALIDATION_FORM_FAILED'));
$js = <<<JS
Joomla.submitbutton = function(task)
{
if (task == 'cancel' ||
document.formvalidator.isValid(document.id('adminForm')))
{
Joomla.submitform(task, document.getElementById('adminForm'));
}
else {
alert('$message');
}
};
JS;
$document = FOFPlatform::getInstance()->getDocument();
if ($document instanceof JDocument)
{
$document->addScriptDeclaration($js);
}
}
/**
* Renders the submenu (link bar)
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderLinkbar($view, $task, $input, $config = array())
{
$style = 'classic';
if (array_key_exists('linkbar_style', $config))
{
$style = $config['linkbar_style'];
}
if (!version_compare(JVERSION, '3.0', 'ge'))
{
$style = 'classic';
}
switch ($style)
{
case 'joomla':
$this->renderLinkbar_joomla($view, $task, $input);
break;
case 'classic':
default:
$this->renderLinkbar_classic($view, $task, $input);
break;
}
}
/**
* Renders the submenu (link bar) in FOF's classic style, using a
Bootstrapped
* tab bar.
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderLinkbar_classic($view, $task, $input, $config =
array())
{
if (FOFPlatform::getInstance()->isCli())
{
return;
}
// Do not render a submenu unless we are in the the admin area
$toolbar =
FOFToolbar::getAnInstance($input->getCmd('option',
'com_foobar'), $config);
$renderFrontendSubmenu = $toolbar->getRenderFrontendSubmenu();
if (!FOFPlatform::getInstance()->isBackend() &&
!$renderFrontendSubmenu)
{
return;
}
$links = $toolbar->getLinks();
if (!empty($links))
{
echo "<ul class=\"nav nav-tabs\">\n";
foreach ($links as $link)
{
$dropdown = false;
if (array_key_exists('dropdown', $link))
{
$dropdown = $link['dropdown'];
}
if ($dropdown)
{
echo "<li";
$class = 'dropdown';
if ($link['active'])
{
$class .= ' active';
}
echo ' class="' . $class . '">';
echo '<a class="dropdown-toggle"
data-toggle="dropdown" href="#">';
if ($link['icon'])
{
echo "<i class=\"icon icon-" .
$link['icon'] . "\"></i>";
}
echo $link['name'];
echo '<b class="caret"></b>';
echo '</a>';
echo "\n<ul class=\"dropdown-menu\">";
foreach ($link['items'] as $item)
{
echo "<li";
if ($item['active'])
{
echo ' class="active"';
}
echo ">";
if ($item['icon'])
{
echo "<i class=\"icon icon-" .
$item['icon'] . "\"></i>";
}
if ($item['link'])
{
echo "<a href=\"" . $item['link'] .
"\">" . $item['name'] . "</a>";
}
else
{
echo $item['name'];
}
echo "</li>";
}
echo "</ul>\n";
}
else
{
echo "<li";
if ($link['active'])
{
echo ' class="active"';
}
echo ">";
if ($link['icon'])
{
echo "<i class=\"icon icon-" .
$link['icon'] . "\"></i>";
}
if ($link['link'])
{
echo "<a href=\"" . $link['link'] .
"\">" . $link['name'] . "</a>";
}
else
{
echo $link['name'];
}
}
echo "</li>\n";
}
echo "</ul>\n";
}
}
/**
* Renders the submenu (link bar) using Joomla!'s style. On Joomla!
2.5 this
* is a list of bar separated links, on Joomla! 3 it's a sidebar at
the
* left-hand side of the page.
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderLinkbar_joomla($view, $task, $input, $config =
array())
{
// On command line don't do anything
if (FOFPlatform::getInstance()->isCli())
{
return;
}
// Do not render a submenu unless we are in the the admin area
$toolbar =
FOFToolbar::getAnInstance($input->getCmd('option',
'com_foobar'), $config);
$renderFrontendSubmenu = $toolbar->getRenderFrontendSubmenu();
if (!FOFPlatform::getInstance()->isBackend() &&
!$renderFrontendSubmenu)
{
return;
}
$this->renderLinkbarItems($toolbar);
}
/**
* do the rendering job for the linkbar
*
* @param FOFToolbar $toolbar A toolbar object
*
* @return void
*/
protected function renderLinkbarItems($toolbar)
{
$links = $toolbar->getLinks();
if (!empty($links))
{
foreach ($links as $link)
{
JHtmlSidebar::addEntry($link['name'],
$link['link'], $link['active']);
$dropdown = false;
if (array_key_exists('dropdown', $link))
{
$dropdown = $link['dropdown'];
}
if ($dropdown)
{
foreach ($link['items'] as $item)
{
JHtmlSidebar::addEntry('– ' . $item['name'],
$item['link'], $item['active']);
}
}
}
}
}
/**
* Renders the toolbar buttons
*
* @param string $view The active view name
* @param string $task The current task
* @param FOFInput $input The input object
* @param array $config Extra configuration variables for the
toolbar
*
* @return void
*/
protected function renderButtons($view, $task, $input, $config = array())
{
if (FOFPlatform::getInstance()->isCli())
{
return;
}
// Do not render buttons unless we are in the the frontend area and we
are asked to do so
$toolbar =
FOFToolbar::getAnInstance($input->getCmd('option',
'com_foobar'), $config);
$renderFrontendButtons = $toolbar->getRenderFrontendButtons();
// Load main backend language, in order to display toolbar strings
// (JTOOLBAR_BACK, JTOOLBAR_PUBLISH etc etc)
FOFPlatform::getInstance()->loadTranslations('joomla');
if (FOFPlatform::getInstance()->isBackend() ||
!$renderFrontendButtons)
{
return;
}
$bar = JToolbar::getInstance('toolbar');
$items = $bar->getItems();
$substitutions = array(
'icon-32-new' => 'icon-plus',
'icon-32-publish' => 'icon-eye-open',
'icon-32-unpublish' => 'icon-eye-close',
'icon-32-delete' => 'icon-trash',
'icon-32-edit' => 'icon-edit',
'icon-32-copy' => 'icon-th-large',
'icon-32-cancel' => 'icon-remove',
'icon-32-back' => 'icon-circle-arrow-left',
'icon-32-apply' => 'icon-ok',
'icon-32-save' => 'icon-hdd',
'icon-32-save-new' => 'icon-repeat',
);
if(isset(JFactory::getApplication()->JComponentTitle))
{
$title = JFactory::getApplication()->JComponentTitle;
}
else
{
$title = '';
}
$html = array();
$actions = array();
// For BC we have to use the same id we're using inside other
renderers (FOFHeaderHolder)
//$html[] = '<div class="well" id="' .
$bar->getName() . '">';
$html[] = '<div class="well"
id="FOFHeaderHolder">';
$html[] = '<div
class="titleHolder">'.$title.'</div>';
$html[] = '<div
class="buttonsHolder">';
foreach ($items as $node)
{
$type = $node[0];
$button = $bar->loadButtonType($type);
if ($button !== false)
{
if (method_exists($button, 'fetchId'))
{
$id = call_user_func_array(array(&$button, 'fetchId'),
$node);
}
else
{
$id = null;
}
$action = call_user_func_array(array(&$button,
'fetchButton'), $node);
$action = str_replace('class="toolbar"',
'class="toolbar btn"', $action);
$action = str_replace('<span ', '<i ',
$action);
$action = str_replace('</span>',
'</i>', $action);
$action = str_replace(array_keys($substitutions),
array_values($substitutions), $action);
$actions[] = $action;
}
}
$html = array_merge($html, $actions);
$html[] = '</div>';
$html[] = '</div>';
echo implode("\n", $html);
}
/**
* Renders a FOFForm for a Browse view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
protected function renderFormBrowse(FOFForm &$form, FOFModel $model,
FOFInput $input)
{
$html = '';
JHtml::_('behavior.multiselect');
// Joomla! 3.0+ support
if (version_compare(JVERSION, '3.0', 'ge'))
{
JHtml::_('bootstrap.tooltip');
JHtml::_('dropdown.init');
JHtml::_('formbehavior.chosen', 'select');
$view = $form->getView();
$order = $view->escape($view->getLists()->order);
$html .= <<<HTML
<script type="text/javascript">
Joomla.orderTable = function() {
table = document.getElementById("sortTable");
direction = document.getElementById("directionTable");
order = table.options[table.selectedIndex].value;
if (order != '$order')
{
dirn = 'asc';
}
else {
dirn = direction.options[direction.selectedIndex].value;
}
Joomla.tableOrdering(order, dirn);
};
</script>
HTML;
}
else
{
JHtml::_('behavior.tooltip');
}
// Getting all header row elements
$headerFields = $form->getHeaderset();
// Get form parameters
$show_header = $form->getAttribute('show_header', 1);
$show_filters = $form->getAttribute('show_filters', 1);
$show_pagination = $form->getAttribute('show_pagination',
1);
$norows_placeholder =
$form->getAttribute('norows_placeholder', '');
// Joomla! 3.0 sidebar support
if (version_compare(JVERSION, '3.0', 'gt'))
{
$form_class = '';
if ($show_filters)
{
JHtmlSidebar::setAction("index.php?option=" .
$input->getCmd('option') . "&view=" .
FOFInflector::pluralize($input->getCmd('view'))
);
}
// Reorder the fields with ordering first
$tmpFields = array();
$i = 1;
foreach ($headerFields as $tmpField)
{
if ($tmpField instanceof FOFFormHeaderOrdering)
{
$tmpFields[0] = $tmpField;
}
else
{
$tmpFields[$i] = $tmpField;
}
$i++;
}
$headerFields = $tmpFields;
ksort($headerFields, SORT_NUMERIC);
}
else
{
$form_class = 'class="form-horizontal"';
}
// Pre-render the header and filter rows
$header_html = '';
$filter_html = '';
$sortFields = array();
if ($show_header || $show_filters)
{
foreach ($headerFields as $headerField)
{
$header = $headerField->header;
$filter = $headerField->filter;
$buttons = $headerField->buttons;
$options = $headerField->options;
$sortable = $headerField->sortable;
$tdwidth = $headerField->tdwidth;
// Under Joomla! < 3.0 we can't have filter-only fields
if (version_compare(JVERSION, '3.0', 'lt')
&& empty($header))
{
continue;
}
// If it's a sortable field, add to the list of sortable fields
if ($sortable)
{
$sortFields[$headerField->name] = JText::_($headerField->label);
}
// Get the table data width, if set
if (!empty($tdwidth))
{
$tdwidth = 'width="' . $tdwidth . '"';
}
else
{
$tdwidth = '';
}
if (!empty($header))
{
$header_html .= "\t\t\t\t\t<th $tdwidth>" . PHP_EOL;
$header_html .= "\t\t\t\t\t\t" . $header;
$header_html .= "\t\t\t\t\t</th>" . PHP_EOL;
}
if (version_compare(JVERSION, '3.0', 'ge'))
{
// Joomla! 3.0 or later
if (!empty($filter))
{
$filter_html .= '<div class="filter-search btn-group
pull-left">' . "\n";
$filter_html .= "\t" . '<label
for="title" class="element-invisible">';
$filter_html .= JText::_($headerField->label);
$filter_html .= "</label>\n";
$filter_html .= "\t$filter\n";
$filter_html .= "</div>\n";
if (!empty($buttons))
{
$filter_html .= '<div class="btn-group pull-left
hidden-phone">' . "\n";
$filter_html .= "\t$buttons\n";
$filter_html .= '</div>' . "\n";
}
}
elseif (!empty($options))
{
$label = $headerField->label;
JHtmlSidebar::addFilter(
'- ' . JText::_($label) . ' -', (string)
$headerField->name,
JHtml::_(
'select.options',
$options,
'value',
'text',
$model->getState($headerField->name, ''), true
)
);
}
}
else
{
// Joomla! 2.5
$filter_html .= "\t\t\t\t\t<td>" . PHP_EOL;
if (!empty($filter))
{
$filter_html .= "\t\t\t\t\t\t$filter" . PHP_EOL;
if (!empty($buttons))
{
$filter_html .= '<div class="btn-group
hidden-phone">' . PHP_EOL;
$filter_html .= "\t\t\t\t\t\t$buttons" . PHP_EOL;
$filter_html .= '</div>' . PHP_EOL;
}
}
elseif (!empty($options))
{
$label = $headerField->label;
$emptyOption = JHtml::_('select.option', '',
'- ' . JText::_($label) . ' -');
array_unshift($options, $emptyOption);
$attribs = array(
'onchange' => 'document.adminForm.submit();'
);
$filter = JHtml::_('select.genericlist', $options,
$headerField->name, $attribs, 'value', 'text',
$headerField->value, false, true);
$filter_html .= "\t\t\t\t\t\t$filter" . PHP_EOL;
}
$filter_html .= "\t\t\t\t\t</td>" . PHP_EOL;
}
}
}
// Start the form
$filter_order = $form->getView()->getLists()->order;
$filter_order_Dir = $form->getView()->getLists()->order_Dir;
$actionUrl = FOFPlatform::getInstance()->isBackend() ?
'index.php' : JUri::root().'index.php';
if (FOFPlatform::getInstance()->isFrontend() &&
($input->getCmd('Itemid', 0) != 0))
{
$itemid = $input->getCmd('Itemid', 0);
$uri = new JUri($actionUrl);
if ($itemid)
{
$uri->setVar('Itemid', $itemid);
}
$actionUrl = JRoute::_($uri->toString());
}
$html .= '<form action="'.$actionUrl.'"
method="post" name="adminForm" id="adminForm"
' . $form_class . '>' . PHP_EOL;
if (version_compare(JVERSION, '3.0', 'ge'))
{
// Joomla! 3.0+
// Get and output the sidebar, if present
$sidebar = JHtmlSidebar::render();
if ($show_filters && !empty($sidebar))
{
$html .= '<div id="j-sidebar-container"
class="span2">' . "\n";
$html .= "\t$sidebar\n";
$html .= "</div>\n";
$html .= '<div id="j-main-container"
class="span10">' . "\n";
}
else
{
$html .= '<div id="j-main-container">' .
"\n";
}
// Render header search fields, if the header is enabled
if ($show_header)
{
$html .= "\t" . '<div id="filter-bar"
class="btn-toolbar">' . "\n";
$html .= "$filter_html\n";
if ($show_pagination)
{
// Render the pagination rows per page selection box, if the
pagination is enabled
$html .= "\t" . '<div class="btn-group
pull-right hidden-phone">' . "\n";
$html .= "\t\t" . '<label for="limit"
class="element-invisible">' .
JText::_('JFIELD_PLG_SEARCH_SEARCHLIMIT_DESC') .
'</label>' . "\n";
$html .= "\t\t" .
$model->getPagination()->getLimitBox() . "\n";
$html .= "\t" . '</div>' . "\n";
}
if (!empty($sortFields))
{
// Display the field sort order
$asc_sel = ($view->getLists()->order_Dir == 'asc') ?
'selected="selected"' : '';
$desc_sel = ($view->getLists()->order_Dir == 'desc')
? 'selected="selected"' : '';
$html .= "\t" . '<div class="btn-group
pull-right hidden-phone">' . "\n";
$html .= "\t\t" . '<label
for="directionTable"
class="element-invisible">' .
JText::_('JFIELD_ORDERING_DESC') . '</label>' .
"\n";
$html .= "\t\t" . '<select
name="directionTable" id="directionTable"
class="input-medium"
onchange="Joomla.orderTable()">' . "\n";
$html .= "\t\t\t" . '<option
value="">' . JText::_('JFIELD_ORDERING_DESC') .
'</option>' . "\n";
$html .= "\t\t\t" . '<option value="asc"
' . $asc_sel . '>' .
JText::_('JGLOBAL_ORDER_ASCENDING') . '</option>'
. "\n";
$html .= "\t\t\t" . '<option value="desc"
' . $desc_sel . '>' .
JText::_('JGLOBAL_ORDER_DESCENDING') .
'</option>' . "\n";
$html .= "\t\t" . '</select>' .
"\n";
$html .= "\t" . '</div>' . "\n\n";
// Display the sort fields
$html .= "\t" . '<div class="btn-group
pull-right">' . "\n";
$html .= "\t\t" . '<label for="sortTable"
class="element-invisible">' .
JText::_('JGLOBAL_SORT_BY') . '</label>' .
"\n";
$html .= "\t\t" . '<select
name="sortTable" id="sortTable"
class="input-medium"
onchange="Joomla.orderTable()">' . "\n";
$html .= "\t\t\t" . '<option
value="">' . JText::_('JGLOBAL_SORT_BY') .
'</option>' . "\n";
$html .= "\t\t\t" . JHtml::_('select.options',
$sortFields, 'value', 'text',
$view->getLists()->order) . "\n";
$html .= "\t\t" . '</select>' .
"\n";
$html .= "\t" . '</div>' . "\n";
}
$html .= "\t</div>\n\n";
$html .= "\t" . '<div class="clearfix">
</div>' . "\n\n";
}
}
// Start the table output
$html .= "\t\t" . '<table class="table
table-striped" id="itemsList">' . PHP_EOL;
// Open the table header region if required
if ($show_header || ($show_filters && version_compare(JVERSION,
'3.0', 'lt')))
{
$html .= "\t\t\t<thead>" . PHP_EOL;
}
// Render the header row, if enabled
if ($show_header)
{
$html .= "\t\t\t\t<tr>" . PHP_EOL;
$html .= $header_html;
$html .= "\t\t\t\t</tr>" . PHP_EOL;
}
// Render filter row if enabled
if ($show_filters && version_compare(JVERSION, '3.0',
'lt'))
{
$html .= "\t\t\t\t<tr>";
$html .= $filter_html;
$html .= "\t\t\t\t</tr>";
}
// Close the table header region if required
if ($show_header || ($show_filters && version_compare(JVERSION,
'3.0', 'lt')))
{
$html .= "\t\t\t</thead>" . PHP_EOL;
}
// Loop through rows and fields, or show placeholder for no rows
$html .= "\t\t\t<tbody>" . PHP_EOL;
$fields = $form->getFieldset('items');
$num_columns = count($fields);
$items = $model->getItemList();
if ($count = count($items))
{
$m = 1;
foreach ($items as $i => $item)
{
$table_item = $model->getTable();
$table_item->reset();
$table_item->bind($item);
$form->bind($item);
$m = 1 - $m;
$class = 'row' . $m;
$html .= "\t\t\t\t<tr class=\"$class\">" .
PHP_EOL;
$fields = $form->getFieldset('items');
// Reorder the fields to have ordering first
if (version_compare(JVERSION, '3.0', 'gt'))
{
$tmpFields = array();
$j = 1;
foreach ($fields as $tmpField)
{
if ($tmpField instanceof FOFFormFieldOrdering)
{
$tmpFields[0] = $tmpField;
}
else
{
$tmpFields[$j] = $tmpField;
}
$j++;
}
$fields = $tmpFields;
ksort($fields, SORT_NUMERIC);
}
foreach ($fields as $field)
{
$field->rowid = $i;
$field->item = $table_item;
$labelClass = $field->labelClass ? $field->labelClass :
$field->labelclass; // Joomla! 2.5/3.x use different case for the same
name
$class = $labelClass ? 'class ="' . $labelClass .
'"' : '';
$html .= "\t\t\t\t\t<td $class>" .
$field->getRepeatable() . '</td>' . PHP_EOL;
}
$html .= "\t\t\t\t</tr>" . PHP_EOL;
}
}
elseif ($norows_placeholder)
{
$html .= "\t\t\t\t<tr><td
colspan=\"$num_columns\">";
$html .= JText::_($norows_placeholder);
$html .= "</td></tr>\n";
}
$html .= "\t\t\t</tbody>" . PHP_EOL;
// Render the pagination bar, if enabled, on J! 2.5
if ($show_pagination && version_compare(JVERSION,
'3.0', 'lt'))
{
$pagination = $model->getPagination();
$html .= "\t\t\t<tfoot>" . PHP_EOL;
$html .= "\t\t\t\t<tr><td
colspan=\"$num_columns\">";
if (($pagination->total > 0))
{
$html .= $pagination->getListFooter();
}
$html .= "</td></tr>\n";
$html .= "\t\t\t</tfoot>" . PHP_EOL;
}
// End the table output
$html .= "\t\t" . '</table>' . PHP_EOL;
// Render the pagination bar, if enabled, on J! 3.0+
if ($show_pagination && version_compare(JVERSION,
'3.0', 'ge'))
{
$html .= $model->getPagination()->getListFooter();
}
// Close the wrapper element div on Joomla! 3.0+
if (version_compare(JVERSION, '3.0', 'ge'))
{
$html .= "</div>\n";
}
$html .= "\t" . '<input type="hidden"
name="option" value="' .
$input->getCmd('option') . '" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="view" value="' .
FOFInflector::pluralize($input->getCmd('view')) . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="task" value="' .
$input->getCmd('task', 'browse') . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="layout" value="' .
$input->getCmd('layout', '') . '"
/>' . PHP_EOL;
// The id field is required in Joomla! 3 front-end to prevent the
pagination limit box from screwing it up. Huh!!
if (version_compare(JVERSION, '3.0', 'ge') &&
FOFPlatform::getInstance()->isFrontend())
{
$html .= "\t" . '<input type="hidden"
name="id" value="' . $input->getCmd('id',
'') . '" />' . PHP_EOL;
}
$html .= "\t" . '<input type="hidden"
name="boxchecked" value="" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="hidemainmenu" value="" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="filter_order" value="' . $filter_order .
'" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="filter_order_Dir" value="' . $filter_order_Dir .
'" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="' . JFactory::getSession()->getFormToken() .
'" value="1" />' . PHP_EOL;
// End the form
$html .= '</form>' . PHP_EOL;
return $html;
}
/**
* Renders a FOFForm for a Read view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
protected function renderFormRead(FOFForm &$form, FOFModel $model,
FOFInput $input)
{
$html = $this->renderFormRaw($form, $model, $input, 'read');
return $html;
}
/**
* Renders a FOFForm for an Edit view and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
*
* @return string The HTML rendering of the form
*/
protected function renderFormEdit(FOFForm &$form, FOFModel $model,
FOFInput $input)
{
// Get the key for this model's table
$key = $model->getTable()->getKeyName();
$keyValue = $model->getId();
$html = '';
$validate = strtolower($form->getAttribute('validate'));
if (in_array($validate, array('true', 'yes',
'1', 'on')))
{
JHtml::_('behavior.formvalidation');
$class = ' form-validate';
$this->loadValidationScript($form);
}
else
{
$class = '';
}
// Check form enctype. Use enctype="multipart/form-data" to
upload binary files in your form.
$template_form_enctype = $form->getAttribute('enctype');
if (!empty($template_form_enctype))
{
$enctype = ' enctype="' .
$form->getAttribute('enctype') . '" ';
}
else
{
$enctype = '';
}
// Check form name. Use name="yourformname" to modify the name
of your form.
$formname = $form->getAttribute('name');
if (empty($formname))
{
$formname = 'adminForm';
}
// Check form ID. Use id="yourformname" to modify the id of
your form.
$formid = $form->getAttribute('name');
if (empty($formid))
{
$formid = 'adminForm';
}
// Check if we have a custom task
$customTask = $form->getAttribute('customTask');
if (empty($customTask))
{
$customTask = '';
}
// Get the form action URL
$actionUrl = FOFPlatform::getInstance()->isBackend() ?
'index.php' : JUri::root().'index.php';
if (FOFPlatform::getInstance()->isFrontend() &&
($input->getCmd('Itemid', 0) != 0))
{
$itemid = $input->getCmd('Itemid', 0);
$uri = new JUri($actionUrl);
if ($itemid)
{
$uri->setVar('Itemid', $itemid);
}
$actionUrl = JRoute::_($uri->toString());
}
$html .= '<form action="'.$actionUrl.'"
method="post" name="' . $formname .
'" id="' . $formid . '"' . $enctype .
' class="form-horizontal' .
$class . '">' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="option" value="' .
$input->getCmd('option') . '" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="view" value="' .
$input->getCmd('view', 'edit') . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="task" value="' . $customTask . '"
/>' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="' . $key . '" value="' . $keyValue .
'" />' . PHP_EOL;
$html .= "\t" . '<input type="hidden"
name="' . JFactory::getSession()->getFormToken() .
'" value="1" />' . PHP_EOL;
$html .= $this->renderFormRaw($form, $model, $input,
'edit');
$html .= '</form>';
return $html;
}
/**
* Renders a raw FOFForm and returns the corresponding HTML
*
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @param string $formType The form type e.g. 'edit' or
'read'
*
* @return string The HTML rendering of the form
*/
protected function renderFormRaw(FOFForm &$form, FOFModel $model,
FOFInput $input, $formType)
{
$html = '';
$tabHtml = array();
// Do we have a tabbed form?
$isTabbed = $form->getAttribute('tabbed', '0');
$isTabbed = in_array($isTabbed, array('true', 'yes',
'on', '1'));
foreach ($form->getFieldsets() as $fieldset)
{
if ($isTabbed && $this->isTabFieldset($fieldset))
{
continue;
}
elseif ($isTabbed && isset($fieldset->innertab))
{
$inTab = $fieldset->innertab;
}
else
{
$inTab = '__outer';
}
$tabHtml[$inTab][] = $this->renderFieldset($fieldset, $form, $model,
$input, $formType, false);
}
// If the form is tabbed, render the tabs bars
if ($isTabbed)
{
$html .= '<ul class="nav nav-tabs">' .
PHP_EOL;
foreach ($form->getFieldsets() as $fieldset)
{
// Only create tabs for tab fieldsets
$isTabbedFieldset = $this->isTabFieldset($fieldset);
if (!$isTabbedFieldset)
{
continue;
}
// Only create tabs if we do have a label
if (!isset($fieldset->label) || empty($fieldset->label))
{
continue;
}
$label = JText::_($fieldset->label);
$name = $fieldset->name;
$liClass = ($isTabbedFieldset == 2) ?
'class="active"' : '';
$html .= "<li $liClass><a href=\"#$name\"
data-toggle=\"tab\">$label</a></li>" .
PHP_EOL;
}
$html .= '</ul>' . "\n\n<div
class=\"tab-content\">" . PHP_EOL;
foreach ($form->getFieldsets() as $fieldset)
{
if (!$this->isTabFieldset($fieldset))
{
continue;
}
$html .= $this->renderFieldset($fieldset, $form, $model, $input,
$formType, false, $tabHtml);
}
$html .= "</div>\n";
}
if (isset($tabHtml['__outer']))
{
$html .= implode('', $tabHtml['__outer']);
}
return $html;
}
/**
* Renders a raw fieldset of a FOFForm and returns the corresponding HTML
*
* @param stdClass &$fieldset The fieldset to render
* @param FOFForm &$form The form to render
* @param FOFModel $model The model providing our data
* @param FOFInput $input The input object
* @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
*/
protected function renderFieldset(stdClass &$fieldset, FOFForm
&$form, FOFModel $model, FOFInput $input, $formType, $showHeader =
true, &$innerHtml = null)
{
$html = '';
$fields = $form->getFieldset($fieldset->name);
if (isset($fieldset->class))
{
$class = 'class="' . $fieldset->class .
'"';
}
else
{
$class = '';
}
if (isset($innerHtml[$fieldset->name]))
{
$innerclass = isset($fieldset->innerclass) ? '
class="' . $fieldset->innerclass . '"' :
'';
$html .= "\t" . '<div id="' .
$fieldset->name . '" ' . $class . '>' .
PHP_EOL;
$html .= "\t\t" . '<div' . $innerclass .
'>' . PHP_EOL;
}
else
{
$html .= "\t" . '<div id="' .
$fieldset->name . '" ' . $class . '>' .
PHP_EOL;
}
$isTabbedFieldset = $this->isTabFieldset($fieldset);
if (isset($fieldset->label) && !empty($fieldset->label)
&& !$isTabbedFieldset)
{
$html .= "\t\t" . '<h3>' .
JText::_($fieldset->label) . '</h3>' . PHP_EOL;
}
foreach ($fields as $field)
{
$groupClass = $form->getFieldAttribute($field->fieldname,
'groupclass', '', $field->group);
// Auto-generate label and description if needed
// Field label
$title = $form->getFieldAttribute($field->fieldname,
'label', '', $field->group);
$emptylabel = $form->getFieldAttribute($field->fieldname,
'emptylabel', false, $field->group);
if (empty($title) && !$emptylabel)
{
$model->getName();
$title = strtoupper($input->get('option') . '_'
. $model->getName() . '_' . $field->id .
'_LABEL');
}
// Field description
$description = $form->getFieldAttribute($field->fieldname,
'description', '', $field->group);
/**
* The following code is backwards incompatible. Most forms don't
require a description in their form
* fields. Having to use emptydescription="1" on each one of
them is an overkill. Removed.
*/
/*
$emptydescription = $form->getFieldAttribute($field->fieldname,
'emptydescription', false, $field->group);
if (empty($description) && !$emptydescription)
{
$description = strtoupper($input->get('option') .
'_' . $model->getName() . '_' . $field->id .
'_DESC');
}
*/
if ($formType == 'read')
{
$inputField = $field->static;
}
elseif ($formType == 'edit')
{
$inputField = $field->input;
}
if (empty($title))
{
$html .= "\t\t\t" . $inputField . PHP_EOL;
if (!empty($description) && $formType == 'edit')
{
$html .= "\t\t\t\t" . '<span
class="help-block">';
$html .= JText::_($description) . '</span>' . PHP_EOL;
}
}
else
{
$html .= "\t\t\t" . '<div class="control-group
' . $groupClass . '">' . PHP_EOL;
$html .= $this->renderFieldsetLabel($field, $form, $title);
$html .= "\t\t\t\t" . '<div
class="controls">' . PHP_EOL;
$html .= "\t\t\t\t\t" . $inputField . PHP_EOL;
if (!empty($description))
{
$html .= "\t\t\t\t" . '<span
class="help-block">';
$html .= JText::_($description) . '</span>' . PHP_EOL;
}
$html .= "\t\t\t\t" . '</div>' . PHP_EOL;
$html .= "\t\t\t" . '</div>' . PHP_EOL;
}
}
if (isset($innerHtml[$fieldset->name]))
{
$html .= "\t\t" . '</div>' . PHP_EOL;
$html .= implode('', $innerHtml[$fieldset->name]) .
PHP_EOL;
$html .= "\t" . '</div>' . PHP_EOL;
}
else
{
$html .= "\t" . '</div>' . PHP_EOL;
}
return $html;
}
/**
* Renders a label for a fieldset.
*
* @param object $field The field of the label to render
* @param FOFForm &$form The form to render
* @param string $title The title of the label
*
* @return string The rendered label
*/
protected function renderFieldsetLabel($field, FOFForm &$form, $title)
{
$html = '';
$labelClass = $field->labelClass ? $field->labelClass :
$field->labelclass; // Joomla! 2.5/3.x use different case for the same
name
$required = $field->required;
$tooltip = $form->getFieldAttribute($field->fieldname,
'tooltip', '', $field->group);
if (!empty($tooltip))
{
if (version_compare(JVERSION, '3.0', 'ge'))
{
static $loadedTooltipScript = false;
if (!$loadedTooltipScript)
{
$js = <<<JS
(function($)
{
$(document).ready(function()
{
$('.fof-tooltip').tooltip({placement: 'top'});
});
})(akeeba.jQuery);
JS;
$document = FOFPlatform::getInstance()->getDocument();
if ($document instanceof JDocument)
{
$document->addScriptDeclaration($js);
}
$loadedTooltipScript = true;
}
$tooltipText = '<strong>' . JText::_($title) .
'</strong><br />' . JText::_($tooltip);
$html .= "\t\t\t\t" . '<label
class="control-label fof-tooltip ' . $labelClass . '"
for="' . $field->id . '" title="' .
$tooltipText . '" data-toggle="fof-tooltip">';
}
else
{
// Joomla! 2.5 has a conflict with the jQueryUI tooltip, therefore we
// have to use native Joomla! 2.5 tooltips
JHtml::_('behavior.tooltip');
$tooltipText = JText::_($title) . '::' . JText::_($tooltip);
$html .= "\t\t\t\t" . '<label
class="control-label hasTip ' . $labelClass . '"
for="' . $field->id . '" title="' .
$tooltipText . '" rel="tooltip">';
}
}
else
{
$html .= "\t\t\t\t" . '<label
class="control-label ' . $labelClass . '"
for="' . $field->id . '">';
}
$html .= JText::_($title);
if ($required)
{
$html .= ' *';
}
$html .= '</label>' . PHP_EOL;
return $html;
}
}
interface.php000064400000001171151156421000007210 0ustar00<?php
/**
* @package FrameworkOnFramework
* @subpackage hal
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba
Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
*/
defined('FOF_INCLUDED') or die;
/**
* Interface for HAL document renderers
*
* @package FrameworkOnFramework
* @since 2.1
*/
interface FOFHalRenderInterface
{
/**
* Render a HAL document into a representation suitable for consumption.
*
* @param array $options Renderer-specific options
*
* @return void
*/
public function render($options = array());
}
json.php000064400000006500151156421000006222 0ustar00<?php
/**
* @package FrameworkOnFramework
* @subpackage hal
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba
Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
*/
defined('FOF_INCLUDED') or die;
/**
* Implements the HAL over JSON renderer
*
* @package FrameworkOnFramework
* @since 2.1
*/
class FOFHalRenderJson implements FOFHalRenderInterface
{
/**
* When data is an array we'll output the list of data under this key
*
* @var string
*/
private $_dataKey = '_list';
/**
* The document to render
*
* @var FOFHalDocument
*/
protected $_document;
/**
* Public constructor
*
* @param FOFHalDocument &$document The document to render
*/
public function __construct(&$document)
{
$this->_document = $document;
}
/**
* Render a HAL document in JSON format
*
* @param array $options Rendering options. You can currently only set
json_options (json_encode options)
*
* @return string The JSON representation of the HAL document
*/
public function render($options = array())
{
if (isset($options['data_key']))
{
$this->_dataKey = $options['data_key'];
}
if (isset($options['json_options']))
{
$jsonOptions = $options['json_options'];
}
else
{
$jsonOptions = 0;
}
$serialiseThis = new stdClass;
// Add links
$collection = $this->_document->getLinks();
$serialiseThis->_links = new stdClass;
foreach ($collection as $rel => $links)
{
if (!is_array($links))
{
$serialiseThis->_links->$rel = $this->_getLink($links);
}
else
{
$serialiseThis->_links->$rel = array();
foreach ($links as $link)
{
array_push($serialiseThis->_links->$rel,
$this->_getLink($link));
}
}
}
// Add embedded documents
$collection = $this->_document->getEmbedded();
if (!empty($collection))
{
$serialiseThis->_embedded->$rel = new stdClass;
foreach ($collection as $rel => $embeddeddocs)
{
if (!is_array($embeddeddocs))
{
$embeddeddocs = array($embeddeddocs);
}
foreach ($embeddeddocs as $embedded)
{
$renderer = new FOFHalRenderJson($embedded);
array_push($serialiseThis->_embedded->$rel,
$renderer->render($options));
}
}
}
// Add data
$data = $this->_document->getData();
if (is_object($data))
{
if ($data instanceof FOFTable)
{
$data = $data->getData();
}
else
{
$data = (array) $data;
}
if (!empty($data))
{
foreach ($data as $k => $v)
{
$serialiseThis->$k = $v;
}
}
}
elseif (is_array($data))
{
$serialiseThis->{$this->_dataKey} = $data;
}
return json_encode($serialiseThis, $jsonOptions);
}
/**
* Converts a FOFHalLink object into a stdClass object which will be used
* for JSON serialisation
*
* @param FOFHalLink $link The link you want converted
*
* @return stdClass The converted link object
*/
protected function _getLink(FOFHalLink $link)
{
$ret = array(
'href' => $link->href
);
if ($link->templated)
{
$ret['templated'] = 'true';
}
if (!empty($link->name))
{
$ret['name'] = $link->name;
}
if (!empty($link->hreflang))
{
$ret['hreflang'] = $link->hreflang;
}
if (!empty($link->title))
{
$ret['title'] = $link->title;
}
return (object) $ret;
}
}