Members-Manager/admin/views/members/view.html.php

441 lines
13 KiB
PHP

<?php
/**
* @package Joomla.Component.Builder
*
* @created 6th September, 2015
* @author Llewellyn van der Merwe <https://www.joomlacomponentbuilder.com/>
* @github Joomla Component Builder <https://github.com/vdm-io/Joomla-Component-Builder>
* @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');
// import Joomla view library
jimport('joomla.application.component.view');
/**
* Membersmanager View class for the Members
*/
class MembersmanagerViewMembers extends JViewLegacy
{
/**
* Members view display method
* @return void
*/
function display($tpl = null)
{
if ($this->getLayout() !== 'modal')
{
// Include helper submenu
MembersmanagerHelper::addSubmenu('members');
}
// Assign data to the view
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$this->user = JFactory::getUser();
$this->listOrder = $this->escape($this->state->get('list.ordering'));
$this->listDirn = $this->escape($this->state->get('list.direction'));
$this->saveOrder = $this->listOrder == 'ordering';
// get global action permissions
$this->canDo = MembersmanagerHelper::getActions('member');
$this->canEdit = $this->canDo->get('member.edit');
$this->canState = $this->canDo->get('member.edit.state');
$this->canCreate = $this->canDo->get('member.create');
$this->canDelete = $this->canDo->get('member.delete');
$this->canBatch = $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()
{
JToolBarHelper::title(JText::_('COM_MEMBERSMANAGER_MEMBERS'), 'joomla');
JHtmlSidebar::setAction('index.php?option=com_membersmanager&view=members');
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
if ($this->canCreate)
{
JToolBarHelper::addNew('member.add');
}
// Only load if there are items
if (MembersmanagerHelper::checkArray($this->items))
{
if ($this->canEdit)
{
JToolBarHelper::editList('member.edit');
}
if ($this->canState)
{
JToolBarHelper::publishList('members.publish');
JToolBarHelper::unpublishList('members.unpublish');
JToolBarHelper::archiveList('members.archive');
if ($this->canDo->get('core.admin'))
{
JToolBarHelper::checkin('members.checkin');
}
}
// Add a batch button
if ($this->canBatch && $this->canCreate && $this->canEdit && $this->canState)
{
// Get the toolbar object instance
$bar = JToolBar::getInstance('toolbar');
// set the batch button name
$title = JText::_('JTOOLBAR_BATCH');
// Instantiate a new JLayoutFile instance and render the batch button
$layout = new JLayoutFile('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))
{
JToolbarHelper::deleteList('', 'members.delete', 'JTOOLBAR_EMPTY_TRASH');
}
elseif ($this->canState && $this->canDelete)
{
JToolbarHelper::trash('members.trash');
}
if ($this->canDo->get('core.export') && $this->canDo->get('member.export'))
{
JToolBarHelper::custom('members.exportData', 'download', '', 'COM_MEMBERSMANAGER_EXPORT_DATA', true);
}
}
if ($this->canDo->get('core.import') && $this->canDo->get('member.import'))
{
JToolBarHelper::custom('members.importData', 'upload', '', 'COM_MEMBERSMANAGER_IMPORT_DATA', false);
}
// set help url for this view if found
$help_url = MembersmanagerHelper::getHelpUrl('members');
if (MembersmanagerHelper::checkString($help_url))
{
JToolbarHelper::help('COM_MEMBERSMANAGER_HELP_MANAGER', false, $help_url);
}
// add the options comp button
if ($this->canDo->get('core.admin') || $this->canDo->get('core.options'))
{
JToolBarHelper::preferences('com_membersmanager');
}
if ($this->canState)
{
JHtmlSidebar::addFilter(
JText::_('JOPTION_SELECT_PUBLISHED'),
'filter_published',
JHtml::_('select.options', JHtml::_('jgrid.publishedOptions'), 'value', 'text', $this->state->get('filter.published'), true)
);
// only load if batch allowed
if ($this->canBatch)
{
JHtmlBatch_::addListSelection(
JText::_('COM_MEMBERSMANAGER_KEEP_ORIGINAL_STATE'),
'batch[published]',
JHtml::_('select.options', JHtml::_('jgrid.publishedOptions', array('all' => false)), 'value', 'text', '', true)
);
}
}
JHtmlSidebar::addFilter(
JText::_('JOPTION_SELECT_ACCESS'),
'filter_access',
JHtml::_('select.options', JHtml::_('access.assetgroups'), 'value', 'text', $this->state->get('filter.access'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
JHtmlBatch_::addListSelection(
JText::_('COM_MEMBERSMANAGER_KEEP_ORIGINAL_ACCESS'),
'batch[access]',
JHtml::_('select.options', JHtml::_('access.assetgroups'), 'value', 'text')
);
}
// Set Type Name Selection
$this->typeNameOptions = JFormHelper::loadFieldType('Types')->getOptions();
if ($this->typeNameOptions)
{
// Type Name Filter
JHtmlSidebar::addFilter(
'- Select '.JText::_('COM_MEMBERSMANAGER_MEMBER_TYPE_LABEL').' -',
'filter_type',
JHtml::_('select.options', $this->typeNameOptions, 'value', 'text', $this->state->get('filter.type'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Type Name Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.JText::_('COM_MEMBERSMANAGER_MEMBER_TYPE_LABEL').' -',
'batch[type]',
JHtml::_('select.options', $this->typeNameOptions, 'value', 'text')
);
}
}
// Set Account Selection
$this->accountOptions = $this->getTheAccountSelections();
if ($this->accountOptions)
{
// Account Filter
JHtmlSidebar::addFilter(
'- Select '.JText::_('COM_MEMBERSMANAGER_MEMBER_ACCOUNT_LABEL').' -',
'filter_account',
JHtml::_('select.options', $this->accountOptions, 'value', 'text', $this->state->get('filter.account'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Account Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.JText::_('COM_MEMBERSMANAGER_MEMBER_ACCOUNT_LABEL').' -',
'batch[account]',
JHtml::_('select.options', $this->accountOptions, 'value', 'text')
);
}
}
// Set Country Name Selection
$this->countryNameOptions = JFormHelper::loadFieldType('Countries')->getOptions();
if ($this->countryNameOptions)
{
// Country Name Filter
JHtmlSidebar::addFilter(
'- Select '.JText::_('COM_MEMBERSMANAGER_MEMBER_COUNTRY_LABEL').' -',
'filter_country',
JHtml::_('select.options', $this->countryNameOptions, 'value', 'text', $this->state->get('filter.country'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Country Name Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.JText::_('COM_MEMBERSMANAGER_MEMBER_COUNTRY_LABEL').' -',
'batch[country]',
JHtml::_('select.options', $this->countryNameOptions, 'value', 'text')
);
}
}
// Set Region Name Selection
$this->regionNameOptions = JFormHelper::loadFieldType('Regions')->getOptions();
if ($this->regionNameOptions)
{
// Region Name Filter
JHtmlSidebar::addFilter(
'- Select '.JText::_('COM_MEMBERSMANAGER_MEMBER_REGION_LABEL').' -',
'filter_region',
JHtml::_('select.options', $this->regionNameOptions, 'value', 'text', $this->state->get('filter.region'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Region Name Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.JText::_('COM_MEMBERSMANAGER_MEMBER_REGION_LABEL').' -',
'batch[region]',
JHtml::_('select.options', $this->regionNameOptions, 'value', 'text')
);
}
}
// Set City Selection
$this->cityOptions = $this->getTheCitySelections();
if ($this->cityOptions)
{
// City Filter
JHtmlSidebar::addFilter(
'- Select '.JText::_('COM_MEMBERSMANAGER_MEMBER_CITY_LABEL').' -',
'filter_city',
JHtml::_('select.options', $this->cityOptions, 'value', 'text', $this->state->get('filter.city'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// City Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.JText::_('COM_MEMBERSMANAGER_MEMBER_CITY_LABEL').' -',
'batch[city]',
JHtml::_('select.options', $this->cityOptions, 'value', 'text')
);
}
}
// Set Main Member User Selection
$this->main_memberUserOptions = JFormHelper::loadFieldType('Mainmembers')->getOptions();
if ($this->main_memberUserOptions)
{
// Main Member User Filter
JHtmlSidebar::addFilter(
'- Select '.JText::_('COM_MEMBERSMANAGER_MEMBER_MAIN_MEMBER_LABEL').' -',
'filter_main_member',
JHtml::_('select.options', $this->main_memberUserOptions, 'value', 'text', $this->state->get('filter.main_member'))
);
if ($this->canBatch && $this->canCreate && $this->canEdit)
{
// Main Member User Batch Selection
JHtmlBatch_::addListSelection(
'- Keep Original '.JText::_('COM_MEMBERSMANAGER_MEMBER_MAIN_MEMBER_LABEL').' -',
'batch[main_member]',
JHtml::_('select.options', $this->main_memberUserOptions, 'value', 'text')
);
}
}
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function setDocument()
{
if (!isset($this->document))
{
$this->document = JFactory::getDocument();
}
$this->document->setTitle(JText::_('COM_MEMBERSMANAGER_MEMBERS'));
$this->document->addStyleSheet(JURI::root() . "administrator/components/com_membersmanager/assets/css/members.css", (MembersmanagerHelper::jVersion()->isCompatible('3.8.0')) ? array('version' => 'auto') : 'text/css');
}
/**
* 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 MembersmanagerHelper::htmlEscape($var, $this->_charset, true);
}
// use the helper htmlEscape method instead.
return MembersmanagerHelper::htmlEscape($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.sorting' => JText::_('JGRID_HEADING_ORDERING'),
'a.published' => JText::_('JSTATUS'),
'g.name' => JText::_('COM_MEMBERSMANAGER_MEMBER_USER_LABEL'),
'h.name' => JText::_('COM_MEMBERSMANAGER_MEMBER_TYPE_LABEL'),
'a.account' => JText::_('COM_MEMBERSMANAGER_MEMBER_ACCOUNT_LABEL'),
'a.id' => JText::_('JGRID_HEADING_ID')
);
}
protected function getTheAccountSelections()
{
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
// Select the text.
$query->select($db->quoteName('account'));
$query->from($db->quoteName('#__membersmanager_member'));
$query->order($db->quoteName('account') . ' ASC');
// Reset the query using our newly populated query object.
$db->setQuery($query);
$results = $db->loadColumn();
if ($results)
{
// get model
$model = $this->getModel();
$results = array_unique($results);
$_filter = array();
foreach ($results as $account)
{
// Translate the account selection
$text = $model->selectionTranslation($account,'account');
// Now add the account and its text to the options array
$_filter[] = JHtml::_('select.option', $account, JText::_($text));
}
return $_filter;
}
return false;
}
protected function getTheCitySelections()
{
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
// Select the text.
$query->select($db->quoteName('city'));
$query->from($db->quoteName('#__membersmanager_member'));
$query->order($db->quoteName('city') . ' ASC');
// Reset the query using our newly populated query object.
$db->setQuery($query);
$results = $db->loadColumn();
if ($results)
{
$results = array_unique($results);
$_filter = array();
foreach ($results as $city)
{
// Now add the city and its text to the options array
$_filter[] = JHtml::_('select.option', $city, $city);
}
return $_filter;
}
return false;
}
}