Cost-Benefit-Projection/admin/models/countries.php

492 lines
14 KiB
PHP
Raw Permalink Normal View History

2015-12-01 05:06:34 +00:00
<?php
2022-03-03 02:58:38 +00:00
/*----------------------------------------------------------------------------------| www.giz.de |----/
Deutsche Gesellschaft für International Zusammenarbeit (GIZ) Gmb
/-------------------------------------------------------------------------------------------------------/
2022-05-27 05:41:44 +00:00
@version 3.5.x
@build 27th May, 2022
2022-03-03 02:58:38 +00:00
@created 15th June, 2012
@package Cost Benefit Projection
@subpackage countries.php
@author Llewellyn van der Merwe <http://www.vdm.io>
@owner Deutsche Gesellschaft für International Zusammenarbeit (GIZ) Gmb
@copyright Copyright (C) 2015. All Rights Reserved
@license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html
/-------------------------------------------------------------------------------------------------------/
Cost Benefit Projection Tool.
/------------------------------------------------------------------------------------------------------*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
2022-05-27 05:41:44 +00:00
use Joomla\CMS\MVC\Model\ListModel;
2022-03-03 02:58:38 +00:00
use Joomla\Utilities\ArrayHelper;
/**
2022-05-27 05:41:44 +00:00
* Countries List Model
2022-03-03 02:58:38 +00:00
*/
2022-05-27 05:41:44 +00:00
class CostbenefitprojectionModelCountries extends ListModel
2022-03-03 02:58:38 +00:00
{
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
2015-12-01 05:06:34 +00:00
'a.id','id',
'a.published','published',
2021-01-06 13:46:53 +00:00
'a.access','access',
2015-12-01 05:06:34 +00:00
'a.ordering','ordering',
'a.created_by','created_by',
'a.modified_by','modified_by',
2021-01-06 13:46:53 +00:00
'h.name','currency',
2015-12-01 05:06:34 +00:00
'a.name','name',
2021-01-06 13:46:53 +00:00
'g.name','user',
2015-12-01 05:06:34 +00:00
'a.codethree','codethree',
'a.codetwo','codetwo',
2022-03-03 02:58:38 +00:00
'a.working_days','working_days'
);
}
parent::__construct($config);
}
/**
* Method to auto-populate the model state.
*
* Note. Calling getState in this method will result in recursion.
*
* @param string $ordering An optional ordering field.
* @param string $direction An optional direction (asc|desc).
*
* @return void
*
*/
protected function populateState($ordering = null, $direction = null)
{
$app = JFactory::getApplication();
// Adjust the context to support modal layouts.
if ($layout = $app->input->get('layout'))
{
$this->context .= '.' . $layout;
2021-01-06 13:46:53 +00:00
}
$access = $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access', 0, 'int');
$this->setState('filter.access', $access);
$published = $this->getUserStateFromRequest($this->context . '.filter.published', 'filter_published', '');
$this->setState('filter.published', $published);
$created_by = $this->getUserStateFromRequest($this->context . '.filter.created_by', 'filter_created_by', '');
$this->setState('filter.created_by', $created_by);
$created = $this->getUserStateFromRequest($this->context . '.filter.created', 'filter_created');
$this->setState('filter.created', $created);
$sorting = $this->getUserStateFromRequest($this->context . '.filter.sorting', 'filter_sorting', 0, 'int');
$this->setState('filter.sorting', $sorting);
$search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
$this->setState('filter.search', $search);
$currency = $this->getUserStateFromRequest($this->context . '.filter.currency', 'filter_currency');
$this->setState('filter.currency', $currency);
2015-12-01 05:06:34 +00:00
$name = $this->getUserStateFromRequest($this->context . '.filter.name', 'filter_name');
$this->setState('filter.name', $name);
$user = $this->getUserStateFromRequest($this->context . '.filter.user', 'filter_user');
$this->setState('filter.user', $user);
$codethree = $this->getUserStateFromRequest($this->context . '.filter.codethree', 'filter_codethree');
$this->setState('filter.codethree', $codethree);
$codetwo = $this->getUserStateFromRequest($this->context . '.filter.codetwo', 'filter_codetwo');
$this->setState('filter.codetwo', $codetwo);
$working_days = $this->getUserStateFromRequest($this->context . '.filter.working_days', 'filter_working_days');
2022-03-03 02:58:38 +00:00
$this->setState('filter.working_days', $working_days);
// List state information.
parent::populateState($ordering, $direction);
}
/**
* Method to get an array of data items.
*
* @return mixed An array of data items on success, false on failure.
*/
public function getItems()
2019-04-04 11:51:37 +00:00
{
2022-03-03 02:58:38 +00:00
// Check in items
2015-12-01 05:06:34 +00:00
$this->checkInNow();
2022-03-03 02:58:38 +00:00
// load parent items
2015-12-01 05:06:34 +00:00
$items = parent::getItems();
2020-05-30 22:55:13 +00:00
// Set values to display correctly.
2015-12-01 05:06:34 +00:00
if (CostbenefitprojectionHelper::checkArray($items))
{
2020-05-30 22:55:13 +00:00
// Get the user object if not set.
if (!isset($user) || !CostbenefitprojectionHelper::checkObject($user))
{
$user = JFactory::getUser();
}
2015-12-01 05:06:34 +00:00
foreach ($items as $nr => &$item)
{
2020-05-30 22:55:13 +00:00
// Remove items the user can't access.
$access = ($user->authorise('country.access', 'com_costbenefitprojection.country.' . (int) $item->id) && $user->authorise('country.access', 'com_costbenefitprojection'));
2015-12-01 05:06:34 +00:00
if (!$access)
{
unset($items[$nr]);
continue;
}
}
2022-03-03 02:58:38 +00:00
}
// return items
return $items;
}
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Get the user object.
2015-12-01 05:06:34 +00:00
$user = JFactory::getUser();
// Create a new query object.
2015-12-01 05:06:34 +00:00
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields
2015-12-01 05:06:34 +00:00
$query->select('a.*');
// From the costbenefitprojection_item table
2015-12-01 05:06:34 +00:00
$query->from($db->quoteName('#__costbenefitprojection_country', 'a'));
// Filter the countries (admin sees all)
if (!$user->authorise('core.options', 'com_costbenefitprojection'))
{
$is = CostbenefitprojectionHelper::userIs($user->id);
if (3 == $is)
{
// only load this users countries
$query->where('a.user = '. (int) $user->id);
}
else
{
// don't allow user to see any countries
$query->where('a.id = -4');
}
}
// From the users table.
2015-12-01 05:06:34 +00:00
$query->select($db->quoteName('g.name','user_name'));
$query->join('LEFT', $db->quoteName('#__users', 'g') . ' ON (' . $db->quoteName('a.user') . ' = ' . $db->quoteName('g.id') . ')');
// From the costbenefitprojection_currency table.
2022-05-27 05:41:44 +00:00
$query->select($db->quoteName(['h.name','h.id'],['currency_name','currency_id']));
2015-12-01 05:06:34 +00:00
$query->join('LEFT', $db->quoteName('#__costbenefitprojection_currency', 'h') . ' ON (' . $db->quoteName('a.currency') . ' = ' . $db->quoteName('h.codethree') . ')');
// Filter by published state
2015-12-01 05:06:34 +00:00
$published = $this->getState('filter.published');
if (is_numeric($published))
{
$query->where('a.published = ' . (int) $published);
}
elseif ($published === '')
{
$query->where('(a.published = 0 OR a.published = 1)');
}
// Join over the asset groups.
2015-12-01 05:06:34 +00:00
$query->select('ag.title AS access_level');
$query->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
// Filter by access level.
2021-01-06 13:46:53 +00:00
$_access = $this->getState('filter.access');
if ($_access && is_numeric($_access))
{
$query->where('a.access = ' . (int) $_access);
}
elseif (CostbenefitprojectionHelper::checkArray($_access))
2015-12-01 05:06:34 +00:00
{
2021-01-06 13:46:53 +00:00
// Secure the array for the query
$_access = ArrayHelper::toInteger($_access);
// Filter by the Access Array.
$query->where('a.access IN (' . implode(',', $_access) . ')');
2015-12-01 05:06:34 +00:00
}
// Implement View Level Access
2015-12-01 05:06:34 +00:00
if (!$user->authorise('core.options', 'com_costbenefitprojection'))
{
$groups = implode(',', $user->getAuthorisedViewLevels());
$query->where('a.access IN (' . $groups . ')');
}
// Filter by search.
2015-12-01 05:06:34 +00:00
$search = $this->getState('filter.search');
if (!empty($search))
{
if (stripos($search, 'id:') === 0)
{
$query->where('a.id = ' . (int) substr($search, 3));
}
else
{
$search = $db->quote('%' . $db->escape($search) . '%');
$query->where('(a.name LIKE '.$search.' OR a.user LIKE '.$search.' OR g.name LIKE '.$search.' OR a.currency LIKE '.$search.' OR h.name LIKE '.$search.' OR a.codethree LIKE '.$search.' OR a.codetwo LIKE '.$search.' OR a.working_days LIKE '.$search.' OR a.alias LIKE '.$search.' OR a.datayear LIKE '.$search.')');
2015-12-01 05:06:34 +00:00
}
}
2021-01-06 13:46:53 +00:00
// Filter by Currency.
$_currency = $this->getState('filter.currency');
if (is_numeric($_currency))
{
if (is_float($_currency))
{
$query->where('a.currency = ' . (float) $_currency);
}
else
{
$query->where('a.currency = ' . (int) $_currency);
}
}
elseif (CostbenefitprojectionHelper::checkString($_currency))
2015-12-01 05:06:34 +00:00
{
2021-01-06 13:46:53 +00:00
$query->where('a.currency = ' . $db->quote($db->escape($_currency)));
2015-12-01 05:06:34 +00:00
}
// Add the list ordering clause.
2015-12-01 05:06:34 +00:00
$orderCol = $this->state->get('list.ordering', 'a.id');
2021-01-06 13:46:53 +00:00
$orderDirn = $this->state->get('list.direction', 'desc');
2015-12-01 05:06:34 +00:00
if ($orderCol != '')
{
$query->order($db->escape($orderCol . ' ' . $orderDirn));
}
2022-03-03 02:58:38 +00:00
return $query;
2015-12-01 05:06:34 +00:00
}
/**
2019-04-04 11:51:37 +00:00
* Method to get list export data.
*
2020-05-30 22:55:13 +00:00
* @param array $pks The ids of the items to get
* @param JUser $user The user making the request
*
2019-04-04 11:51:37 +00:00
* @return mixed An array of data items on success, false on failure.
*/
2020-05-30 22:55:13 +00:00
public function getExportData($pks, $user = null)
2015-12-01 05:06:34 +00:00
{
// setup the query
2021-01-06 13:46:53 +00:00
if (($pks_size = CostbenefitprojectionHelper::checkArray($pks)) !== false || 'bulk' === $pks)
2015-12-01 05:06:34 +00:00
{
2020-05-30 22:55:13 +00:00
// Set a value to know this is export method. (USE IN CUSTOM CODE TO ALTER OUTCOME)
$_export = true;
2020-05-30 22:55:13 +00:00
// Get the user object if not set.
if (!isset($user) || !CostbenefitprojectionHelper::checkObject($user))
{
$user = JFactory::getUser();
}
// Create a new query object.
2015-12-01 05:06:34 +00:00
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields
2015-12-01 05:06:34 +00:00
$query->select('a.*');
// From the costbenefitprojection_country table
2015-12-01 05:06:34 +00:00
$query->from($db->quoteName('#__costbenefitprojection_country', 'a'));
2021-01-06 13:46:53 +00:00
// The bulk export path
if ('bulk' === $pks)
{
$query->where('a.id > 0');
}
// A large array of ID's will not work out well
elseif ($pks_size > 500)
{
// Use lowest ID
$query->where('a.id >= ' . (int) min($pks));
// Use highest ID
$query->where('a.id <= ' . (int) max($pks));
}
// The normal default path
else
{
$query->where('a.id IN (' . implode(',',$pks) . ')');
}
2015-12-01 05:06:34 +00:00
// Filter the countries (admin sees all)
if (!$user->authorise('core.options', 'com_costbenefitprojection'))
{
$is = CostbenefitprojectionHelper::userIs($user->id);
if (3 == $is)
{
// only load this users countries
$query->where('a.user = '. (int) $user->id);
}
else
{
// don't allow user to see any countries
$query->where('a.id = -4');
}
}
// Implement View Level Access
2015-12-01 05:06:34 +00:00
if (!$user->authorise('core.options', 'com_costbenefitprojection'))
{
$groups = implode(',', $user->getAuthorisedViewLevels());
$query->where('a.access IN (' . $groups . ')');
}
// Order the results by ordering
2015-12-01 05:06:34 +00:00
$query->order('a.ordering ASC');
// Load the items
2015-12-01 05:06:34 +00:00
$db->setQuery($query);
$db->execute();
if ($db->getNumRows())
{
$items = $db->loadObjectList();
2020-05-30 22:55:13 +00:00
// Set values to display correctly.
2015-12-01 05:06:34 +00:00
if (CostbenefitprojectionHelper::checkArray($items))
{
foreach ($items as $nr => &$item)
{
2020-05-30 22:55:13 +00:00
// Remove items the user can't access.
$access = ($user->authorise('country.access', 'com_costbenefitprojection.country.' . (int) $item->id) && $user->authorise('country.access', 'com_costbenefitprojection'));
2015-12-01 05:06:34 +00:00
if (!$access)
{
unset($items[$nr]);
continue;
}
// unset the values we don't want exported.
2015-12-01 05:06:34 +00:00
unset($item->asset_id);
unset($item->checked_out);
unset($item->checked_out_time);
}
}
// Add headers to items array.
2015-12-01 05:06:34 +00:00
$headers = $this->getExImPortHeaders();
if (CostbenefitprojectionHelper::checkObject($headers))
{
array_unshift($items,$headers);
}
return $items;
}
}
return false;
}
/**
* Method to get header.
*
* @return mixed An array of data items on success, false on failure.
*/
public function getExImPortHeaders()
{
// Get a db connection.
2015-12-01 05:06:34 +00:00
$db = JFactory::getDbo();
// get the columns
2015-12-01 05:06:34 +00:00
$columns = $db->getTableColumns("#__costbenefitprojection_country");
if (CostbenefitprojectionHelper::checkArray($columns))
{
// remove the headers you don't import/export.
2015-12-01 05:06:34 +00:00
unset($columns['asset_id']);
unset($columns['checked_out']);
unset($columns['checked_out_time']);
$headers = new stdClass();
foreach ($columns as $column => $type)
{
$headers->{$column} = $column;
}
return $headers;
}
return false;
2022-03-03 02:58:38 +00:00
}
/**
* Method to get a store id based on model configuration state.
*
* @return string A store id.
*
*/
protected function getStoreId($id = '')
{
// Compile the store id.
2015-12-01 05:06:34 +00:00
$id .= ':' . $this->getState('filter.id');
$id .= ':' . $this->getState('filter.search');
$id .= ':' . $this->getState('filter.published');
2021-01-06 13:46:53 +00:00
$id .= ':' . $this->getState('filter.access');
2015-12-01 05:06:34 +00:00
$id .= ':' . $this->getState('filter.ordering');
$id .= ':' . $this->getState('filter.created_by');
$id .= ':' . $this->getState('filter.modified_by');
2021-01-06 13:46:53 +00:00
$id .= ':' . $this->getState('filter.currency');
2015-12-01 05:06:34 +00:00
$id .= ':' . $this->getState('filter.name');
$id .= ':' . $this->getState('filter.user');
$id .= ':' . $this->getState('filter.codethree');
$id .= ':' . $this->getState('filter.codetwo');
2022-03-03 02:58:38 +00:00
$id .= ':' . $this->getState('filter.working_days');
return parent::getStoreId($id);
2015-12-01 05:06:34 +00:00
}
/**
2019-04-04 11:51:37 +00:00
* Build an SQL query to checkin all items left checked out longer then a set time.
*
* @return a bool
*
*/
protected function checkInNow()
2015-12-01 05:06:34 +00:00
{
// Get set check in time
2015-12-01 05:06:34 +00:00
$time = JComponentHelper::getParams('com_costbenefitprojection')->get('check_in');
2019-04-04 11:51:37 +00:00
2015-12-01 05:06:34 +00:00
if ($time)
{
// Get a db connection.
2015-12-01 05:06:34 +00:00
$db = JFactory::getDbo();
2022-03-03 02:58:38 +00:00
// Reset query.
2015-12-01 05:06:34 +00:00
$query = $db->getQuery(true);
$query->select('*');
$query->from($db->quoteName('#__costbenefitprojection_country'));
2022-03-03 02:58:38 +00:00
// Only select items that are checked out.
$query->where($db->quoteName('checked_out') . '!=0');
$db->setQuery($query, 0, 1);
2015-12-01 05:06:34 +00:00
$db->execute();
if ($db->getNumRows())
{
2022-03-03 02:58:38 +00:00
// Get Yesterdays date.
2015-12-01 05:06:34 +00:00
$date = JFactory::getDate()->modify($time)->toSql();
2022-03-03 02:58:38 +00:00
// Reset query.
2015-12-01 05:06:34 +00:00
$query = $db->getQuery(true);
// Fields to update.
2015-12-01 05:06:34 +00:00
$fields = array(
$db->quoteName('checked_out_time') . '=\'0000-00-00 00:00:00\'',
$db->quoteName('checked_out') . '=0'
);
// Conditions for which records should be updated.
2015-12-01 05:06:34 +00:00
$conditions = array(
$db->quoteName('checked_out') . '!=0',
$db->quoteName('checked_out_time') . '<\''.$date.'\''
);
2022-03-03 02:58:38 +00:00
// Check table.
2015-12-01 05:06:34 +00:00
$query->update($db->quoteName('#__costbenefitprojection_country'))->set($fields)->where($conditions);
$db->setQuery($query);
$db->execute();
}
}
return false;
2022-03-03 02:58:38 +00:00
}
}