Files
subform-power/admin/src/View/Currencies/HtmlView.php
2024-08-21 16:46:56 +02:00

284 lines
7.4 KiB
PHP

<?php
/*----------------------------------------------------------------------------------| www.vdm.io |----/
Nampharm
/-------------------------------------------------------------------------------------------------------/
@version 1.0.1
@build 21st August, 2024
@created 24th May, 2024
@package Subform Power
@subpackage HtmlView.php
@author Oh Martin <https://nampharm.com.na>
@copyright Copyright (C) 2015. All Rights Reserved
@license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html
____ _____ _____ __ __ __ __ ___ _____ __ __ ____ _____ _ _ ____ _ _ ____
(_ _)( _ )( _ )( \/ )( ) /__\ / __)( _ )( \/ )( _ \( _ )( \( )( ___)( \( )(_ _)
.-_)( )(_)( )(_)( ) ( )(__ /(__)\ ( (__ )(_)( ) ( )___/ )(_)( ) ( )__) ) ( )(
\____) (_____)(_____)(_/\/\_)(____)(__)(__) \___)(_____)(_/\/\_)(__) (_____)(_)\_)(____)(_)\_) (__)
/------------------------------------------------------------------------------------------------------*/
namespace JCB\Component\Subformpower\Administrator\View\Currencies;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Toolbar\Toolbar;
use Joomla\CMS\Form\FormHelper;
use Joomla\CMS\Session\Session;
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\User\User;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\HTML\HTMLHelper as Html;
use Joomla\CMS\Layout\FileLayout;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Toolbar\ToolbarHelper;
use Joomla\CMS\Document\Document;
use JCB\Component\Subformpower\Administrator\Helper\SubformpowerHelper;
use JCB\Joomla\Utilities\ArrayHelper;
use JCB\Joomla\Utilities\StringHelper;
// No direct access to this file
\defined('_JEXEC') or die;
/**
* Subformpower Html View class for the Currencies
*
* @since 1.6
*/
class HtmlView extends BaseHtmlView
{
/**
* The items from the model
*
* @var mixed
* @since 3.10.11
*/
public mixed $items;
/**
* The state object
*
* @var mixed
* @since 3.10.11
*/
public mixed $state;
/**
* The styles url array
*
* @var array
* @since 5.0.0
*/
protected array $styles;
/**
* The scripts url array
*
* @var array
* @since 5.0.0
*/
protected array $scripts;
/**
* The actions object
*
* @var object
* @since 3.10.11
*/
public object $canDo;
/**
* The return here base64 url
*
* @var string
* @since 3.10.11
*/
public string $return_here;
/**
* The user object.
*
* @var User
* @since 3.10.11
*/
public User $user;
/**
* Currencies view display method
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
* @since 1.6
*/
public function display($tpl = null)
{
// Assign data to the view
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$this->styles = $this->get('Styles');
$this->scripts = $this->get('Scripts');
$this->user ??= $this->getCurrentUser();
// 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 = SubformpowerHelper::getActions('currency');
$this->canEdit = $this->canDo->get('currency.edit');
$this->canState = $this->canDo->get('currency.edit.state');
$this->canCreate = $this->canDo->get('currency.create');
$this->canDelete = $this->canDo->get('currency.delete');
$this->canBatch = ($this->canDo->get('currency.batch') && $this->canDo->get('core.batch'));
// If we don't have items we load the empty state
if (is_array($this->items) && !count((array) $this->items) && $this->isEmptyState = $this->get('IsEmptyState'))
{
$this->setLayout('emptystate');
}
// We don't need toolbar in the modal window.
if ($this->getLayout() !== 'modal')
{
$this->addToolbar();
}
// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new \Exception(implode("\n", $errors), 500);
}
// Set the html view document stuff
$this->_prepareDocument();
// Display the template
parent::display($tpl);
}
/**
* Add the page title and toolbar.
*
* @return void
* @since 1.6
*/
protected function addToolbar(): void
{
ToolbarHelper::title(Text::_('COM_SUBFORMPOWER_CURRENCIES'), 'joomla');
if ($this->canCreate)
{
ToolbarHelper::addNew('currency.add');
}
// Only load if there are items
if (ArrayHelper::check($this->items))
{
if ($this->canEdit)
{
ToolbarHelper::editList('currency.edit');
}
if ($this->canState)
{
ToolbarHelper::publishList('currencies.publish');
ToolbarHelper::unpublishList('currencies.unpublish');
ToolbarHelper::archiveList('currencies.archive');
if ($this->canDo->get('core.admin'))
{
ToolbarHelper::checkin('currencies.checkin');
}
}
if ($this->state->get('filter.published') == -2 && ($this->canState && $this->canDelete))
{
ToolbarHelper::deleteList('', 'currencies.delete', 'JTOOLBAR_EMPTY_TRASH');
}
elseif ($this->canState && $this->canDelete)
{
ToolbarHelper::trash('currencies.trash');
}
}
// set help url for this view if found
$this->help_url = SubformpowerHelper::getHelpUrl('currencies');
if (StringHelper::check($this->help_url))
{
ToolbarHelper::help('COM_SUBFORMPOWER_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_subformpower');
}
}
/**
* Prepare some document related stuff.
*
* @return void
* @since 1.6
*/
protected function _prepareDocument(): void
{
// Load jQuery
Html::_('jquery.framework');
$this->getDocument()->setTitle(Text::_('COM_SUBFORMPOWER_CURRENCIES'));
// add styles
foreach ($this->styles as $style)
{
Html::_('stylesheet', $style, ['version' => 'auto']);
}
// add scripts
foreach ($this->scripts as $script)
{
Html::_('script', $script, ['version' => 'auto']);
}
}
/**
* Escapes a value for output in a view script.
*
* @param mixed $var The output to escape.
* @param bool $shorten The switch to shorten.
* @param int $length The shorting length.
*
* @return mixed The escaped value.
* @since 1.6
*/
public function escape($var, bool $shorten = true, int $length = 50)
{
if (!is_string($var))
{
return $var;
}
return StringHelper::html($var, $this->_charset ?? 'UTF-8', $shorten, $length);
}
/**
* Returns an array of fields the table can be sorted by
*
* @return array containing the field name to sort by as the key and display text as value
* @since 1.6
*/
protected function getSortFields()
{
return array(
'a.ordering' => Text::_('JGRID_HEADING_ORDERING'),
'a.published' => Text::_('JSTATUS'),
'a.symbol' => Text::_('COM_SUBFORMPOWER_CURRENCY_SYMBOL_LABEL'),
'a.id' => Text::_('JGRID_HEADING_ID')
);
}
}