joomla-component/admin/views/linkers/view.html.php
Robot 88104fd483
Stable release of v3.0.0
Move all JText to use the namespaced class Text directly. Move all JHtml to use the namespaced class Html directly. Move all JFactory to use the namespaced class Factory directly. Move all JRoute to use the namespaced class Route directly. Move all JFormHelper to use the namespaced class FormHelper directly. Move all JLayout to use the namespaced class FileLayout directly. Move all JLanguageMultilang to use the namespaced class Multilanguage directly. Move all JComponentHelper to use the namespaced class ComponentHelper directly. Move all JCategoryNode to use the namespaced class CategoryNode directly. Move all JComponentHelper to use the namespaced class ComponentHelper directly. Move all JToolbar to use the namespaced class Toolbar directly. Move all JToolbarHelper to use the namespaced class ToolbarHelper directly. Convert all addStyleSheet to make use of Html class instead. Convert all addScript to make use of Html class instead.
2024-01-22 10:48:28 +02:00

303 lines
9.6 KiB
PHP

<?php
/*----------------------------------------------------------------------------------| io.vdm.dev |----/
Vast Development Method
/-------------------------------------------------------------------------------------------------------/
@package getBible.net
@created 3rd December, 2015
@author Llewellyn van der Merwe <https://getbible.net>
@git Get Bible <https://git.vdm.dev/getBible>
@github Get Bible <https://github.com/getBible>
@support Get Bible <https://git.vdm.dev/getBible/support>
@copyright Copyright (C) 2015. All Rights Reserved
@license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html
/------------------------------------------------------------------------------------------------------*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Form\FormHelper;
use Joomla\CMS\Session\Session;
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\Toolbar\Toolbar;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\HTML\HTMLHelper as Html;
use Joomla\CMS\Layout\FileLayout;
use Joomla\CMS\MVC\View\HtmlView;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Toolbar\ToolbarHelper;
use VDM\Joomla\Utilities\ArrayHelper;
use VDM\Joomla\Utilities\StringHelper;
/**
* Getbible Html View class for the Linkers
*/
class GetbibleViewLinkers extends HtmlView
{
/**
* Linkers view display method
* @return void
*/
function display($tpl = null)
{
if ($this->getLayout() !== 'modal')
{
// Include helper submenu
GetbibleHelper::addSubmenu('linkers');
}
// Assign data to the view
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$this->user = Factory::getUser();
// Load the filter form from xml.
$this->filterForm = $this->get('FilterForm');
// Load the active filters.
$this->activeFilters = $this->get('ActiveFilters');
// Add the list ordering clause.
$this->listOrder = $this->escape($this->state->get('list.ordering', 'a.id'));
$this->listDirn = $this->escape($this->state->get('list.direction', 'DESC'));
$this->saveOrder = $this->listOrder == 'a.ordering';
// set the return here value
$this->return_here = urlencode(base64_encode((string) Uri::getInstance()));
// get global action permissions
$this->canDo = GetbibleHelper::getActions('linker');
$this->canEdit = $this->canDo->get('linker.edit');
$this->canState = $this->canDo->get('linker.edit.state');
$this->canCreate = $this->canDo->get('linker.create');
$this->canDelete = $this->canDo->get('linker.delete');
$this->canBatch = ($this->canDo->get('linker.batch') && $this->canDo->get('core.batch'));
// We don't need toolbar in the modal window.
if ($this->getLayout() !== 'modal')
{
$this->addToolbar();
$this->sidebar = JHtmlSidebar::render();
// load the batch html
if ($this->canCreate && $this->canEdit && $this->canState)
{
$this->batchDisplay = JHtmlBatch_::render();
}
}
// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new Exception(implode("\n", $errors), 500);
}
// Display the template
parent::display($tpl);
// Set the document
$this->setDocument();
}
/**
* Setting the toolbar
*/
protected function addToolBar()
{
JHtmlSidebar::setAction('index.php?option=com_getbible&view=linkers');
ToolbarHelper::title(Text::_('COM_GETBIBLE_LINKERS'), 'joomla');
FormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
if ($this->canCreate)
{
ToolbarHelper::addNew('linker.add');
}
// Only load if there are items
if (ArrayHelper::check($this->items))
{
if ($this->canEdit)
{
ToolbarHelper::editList('linker.edit');
}
if ($this->canState)
{
ToolbarHelper::publishList('linkers.publish');
ToolbarHelper::unpublishList('linkers.unpublish');
ToolbarHelper::archiveList('linkers.archive');
if ($this->canDo->get('core.admin'))
{
ToolbarHelper::checkin('linkers.checkin');
}
}
// Add a batch button
if ($this->canBatch && $this->canCreate && $this->canEdit && $this->canState)
{
// Get the toolbar object instance
$bar = Toolbar::getInstance('toolbar');
// set the batch button name
$title = Text::_('JTOOLBAR_BATCH');
// Instantiate a new JLayoutFile instance and render the batch button
$layout = new FileLayout('joomla.toolbar.batch');
// add the button to the page
$dhtml = $layout->render(array('title' => $title));
$bar->appendButton('Custom', $dhtml, 'batch');
}
if ($this->state->get('filter.published') == -2 && ($this->canState && $this->canDelete))
{
ToolbarHelper::deleteList('', 'linkers.delete', 'JTOOLBAR_EMPTY_TRASH');
}
elseif ($this->canState && $this->canDelete)
{
ToolbarHelper::trash('linkers.trash');
}
}
// set help url for this view if found
$this->help_url = GetbibleHelper::getHelpUrl('linkers');
if (StringHelper::check($this->help_url))
{
ToolbarHelper::help('COM_GETBIBLE_HELP_MANAGER', false, $this->help_url);
}
// add the options comp button
if ($this->canDo->get('core.admin') || $this->canDo->get('core.options'))
{
ToolbarHelper::preferences('com_getbible');
}
// Only load published batch if state and batch is allowed
if ($this->canState && $this->canBatch)
{
JHtmlBatch_::addListSelection(
Text::_('COM_GETBIBLE_KEEP_ORIGINAL_STATE'),
'batch[published]',
Html::_('select.options', Html::_('jgrid.publishedOptions', array('all' => false)), 'value', 'text', '', true)
);
}
// Only load access batch if create, edit and batch is allowed
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
JHtmlBatch_::addListSelection(
Text::_('COM_GETBIBLE_KEEP_ORIGINAL_ACCESS'),
'batch[access]',
Html::_('select.options', Html::_('access.assetgroups'), 'value', 'text')
);
}
// Only load Name batch if create, edit, and batch is allowed
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Set Name Selection
$this->nameOptions = FormHelper::loadFieldType('linkersfiltername')->options;
// We do some sanitation for Name filter
if (ArrayHelper::check($this->nameOptions) &&
isset($this->nameOptions[0]->value) &&
!StringHelper::check($this->nameOptions[0]->value))
{
unset($this->nameOptions[0]);
}
// Name Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.Text::_('COM_GETBIBLE_LINKER_NAME_LABEL').' -',
'batch[name]',
Html::_('select.options', $this->nameOptions, 'value', 'text')
);
}
// Only load Public Tagged Verses batch if create, edit, and batch is allowed
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Set Public Tagged Verses Selection
$this->public_tagged_versesOptions = FormHelper::loadFieldType('linkersfilterpublictaggedverses')->options;
// We do some sanitation for Public Tagged Verses filter
if (ArrayHelper::check($this->public_tagged_versesOptions) &&
isset($this->public_tagged_versesOptions[0]->value) &&
!StringHelper::check($this->public_tagged_versesOptions[0]->value))
{
unset($this->public_tagged_versesOptions[0]);
}
// Public Tagged Verses Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.Text::_('COM_GETBIBLE_LINKER_PUBLIC_TAGGED_VERSES_LABEL').' -',
'batch[public_tagged_verses]',
Html::_('select.options', $this->public_tagged_versesOptions, 'value', 'text')
);
}
// Only load Public Notes batch if create, edit, and batch is allowed
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Set Public Notes Selection
$this->public_notesOptions = FormHelper::loadFieldType('linkersfilterpublicnotes')->options;
// We do some sanitation for Public Notes filter
if (ArrayHelper::check($this->public_notesOptions) &&
isset($this->public_notesOptions[0]->value) &&
!StringHelper::check($this->public_notesOptions[0]->value))
{
unset($this->public_notesOptions[0]);
}
// Public Notes Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.Text::_('COM_GETBIBLE_LINKER_PUBLIC_NOTES_LABEL').' -',
'batch[public_notes]',
Html::_('select.options', $this->public_notesOptions, 'value', 'text')
);
}
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function setDocument()
{
if (!isset($this->document))
{
$this->document = Factory::getDocument();
}
$this->document->setTitle(Text::_('COM_GETBIBLE_LINKERS'));
Html::_('stylesheet', "administrator/components/com_getbible/assets/css/linkers.css", ['version' => 'auto']);
}
/**
* Escapes a value for output in a view script.
*
* @param mixed $var The output to escape.
*
* @return mixed The escaped value.
*/
public function escape($var)
{
if(strlen($var) > 50)
{
// use the helper htmlEscape method instead and shorten the string
return StringHelper::html($var, $this->_charset, true);
}
// use the helper htmlEscape method instead.
return StringHelper::html($var, $this->_charset);
}
/**
* Returns an array of fields the table can be sorted by
*
* @return array Array containing the field name to sort by as the key and display text as value
*/
protected function getSortFields()
{
return array(
'a.ordering' => Text::_('JGRID_HEADING_ORDERING'),
'a.published' => Text::_('JSTATUS'),
'a.name' => Text::_('COM_GETBIBLE_LINKER_NAME_LABEL'),
'a.public_tagged_verses' => Text::_('COM_GETBIBLE_LINKER_PUBLIC_TAGGED_VERSES_LABEL'),
'a.public_notes' => Text::_('COM_GETBIBLE_LINKER_PUBLIC_NOTES_LABEL'),
'a.id' => Text::_('JGRID_HEADING_ID')
);
}
}