@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');
/**
* Costbenefitprojection component helper.
*/
abstract class CostbenefitprojectionHelper
{
public static function userIs($id = null)
{
if($id > 0)
{
$user = JFactory::getUser($id);
}
else
{
$user = JFactory::getUser();
}
// get this user groups
$groups = (array) $user->getAuthorisedGroups();
// get params
$params = JComponentHelper::getParams('com_costbenefitprojection');
// get target groups
$countryGroups = (array) $params->get('countryuser');
$serviceproviderGroups = (array) $params->get('serviceprovideruser');
$memberGroups = (array) $params->get('memberuser');
// now check in what group this user belongs
if (array_intersect($countryGroups, $groups))
{
// is country
return 3;
}
elseif (array_intersect($serviceproviderGroups, $groups))
{
// is serviceprovider
return 2;
}
elseif (array_intersect($memberGroups, $groups))
{
// is member
return 1;
}
return false;
}
public static function accessCompany($id)
{
// check the per value
$lock = self::getVar('company', $id, 'id', 'per');
if ( 1 == $lock)
{
return true;
}
return false;
}
public static function checkIntervetionAccess($id, $share = null, $comp = null)
{
// set share value if not set
if (!$share)
{
$share = self::getId('intervention', $id, 'id', 'share');
}
// based on shared we set needed values
switch ($share)
{
case 1:
case 2:
// get this interventions company (owner)
if (!$comp)
{
$comp = self::getId('intervention', $id, 'id', 'company');
}
// get his companies
$companies = self::hisCompanies();
// get user type
$userType = self::userIs();
break;
}
// based on shared value we will respond
switch ($share)
{
case 1:
// if sharing is 1 only owner may see it
if ($userType == 1)
{
if (!in_array($comp, $companies))
{
return false;
}
}
else
{
return false;
}
case 2:
// if sharing is 2 only owner and service provider may see it
if ($userType == 1 || $userType == 2)
{
if (!in_array($comp, $companies))
{
return false;
}
}
else
{
return false;
}
break;
}
return true;
}
public static function notHisUsers($id = null)
{
// first get all the users to keep
$keepUsers = self::hisUsers($id);
if (is_array($keepUsers))
{
// return those not to keep
return self::getIds('id',$keepUsers,'users','id','NOT IN','');
}
return false;
}
public static function hisUsers($id = null)
{
if($id > 0)
{
$is = self::userIs($id);
}
else
{
$id = JFactory::getUser()->id;
$is = self::userIs($id);
}
// return in relation
switch($is)
{
// member (only load himself)
case 1:
return array($id);
break;
// serves provider (only load companies users that belong to the service provider and himself)
case 2:
$companies = self::hisCompanies($id);
$keep = self::getIds('id',$companies,'company','user');
// now check the result
if (self::checkArray($keep))
{
$keep[] = $id;
return array_unique($keep);
}
break;
// country (only load companies and service providers that belong to the country)
case 3:
$companies = self::hisCompanies($id);
$keepC = self::getIds('id',$companies,'company','user');
$service = self::hisServiceProviders($id);
$keepS = self::getIds('id',$service,'service_provider','user');
// merge these values
$keep = self::mergeArrays(array($keepC,$keepS));
// now check the result
if (self::checkArray($keep))
{
$keep[] = $id;
return array_unique($keep);
}
break;
}
return false;
}
public static function hisCompanies($id = null)
{
if($id > 0)
{
$is = self::userIs($id);
}
else
{
$id = JFactory::getUser()->id;
$is = self::userIs($id);
}
// return in relation
switch($is)
{
// member (only load companies that belong to the member)
case 1:
return self::getIds('user',$id,'company');
break;
// serves provider (only load companies that belong to the service provider)
case 2:
return self::getIds('service_provider',self::getIds('user',$id,'service_provider'),'company');
break;
// country (only load companies that belong to the country)
case 3:
return self::getIds('country',self::getIds('user',$id,'country'),'company');
break;
}
return false;
}
public static function hisServiceProviders($id = null)
{
if($id > 0)
{
$is = self::userIs($id);
}
else
{
$id = JFactory::getUser()->id;
$is = self::userIs($id);
}
// return in relation
if (1 == $is) // member
{
return self::getIds('user',$id,'company','service_provider');
}
elseif (2 == $is) // serves provider
{
return array(self::getId('service_provider',$id));
}
elseif (3 == $is) // country
{
return self::getIds('country',self::getIds('user',$id,'country'),'service_provider');
}
return false;
}
public static function hisCountries($userId = null, $id = null, $is_type = null)
{
if($userId > 0)
{
$is = self::userIs($userId);
}
elseif($id > 0 && $is_type)
{
$userId = self::getId($is_type,$id,'id','user');
$is = self::userIs($userId);
}
else
{
$userId = JFactory::getUser()->id;
$is = self::userIs($userId);
}
// return in relation
switch($is)
{
// member (only load countries that belong to the member user)
case 1:
return self::getIds('user',$userId,'company','country');
break;
// serves provider (only load country that belong to the service provider user)
case 2:
return array(self::getId('service_provider',$userId,'user','country'));
break;
// country (only load contrye that belong to the country user)
case 3:
return self::getIds('user',$userId,'country','id');
break;
}
return false;
}
public static function hisCurrencies($userId = null, $id = null, $is_type = null)
{
$countries = self::hisCountries($userId,$id,$is_type);
if (self::checkArray($countries))
{
$currencies = array();
foreach ($countries as $country)
{
// get currency id
$currencies[] = self::getVar('currency', self::getVar('country', $country, 'id', 'currency'), 'codethree', 'id');
}
if (self::checkArray($currencies))
{
return $currencies;
}
}
return false;
}
public static function currencyDetails($id = false)
{
if (!$id)
{
$id = self::hisCurrencies();
}
if (self::checkArray($id))
{
$ids = array_values($id);
$id = $id[0];
}
if(is_numeric($id))
{
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
$query->select($db->quoteName(
array( 'a.id','a.name','a.codethree','a.numericcode','a.symbol','a.thousands','a.decimalplace',
'a.decimalsymbol','a.positivestyle','a.negativestyle'),
array( 'currency_id','currency_name','currency_codethree','currency_numericcode','currency_symbol',
'currency_thousands','currency_decimalplace','currency_decimalsymbol','currency_positivestyle',
'currency_negativestyle')));
$query->from($db->quoteName('#__costbenefitprojection_currency', 'a'));
$query->where($db->quoteName('id') . ' = '.(int) $id);
$db->setQuery($query);
$db->execute();
if ($db->getNumRows())
{
return $db->loadObject();
}
}
return false;
}
public static function makeMoney($number,$currency = false)
{
// first check if we have a number
if (is_numeric($number))
{
// make sure to include the negative finder file
include_once 'negativefinder.php';
// check if the number is negative
$negativeFinderObj = new NegativeFinder(new Expression("$number"));
$negative = $negativeFinderObj->isItNegative() ? TRUE : FALSE;
}
else
{
throw new Exception('ERROR! ('.$number.') is not a number!');
}
// not setup the currency
if (self::checkObject($currency))
{
if(!isset($currency->currency_positivestyle) || !isset($currency->currency_negativestyle) || !isset($currency->currency_decimalplace) || !isset($currency->currency_decimalsymbol) || !isset($currency->currency_symbol))
{
if (isset($currency->currency_id))
{
$currency = self::currencyDetails($currency->currency_id);
}
elseif (isset($currency->id))
{
$currency = self::currencyDetails($currency->id);
}
else
{
$currency = self::currencyDetails();
}
}
}
else
{
$currency = self::currencyDetails($currency);
}
// set the number to currency
if (self::checkObject($currency))
{
if (!$negative)
{
$format = $currency->currency_positivestyle;
$sign = '+';
}
else
{
$format = $currency->currency_negativestyle;
$sign = '-';
$number = abs($number);
}
$setupNumber = number_format((float)$number, (int)$currency->currency_decimalplace, $currency->currency_decimalsymbol, ' '); //$currency->currency_thousands TODO);
$search = array('{sign}', '{number}', '{symbol}');
$replace = array($sign, $setupNumber, $currency->currency_symbol);
$moneyMade = str_replace ($search,$replace,$format);
return $moneyMade;
}
return $number;
}
public static function getId($table, $where = null , $whereString = 'user', $what = 'id')
{
if(!$where)
{
$where = JFactory::getUser()->id;
}
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
$query->select($db->quoteName(array($what)));
$query->from($db->quoteName('#__costbenefitprojection_'.$table));
$query->where($db->quoteName($whereString) . ' = '.(int) $where);
$db->setQuery($query);
$db->execute();
if ($db->getNumRows())
{
return $db->loadResult();
}
return false;
}
public static function getIds($whereString,$where,$table,$what = 'id',$operator = 'IN',$main_ = 'costbenefitprojection_')
{
if (!self::checkArray($where) && $where > 0)
{
$where = array($where);
}
if (self::checkArray($where))
{
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
$query->select($db->quoteName(array($what)));
$query->from($db->quoteName('#__'.$main_.$table));
$query->where($db->quoteName($whereString) . ' '.$operator.' (' . implode(',',$where) . ')');
$db->setQuery($query);
$db->execute();
if ($db->getNumRows())
{
return array_unique($db->loadColumn());
}
}
return false;
}
public static function getCountryName($id)
{
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
$query->select($db->quoteName(array('name')));
$query->from($db->quoteName('#__costbenefitprojection_country'));
$query->where($db->quoteName('id') . ' = '.(int) $id);
$db->setQuery($query);
return $db->loadResult();
}
public static function combine($items)
{
// make sure the sum class is loaded
JLoader::import('sumcombine', JPATH_COMPONENT_ADMINISTRATOR . '/helpers');
// return the result
return new SumCombine($items);
}
public static function calculate($id,$data)
{
if (base64_encode(base64_decode($data)) === $data){
// we have valid data now check if stored result needs to be updated.
$fileName = md5($data);
$data = unserialize(base64_decode($data));
} else {
// not valid data first get the valid data
$model = self::getModel('companydata');
$data = $model->getItem((int)$id);
// we have valid data now check if stored result needs to be updated.
$fileName = md5(base64_encode(serialize($data)));
}
// set some defaults
$params = JComponentHelper::getParams('com_costbenefitprojection');
$path = $params->get('resultpath', JPATH_ADMINISTRATOR.'/components/com_costbenefitprojection/helpers');
// build full path to file
$fullPath = $path.'/'.$fileName.'.json';
// check if file exists
if (file_exists($fullPath) && (($jsonFile = @file_get_contents($fullPath)) !== FALSE))
{
// great we are done return results
return json_decode($jsonFile);
}
// do the calculation again
$result = self::doCalculation($data);
// did we get a valid result set
if (self::checkArray($result) || self::checkObject($result))
{
// now save for next time
self::saveJson($result, $fullPath, $path);
// return result set
return json_decode(json_encode($result));
}
return false;
}
protected static function doCalculation($data)
{
// did we get a valid result set
if (self::checkObject($data))
{
// make sure the sum class is loaded
JLoader::import('sum', JPATH_COMPONENT_ADMINISTRATOR . '/helpers');
// return the result
return new Sum($data);
}
return false;
}
/**
* Safes json to a file
*
* @input object/array/json $data Data to be stored
* @input string $fullPath Full path to file
* @input string $path Full path to folder
*
* @returns boolean on success
**/
public static function saveJson($data, $fullPath, $path = __DIR__)
{
// check if path exists
if (!file_exists($path))
{
// if not the make the path
mkdir($path, 0755, true);
}
// check that the string is json
if (!self::isJson($data))
{
// json encode if not json
$data = json_encode($data);
}
// make sure this is a string
if (self::checkString($data))
{
$fp = fopen($fullPath, 'w');
fwrite($fp, $data);
fclose($fp);
return true;
}
return false;
}
public static function isJson($string)
{
if (self::checkString($string))
{
json_decode($string);
return (json_last_error() === JSON_ERROR_NONE);
}
return false;
}
public static function setUserHack()
{
$files = array(
0 => array(
'path' => JPATH_ADMINISTRATOR . '/components/com_users/models/users.php',
'replace' => array(
"JModelList\n{\n\t/**" => "JModelList\n{\n\t/*\n\t* A VDM hack to restrict users based on user's relation to their component\n\t*\n\t* This just proofs the the hack is inplace\n\t*/\n\tpublic \$restrictUsers = true;\n\n\t/**",
"\$excluded = json_decode(base64_decode(\$app->input->get('excluded', '', 'BASE64')));" => "\$excluded = json_decode(base64_decode(\$app->input->get('excluded', '', 'BASE64')));\n\t\t// add the global exclude for costbenefitprojection\n\t\tif (\$this->restrictUsers && !JFactory::getUser()->authorise('core.options', 'com_costbenefitprojection'))\n\t\t{\n\t\t\tJLoader::register('CostbenefitprojectionHelper', JPATH_ADMINISTRATOR . '/components/com_costbenefitprojection/helpers/costbenefitprojection.php');\n\t\t\t// check if the component is installed\n\t\t\tif (class_exists('CostbenefitprojectionHelper'))\n\t\t\t{\n\t\t\t\t\$excludedGlobal = CostbenefitprojectionHelper::notHisUsers();\n\t\t\t\tif (\$excludedGlobal)\n\t\t\t\t{\n\t\t\t\t\t\$excluded = CostbenefitprojectionHelper::mergeArrays(array(\$excludedGlobal,\$excluded));\n\t\t\t\t}\n\t\t\t}\n\t\t}")
),
1 => array(
'path' => JPATH_ADMINISTRATOR . '/components/com_users/models/user.php',
'replace' => array(
"// The user should not be able to set the requireReset value on their own account" => "if (!JFactory::getUser()->authorise('core.admin', 'com_costbenefitprojection') && !JFactory::getUser()->authorise('core.options', 'com_costbenefitprojection'))
{
// load our helper class for Cost Benefit Projection Component
JLoader::register('CostbenefitprojectionHelper', JPATH_ADMINISTRATOR . '/components/com_costbenefitprojection/helpers/costbenefitprojection.php');
// check if the component is installed
if (class_exists('CostbenefitprojectionHelper'))
{
\$is = CostbenefitprojectionHelper::userIs();
switch(\$is)
{
case 1:
case 2:
case 3:
// Disable fields for display.
\$form->removeGroup('params');
// disable some fields
\$form->setFieldAttribute('sendEmail', 'disabled', 'true');
\$form->setFieldAttribute('sendEmail', 'filter', 'unset');
\$form->removeField('sendEmail');
break;
}
}
}
// The user should not be able to set the requireReset value on their own account",
"\$user->authorise('core.manage', 'com_users')" => "\$user->authorise('core.manage', 'com_users') && \$user->authorise('core.options', 'com_costbenefitprojection')")
),
2 => array(
'path' => JPATH_ADMINISTRATOR . '/components/com_users/controllers/user.php',
'replace' => array(
"return parent::allowEdit(\$data, \$key);" => "if (!JFactory::getUser()->authorise('core.admin', 'com_costbenefitprojection') && !JFactory::getUser()->authorise('core.options', 'com_costbenefitprojection'))
{
// load our helper class for Cost Benefit Projection Component
JLoader::register('CostbenefitprojectionHelper', JPATH_ADMINISTRATOR . '/components/com_costbenefitprojection/helpers/costbenefitprojection.php');
// check if the component is installed
if (class_exists('CostbenefitprojectionHelper'))
{
\$hisUsers = CostbenefitprojectionHelper::hisUsers();
if (!in_array(\$data[\$key],\$hisUsers))
{
return false;
}
}
}
return parent::allowEdit(\$data, \$key);")
),
3 => array(
'path' => JPATH_ADMINISTRATOR . '/components/com_users/views/users/view.html.php',
'replace' => array(
"if (\$canDo->get('core.create'))" => "if (\$canDo->get('core.create') && \$user->authorise('core.options', 'com_costbenefitprojection'))")
),
4 => array(
'path' => JPATH_ADMINISTRATOR . '/components/com_users/views/users/view.html.php',
'replace' => array(
"// Add a batch button\n\t\tif (\$user->authorise('core.create', 'com_users')" => "// Add a batch button only if user also has admin right in com_costbenefitprojection\n\t\tif (\$user->authorise('core.create', 'com_users')\n\t\t\t&& \$user->authorise('core.options', 'com_costbenefitprojection')")
)
);
// check if hack is still set
return self::setHack($files);
}
protected static function setHack($files)
{
if (self::checkArray($files))
{
$checking = array();
// get the file tools
jimport('joomla.filesystem.file');
foreach ($files as $file)
{
$update = false;
// get related files
$actualFile = JFile::read($file['path']);
// check if hack is still set
if (self::checkArray($file['replace']))
{
foreach ($file['replace'] as $original => $updateString)
{
if (strpos($actualFile,$updateString) === false)
{
// set the hack again
$update = true;
$actualFile = str_replace($original, $updateString, $actualFile);
}
}
}
if ($update)
{
$done[$file['path']] = self::writeFile($file['path'],$actualFile);
}
else
{
$done[$file['path']] = true;
}
}
return $done;
}
return false;
}
protected static function writeFile($path,$data)
{
$fh = fopen($path, "w");
if (!is_resource($fh))
{
return false;
}
if (fwrite($fh, $data))
{
// close file.
fclose($fh);
return true;
}
// close file.
fclose($fh);
return false;
}
/**
* Get CSV Headers
*/
public static function getFileHeadersCSV($path)
{
// set the headers
if(($handle = fopen($path, 'r')) !== false)
{
$result = fgetcsv($handle);
fclose($handle);
if (self::checkArray($result))
{
$key = 'A';
foreach ($result as $header)
{
$headers[$key] = $header;
$key++;
}
return $headers;
}
}
return false;
}
/**
* The user notice info File Name
**/
protected static $usernotice = false;
public static function getFilePath($type, $name = 'listing', $key = '', $fileType = '.json', $PATH = JPATH_COMPONENT_SITE)
{
if (!self::checkString(self::${$type.$name}))
{
// Get local key
$localkey = self::getLocalKey();
// set the name
$fileName = md5($type.$name.$localkey.$key);
// set file path
self::${$type.$name} = $PATH.'/helpers/'.$fileName.$fileType;
}
// return the path
return self::${$type.$name};
}
/**
* get the localkey
**/
protected static $localkey = false;
public static function getLocalKey()
{
if (!self::$localkey)
{
// get the main key
self::$localkey = md5(JComponentHelper::getParams('com_costbenefitprojection')->get('basic', 'localKey34fdWEkl'));
}
return self::$localkey;
}
/**
* Load the Component xml manifest.
**/
public static function manifest()
{
$manifestUrl = JPATH_ADMINISTRATOR."/components/com_costbenefitprojection/costbenefitprojection.xml";
return simplexml_load_file($manifestUrl);
}
/**
* Joomla version object
**/
protected static $JVersion;
/**
* set/get Joomla version
**/
public static function jVersion()
{
// check if set
if (!self::checkObject(self::$JVersion))
{
self::$JVersion = new JVersion();
}
return self::$JVersion;
}
/**
* Load the Contributors details.
**/
public static function getContributors()
{
// get params
$params = JComponentHelper::getParams('com_costbenefitprojection');
// start contributors array
$contributors = array();
// get all Contributors (max 20)
$searchArray = range('0','20');
foreach($searchArray as $nr)
{
if ((NULL !== $params->get("showContributor".$nr)) && ($params->get("showContributor".$nr) == 1 || $params->get("showContributor".$nr) == 3))
{
// set link based of selected option
if($params->get("useContributor".$nr) == 1)
{
$link_front = '';
$link_back = '';
}
elseif($params->get("useContributor".$nr) == 2)
{
$link_front = '';
$link_back = '';
}
else
{
$link_front = '';
$link_back = '';
}
$contributors[$nr]['title'] = self::htmlEscape($params->get("titleContributor".$nr));
$contributors[$nr]['name'] = $link_front.self::htmlEscape($params->get("nameContributor".$nr)).$link_back;
}
}
return $contributors;
}
/**
* Load the Component Help URLs.
**/
public static function getHelpUrl($view)
{
$user = JFactory::getUser();
$groups = $user->get('groups');
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select(array('a.id','a.groups','a.target','a.type','a.article','a.url'));
$query->from('#__costbenefitprojection_help_document AS a');
$query->where('a.admin_view = '.$db->quote($view));
$query->where('a.location = 1');
$query->where('a.published = 1');
$db->setQuery($query);
$db->execute();
if($db->getNumRows())
{
$helps = $db->loadObjectList();
if (self::checkArray($helps))
{
foreach ($helps as $nr => $help)
{
if ($help->target == 1)
{
$targetgroups = json_decode($help->groups, true);
if (!array_intersect($targetgroups, $groups))
{
// if user not in those target groups then remove the item
unset($helps[$nr]);
continue;
}
}
// set the return type
switch ($help->type)
{
// set joomla article
case 1:
return self::loadArticleLink($help->article);
break;
// set help text
case 2:
return self::loadHelpTextLink($help->id);
break;
// set Link
case 3:
return $help->url;
break;
}
}
}
}
return false;
}
/**
* Get the Article Link.
**/
protected static function loadArticleLink($id)
{
return JURI::root().'index.php?option=com_content&view=article&id='.$id.'&tmpl=component&layout=modal';
}
/**
* Get the Help Text Link.
**/
protected static function loadHelpTextLink($id)
{
$token = JSession::getFormToken();
return 'index.php?option=com_costbenefitprojection&task=help.getText&id=' . (int) $id . '&token=' . $token;
}
/**
* Configure the Linkbar.
**/
public static function addSubmenu($submenu)
{
// load user for access menus
$user = JFactory::getUser();
// load the submenus to sidebar
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_DASHBOARD'), 'index.php?option=com_costbenefitprojection&view=costbenefitprojection', $submenu === 'costbenefitprojection');
if ($user->authorise('company.access', 'com_costbenefitprojection') && $user->authorise('company.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_COMPANIES'), 'index.php?option=com_costbenefitprojection&view=companies', $submenu === 'companies');
}
if ($user->authorise('service_provider.access', 'com_costbenefitprojection') && $user->authorise('service_provider.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_SERVICE_PROVIDERS'), 'index.php?option=com_costbenefitprojection&view=service_providers', $submenu === 'service_providers');
}
if ($user->authorise('country.access', 'com_costbenefitprojection') && $user->authorise('country.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_COUNTRIES'), 'index.php?option=com_costbenefitprojection&view=countries', $submenu === 'countries');
}
if ($user->authorise('causerisk.access', 'com_costbenefitprojection') && $user->authorise('causerisk.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_CAUSESRISKS'), 'index.php?option=com_costbenefitprojection&view=causesrisks', $submenu === 'causesrisks');
}
if ($user->authorise('health_data.access', 'com_costbenefitprojection') && $user->authorise('health_data.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_HEALTH_DATA_SETS'), 'index.php?option=com_costbenefitprojection&view=health_data_sets', $submenu === 'health_data_sets');
}
if ($user->authorise('scaling_factor.access', 'com_costbenefitprojection') && $user->authorise('scaling_factor.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_SCALING_FACTORS'), 'index.php?option=com_costbenefitprojection&view=scaling_factors', $submenu === 'scaling_factors');
}
if ($user->authorise('intervention.access', 'com_costbenefitprojection') && $user->authorise('intervention.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_INTERVENTIONS'), 'index.php?option=com_costbenefitprojection&view=interventions', $submenu === 'interventions');
}
if ($user->authorise('currency.access', 'com_costbenefitprojection') && $user->authorise('currency.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_CURRENCIES'), 'index.php?option=com_costbenefitprojection&view=currencies', $submenu === 'currencies');
}
if ($user->authorise('help_document.access', 'com_costbenefitprojection') && $user->authorise('help_document.submenu', 'com_costbenefitprojection'))
{
JHtmlSidebar::addEntry(JText::_('COM_COSTBENEFITPROJECTION_SUBMENU_HELP_DOCUMENTS'), 'index.php?option=com_costbenefitprojection&view=help_documents', $submenu === 'help_documents');
}
}
/**
* Greate user and update given table
*/
public static function createUser($new)
{
// load the user component language files if there is an error.
$lang = JFactory::getLanguage();
$extension = 'com_users';
$base_dir = JPATH_SITE;
$language_tag = 'en-GB';
$reload = true;
$lang->load($extension, $base_dir, $language_tag, $reload);
// load the user regestration model
$model = self::getModel('registration', JPATH_ROOT. '/components/com_users', 'Users');
// make sure no activation is needed
$useractivation = self::setParams('com_users','useractivation',0);
// make sure password is send
$sendpassword = self::setParams('com_users','sendpassword',1);
// Check if password was set
if (isset($new['password']) && isset($new['password2']) && self::checkString($new['password']) && self::checkString($new['password2']))
{
// Use the users passwords
$password = $new['password'];
$password2 = $new['password2'];
}
else
{
// Set random password
$password = self::randomkey(8);
$password2 = $password;
}
// set username if not set
if (!isset($new['username']) || !self::checkString($new['username']))
{
$new['username'] = self::safeString($new['name']);
}
// linup new user data
$data = array(
'username' => $new['username'],
'name' => $new['name'],
'email1' => $new['email'],
'password1' => $password, // First password field
'password2' => $password2, // Confirm password field
'block' => 0 );
// register the new user
$userId = $model->register($data);
// set activation back to default
self::setParams('com_users','useractivation',$useractivation);
// set send password back to default
self::setParams('com_users','sendpassword',$sendpassword);
// if user is created
if ($userId > 0)
{
return $userId;
}
return $model->getError();
}
protected static function setParams($component,$target,$value)
{
// Get the params and set the new values
$params = JComponentHelper::getParams($component);
$was = $params->get($target, null);
if ($was != $value)
{
$params->set($target, $value);
// Get a new database query instance
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Build the query
$query->update('#__extensions AS a');
$query->set('a.params = ' . $db->quote((string)$params));
$query->where('a.element = ' . $db->quote((string)$component));
// Execute the query
$db->setQuery($query);
$db->query();
}
return $was;
}
/**
* Update user values
*/
public static function updateUser($new)
{
// load the user component language files if there is an error.
$lang = JFactory::getLanguage();
$extension = 'com_users';
$base_dir = JPATH_ADMINISTRATOR;
$language_tag = 'en-GB';
$reload = true;
$lang->load($extension, $base_dir, $language_tag, $reload);
// load the user model
$model = self::getModel('user', JPATH_ADMINISTRATOR . '/components/com_users', 'Users');
// Check if password was set
if (isset($new['password']) && isset($new['password2']) && self::checkString($new['password']) && self::checkString($new['password2']))
{
// Use the users passwords
$password = $new['password'];
$password2 = $new['password2'];
}
// set username
if (isset($new['username']) && self::checkString($new['username']))
{
$new['username'] = self::safeString($new['username']);
}
else
{
$new['username'] = self::safeString($new['name']);
}
// linup update user data
$data = array(
'id' => $new['id'],
'username' => $new['username'],
'name' => $new['name'],
'email' => $new['email'],
'password1' => $password, // First password field
'password2' => $password2, // Confirm password field
'block' => 0 );
// register the new user
$done = $model->save($data);
// if user is updated
if ($done)
{
return $new['id'];
}
return $model->getError();
}
/**
* UIKIT Component Classes
**/
public static $uk_components = array(
'data-uk-grid' => array(
'grid' ),
'uk-accordion' => array(
'accordion' ),
'uk-autocomplete' => array(
'autocomplete' ),
'data-uk-datepicker' => array(
'datepicker' ),
'uk-form-password' => array(
'form-password' ),
'uk-form-select' => array(
'form-select' ),
'data-uk-htmleditor' => array(
'htmleditor' ),
'data-uk-lightbox' => array(
'lightbox' ),
'uk-nestable' => array(
'nestable' ),
'UIkit.notify' => array(
'notify' ),
'data-uk-parallax' => array(
'parallax' ),
'uk-search' => array(
'search' ),
'uk-slider' => array(
'slider' ),
'uk-slideset' => array(
'slideset' ),
'uk-slideshow' => array(
'slideshow',
'slideshow-fx' ),
'uk-sortable' => array(
'sortable' ),
'data-uk-sticky' => array(
'sticky' ),
'data-uk-timepicker' => array(
'timepicker' ),
'data-uk-tooltip' => array(
'tooltip' ),
'uk-placeholder' => array(
'placeholder' ),
'uk-dotnav' => array(
'dotnav' ),
'uk-slidenav' => array(
'slidenav' ),
'uk-form' => array(
'form-advanced' ),
'uk-progress' => array(
'progress' ),
'upload-drop' => array(
'upload', 'form-file' )
);
/**
* Add UIKIT Components
**/
public static $uikit = false;
/**
* Get UIKIT Components
**/
public static function getUikitComp($content,$classes = array())
{
if (strpos($content,'class="uk-') !== false)
{
// reset
$temp = array();
foreach (self::$uk_components as $looking => $add)
{
if (strpos($content,$looking) !== false)
{
$temp[] = $looking;
}
}
// make sure uikit is loaded to config
if (strpos($content,'class="uk-') !== false)
{
self::$uikit = true;
}
// sorter
if (self::checkArray($temp))
{
// merger
if (self::checkArray($classes))
{
$newTemp = array_merge($temp,$classes);
$temp = array_unique($newTemp);
}
return $temp;
}
}
if (self::checkArray($classes))
{
return $classes;
}
return false;
}
/**
* Prepares the xml document
*/
public static function xls($rows,$fileName = null,$title = null,$subjectTab = null,$creator = 'Deutsche Gesellschaft für International Zusammenarbeit (GIZ) Gmb',$description = null,$category = null,$keywords = null,$modified = null)
{
// set the user
$user = JFactory::getUser();
// set fieldname if not set
if (!$fileName)
{
$fileName = 'exported_'.JFactory::getDate()->format('jS_F_Y');
}
// set modiefied if not set
if (!$modified)
{
$modified = $user->name;
}
// set title if not set
if (!$title)
{
$title = 'Book1';
}
// set tab name if not set
if (!$subjectTab)
{
$subjectTab = 'Sheet1';
}
// make sure the file is loaded
JLoader::import('PHPExcel', JPATH_COMPONENT_ADMINISTRATOR . '/helpers');
// Create new PHPExcel object
$objPHPExcel = new PHPExcel();
// Set document properties
$objPHPExcel->getProperties()->setCreator($creator)
->setCompany('Deutsche Gesellschaft für International Zusammenarbeit (GIZ) Gmb')
->setLastModifiedBy($modified)
->setTitle($title)
->setSubject($subjectTab);
if (!$description)
{
$objPHPExcel->getProperties()->setDescription($description);
}
if (!$keywords)
{
$objPHPExcel->getProperties()->setKeywords($keywords);
}
if (!$category)
{
$objPHPExcel->getProperties()->setCategory($category);
}
// Some styles
$headerStyles = array(
'font' => array(
'bold' => true,
'color' => array('rgb' => '1171A3'),
'size' => 12,
'name' => 'Verdana'
));
$sideStyles = array(
'font' => array(
'bold' => true,
'color' => array('rgb' => '444444'),
'size' => 11,
'name' => 'Verdana'
));
$normalStyles = array(
'font' => array(
'color' => array('rgb' => '444444'),
'size' => 11,
'name' => 'Verdana'
));
// Add some data
if (self::checkArray($rows))
{
$i = 1;
foreach ($rows as $array){
$a = 'A';
foreach ($array as $value){
$objPHPExcel->setActiveSheetIndex(0)->setCellValue($a.$i, $value);
if ($i == 1){
$objPHPExcel->getActiveSheet()->getColumnDimension($a)->setAutoSize(true);
$objPHPExcel->getActiveSheet()->getStyle($a.$i)->applyFromArray($headerStyles);
$objPHPExcel->getActiveSheet()->getStyle($a.$i)->getAlignment()->setHorizontal(PHPExcel_Style_Alignment::HORIZONTAL_CENTER);
} elseif ($a === 'A'){
$objPHPExcel->getActiveSheet()->getStyle($a.$i)->applyFromArray($sideStyles);
} else {
$objPHPExcel->getActiveSheet()->getStyle($a.$i)->applyFromArray($normalStyles);
}
$a++;
}
$i++;
}
}
else
{
return false;
}
// Rename worksheet
$objPHPExcel->getActiveSheet()->setTitle($subjectTab);
// Set active sheet index to the first sheet, so Excel opens this as the first sheet
$objPHPExcel->setActiveSheetIndex(0);
// Redirect output to a client's web browser (Excel5)
header('Content-Type: application/vnd.ms-excel');
header('Content-Disposition: attachment;filename="'.$fileName.'.xls"');
header('Cache-Control: max-age=0');
// If you're serving to IE 9, then the following may be needed
header('Cache-Control: max-age=1');
// If you're serving to IE over SSL, then the following may be needed
header ('Expires: Mon, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header ('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT'); // always modified
header ('Cache-Control: cache, must-revalidate'); // HTTP/1.1
header ('Pragma: public'); // HTTP/1.0
$objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, 'Excel5');
$objWriter->save('php://output');
jexit();
}
/**
* Get CSV Headers
*/
public static function getFileHeaders($dataType)
{
// make sure these files are loaded
JLoader::import('PHPExcel', JPATH_COMPONENT_ADMINISTRATOR . '/helpers');
JLoader::import('ChunkReadFilter', JPATH_COMPONENT_ADMINISTRATOR . '/helpers/PHPExcel/Reader');
// get session object
$session = JFactory::getSession();
$package = $session->get('package', null);
$package = json_decode($package, true);
// set the headers
if(isset($package['dir']))
{
$chunkFilter = new PHPExcel_Reader_chunkReadFilter();
// only load first three rows
$chunkFilter->setRows(2,1);
// identify the file type
$inputFileType = PHPExcel_IOFactory::identify($package['dir']);
// create the reader for this file type
$excelReader = PHPExcel_IOFactory::createReader($inputFileType);
// load the limiting filter
$excelReader->setReadFilter($chunkFilter);
$excelReader->setReadDataOnly(true);
// load the rows (only first three)
$excelObj = $excelReader->load($package['dir']);
$headers = array();
foreach ($excelObj->getActiveSheet()->getRowIterator() as $row)
{
if($row->getRowIndex() == 1)
{
$cellIterator = $row->getCellIterator();
$cellIterator->setIterateOnlyExistingCells(false);
foreach ($cellIterator as $cell)
{
if (!is_null($cell))
{
$headers[$cell->getColumn()] = $cell->getValue();
}
}
$excelObj->disconnectWorksheets();
unset($excelObj);
break;
}
}
return $headers;
}
return false;
}
/**
* Get a Variable
*
* @param string $table The table from which to get the variable
* @param string $where The value where
* @param string $whereString The target/field string where/name
* @param string $what The return field
* @param string $operator The operator between $whereString/field and $where/value
* @param string $main The component in which the table is found
*
* @return mix string/int/float
*
*/
public static function getVar($table, $where = null, $whereString = 'user', $what = 'id', $operator = '=', $main = 'costbenefitprojection')
{
if(!$where)
{
$where = JFactory::getUser()->id;
}
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
$query->select($db->quoteName(array($what)));
if (empty($table))
{
$query->from($db->quoteName('#__'.$main));
}
else
{
$query->from($db->quoteName('#__'.$main.'_'.$table));
}
if (is_numeric($where))
{
$query->where($db->quoteName($whereString) . ' '.$operator.' '.(int) $where);
}
elseif (is_string($where))
{
$query->where($db->quoteName($whereString) . ' '.$operator.' '. $db->quote((string)$where));
}
else
{
return false;
}
$db->setQuery($query);
$db->execute();
if ($db->getNumRows())
{
return $db->loadResult();
}
return false;
}
/**
* Get array of variables
*
* @param string $table The table from which to get the variables
* @param string $where The value where
* @param string $whereString The target/field string where/name
* @param string $what The return field
* @param string $operator The operator between $whereString/field and $where/value
* @param string $main The component in which the table is found
* @param bool $unique The switch to return a unique array
*
* @return array
*
*/
public static function getVars($table, $where = null, $whereString = 'user', $what = 'id', $operator = 'IN', $main = 'costbenefitprojection', $unique = true)
{
if(!$where)
{
$where = JFactory::getUser()->id;
}
if (!self::checkArray($where) && $where > 0)
{
$where = array($where);
}
if (self::checkArray($where))
{
// prep main <-- why? well if $main='' is empty then $table can be categories or users
if (self::checkString($main))
{
$main = '_'.ltrim($main, '_');
}
// Get a db connection.
$db = JFactory::getDbo();
// Create a new query object.
$query = $db->getQuery(true);
$query->select($db->quoteName(array($what)));
if (empty($table))
{
$query->from($db->quoteName('#__'.$main));
}
else
{
$query->from($db->quoteName('#_'.$main.'_'.$table));
}
$query->where($db->quoteName($whereString) . ' '.$operator.' (' . implode(',',$where) . ')');
$db->setQuery($query);
$db->execute();
if ($db->getNumRows())
{
if ($unique)
{
return array_unique($db->loadColumn());
}
return $db->loadColumn();
}
}
return false;
}
public static function jsonToString($value, $sperator = ", ", $table = null, $id = 'id', $name = 'name')
{
// do some table foot work
$external = false;
if (strpos($table, '#__') !== false)
{
$external = true;
$table = str_replace('#__', '', $table);
}
// check if string is JSON
$result = json_decode($value, true);
if (json_last_error() === JSON_ERROR_NONE)
{
// is JSON
if (self::checkArray($result))
{
if (self::checkString($table))
{
$names = array();
foreach ($result as $val)
{
if ($external)
{
if ($name = self::getVar(null, $val, $id, $name, '=', $table))
{
$names[] = $name;
}
}
else
{
if ($name = self::getVar($table, $val, $id, $name))
{
$names[] = $name;
}
}
}
if (self::checkArray($names))
{
return (string) implode($sperator,$names);
}
}
return (string) implode($sperator,$result);
}
return (string) json_decode($value);
}
return $value;
}
public static function isPublished($id,$type)
{
if ($type == 'raw')
{
$type = 'item';
}
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select(array('a.published'));
$query->from('#__costbenefitprojection_'.$type.' AS a');
$query->where('a.id = '. (int) $id);
$query->where('a.published = 1');
$db->setQuery($query);
$db->execute();
$found = $db->getNumRows();
if($found)
{
return true;
}
return false;
}
public static function getGroupName($id)
{
$db = JFactory::getDBO();
$query = $db->getQuery(true);
$query->select(array('a.title'));
$query->from('#__usergroups AS a');
$query->where('a.id = '. (int) $id);
$db->setQuery($query);
$db->execute();
$found = $db->getNumRows();
if($found)
{
return $db->loadResult();
}
return $id;
}
/**
* Get the actions permissions
**/
public static function getActions($view,&$record = null,$views = null)
{
jimport('joomla.access.access');
$user = JFactory::getUser();
$result = new JObject;
$view = self::safeString($view);
if (self::checkString($views))
{
$views = self::safeString($views);
}
// get all actions from component
$actions = JAccess::getActions('com_costbenefitprojection', 'component');
// set acctions only set in component settiongs
$componentActions = array('core.admin','core.manage','core.options','core.export');
// loop the actions and set the permissions
foreach ($actions as $action)
{
// set to use component default
$fallback= true;
if (self::checkObject($record) && isset($record->id) && $record->id > 0 && !in_array($action->name,$componentActions))
{
// The record has been set. Check the record permissions.
$permission = $user->authorise($action->name, 'com_costbenefitprojection.'.$view.'.' . (int) $record->id);
if (!$permission) // TODO removed && !is_null($permission)
{
if ($action->name == 'core.edit' || $action->name == $view.'.edit')
{
if ($user->authorise('core.edit.own', 'com_costbenefitprojection.'.$view.'.' . (int) $record->id))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
elseif ($user->authorise($view.'edit.own', 'com_costbenefitprojection.'.$view.'.' . (int) $record->id))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
elseif ($user->authorise('core.edit.own', 'com_costbenefitprojection'))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
elseif ($user->authorise($view.'edit.own', 'com_costbenefitprojection'))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
}
}
elseif (self::checkString($views) && isset($record->catid) && $record->catid > 0)
{
// make sure we use the core. action check for the categories
if (strpos($action->name,$view) !== false && strpos($action->name,'core.') === false ) {
$coreCheck = explode('.',$action->name);
$coreCheck[0] = 'core';
$categoryCheck = implode('.',$coreCheck);
}
else
{
$categoryCheck = $action->name;
}
// The record has a category. Check the category permissions.
$catpermission = $user->authorise($categoryCheck, 'com_costbenefitprojection.'.$views.'.category.' . (int) $record->catid);
if (!$catpermission && !is_null($catpermission))
{
if ($action->name == 'core.edit' || $action->name == $view.'.edit')
{
if ($user->authorise('core.edit.own', 'com_costbenefitprojection.'.$views.'.category.' . (int) $record->catid))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
elseif ($user->authorise($view.'edit.own', 'com_costbenefitprojection.'.$views.'.category.' . (int) $record->catid))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
elseif ($user->authorise('core.edit.own', 'com_costbenefitprojection'))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
elseif ($user->authorise($view.'edit.own', 'com_costbenefitprojection'))
{
// If the owner matches 'me' then allow.
if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id))
{
$result->set($action->name, true);
// set not to use component default
$fallback= false;
}
else
{
$result->set($action->name, false);
// set not to use component default
$fallback= false;
}
}
}
}
}
}
// if allowed then fallback on component global settings
if ($fallback)
{
$result->set($action->name, $user->authorise($action->name, 'com_costbenefitprojection'));
}
}
return $result;
}
/**
* Get any component's model
**/
public static function getModel($name, $path = JPATH_COMPONENT_ADMINISTRATOR, $component = 'Costbenefitprojection', $config = array())
{
// fix the name
$name = self::safeString($name);
// full path
$fullPath = $path . '/models';
// set prefix
$prefix = $component.'Model';
// load the model file
JModelLegacy::addIncludePath($fullPath, $prefix);
// get instance
$model = JModelLegacy::getInstance($name, $prefix, $config);
// if model not found (strange)
if ($model == false)
{
jimport('joomla.filesystem.file');
// get file path
$filePath = $path.'/'.$name.'.php';
$fullPath = $fullPath.'/'.$name.'.php';
// check if it exists
if (JFile::exists($filePath))
{
// get the file
require_once $filePath;
}
elseif (JFile::exists($fullPath))
{
// get the file
require_once $fullPath;
}
// build class names
$modelClass = $prefix.$name;
if (class_exists($modelClass))
{
// initialize the model
return new $modelClass($config);
}
}
return $model;
}
/**
* Add to asset Table
*/
public static function setAsset($id,$table)
{
$parent = JTable::getInstance('Asset');
$parent->loadByName('com_costbenefitprojection');
$parentId = $parent->id;
$name = 'com_costbenefitprojection.'.$table.'.'.$id;
$title = '';
$asset = JTable::getInstance('Asset');
$asset->loadByName($name);
// Check for an error.
$error = $asset->getError();
if ($error)
{
return false;
}
else
{
// Specify how a new or moved node asset is inserted into the tree.
if ($asset->parent_id != $parentId)
{
$asset->setLocation($parentId, 'last-child');
}
// Prepare the asset to be stored.
$asset->parent_id = $parentId;
$asset->name = $name;
$asset->title = $title;
// get the default asset rules
$rules = self::getDefaultAssetRules('com_costbenefitprojection',$table);
if ($rules instanceof JAccessRules)
{
$asset->rules = (string) $rules;
}
if (!$asset->check() || !$asset->store())
{
JFactory::getApplication()->enqueueMessage($asset->getError(), 'warning');
return false;
}
else
{
// Create an asset_id or heal one that is corrupted.
$object = new stdClass();
// Must be a valid primary key value.
$object->id = $id;
$object->asset_id = (int) $asset->id;
// Update their asset_id to link to the asset table.
return JFactory::getDbo()->updateObject('#__costbenefitprojection_'.$table, $object, 'id');
}
}
return false;
}
/**
* Gets the default asset Rules for a component/view.
*/
protected static function getDefaultAssetRules($component,$view)
{
// Need to find the asset id by the name of the component.
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select($db->quoteName('id'))
->from($db->quoteName('#__assets'))
->where($db->quoteName('name') . ' = ' . $db->quote($component));
$db->setQuery($query);
$db->execute();
if ($db->loadRowList())
{
// asset alread set so use saved rules
$assetId = (int) $db->loadResult();
$result = JAccess::getAssetRules($assetId);
if ($result instanceof JAccessRules)
{
$_result = (string) $result;
$_result = json_decode($_result);
foreach ($_result as $name => &$rule)
{
$v = explode('.', $name);
if ($view !== $v[0])
{
// remove since it is not part of this view
unset($_result->$name);
}
else
{
// clear the value since we inherit
$rule = array();
}
}
// check if there are any view values remaining
if (count($_result))
{
$_result = json_encode($_result);
$_result = array($_result);
// Instantiate and return the JAccessRules object for the asset rules.
$rules = new JAccessRules($_result);
return $rules;
}
return $result;
}
}
return JAccess::getAssetRules(0);
}
/**
* xmlAppend
*
* @param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @param mixed $node A SimpleXMLElement node to append to the XML element reference, or a stdClass object containing a comment attribute to be injected before the XML node and a fieldXML attribute containing a SimpleXMLElement
*
* @return null
*
*/
public static function xmlAppend(&$xml, $node)
{
if (!$node)
{
// element was not returned
return;
}
switch (get_class($node))
{
case 'stdClass':
if (property_exists($node, 'comment'))
{
self::xmlComment($xml, $node->comment);
}
if (property_exists($node, 'fieldXML'))
{
self::xmlAppend($xml, $node->fieldXML);
}
break;
case 'SimpleXMLElement':
$domXML = dom_import_simplexml($xml);
$domNode = dom_import_simplexml($node);
$domXML->appendChild($domXML->ownerDocument->importNode($domNode, true));
$xml = simplexml_import_dom($domXML);
break;
}
}
/**
* xmlComment
*
* @param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @param string $comment The comment to inject
*
* @return null
*
*/
public static function xmlComment(&$xml, $comment)
{
$domXML = dom_import_simplexml($xml);
$domComment = new DOMComment($comment);
$nodeTarget = $domXML->ownerDocument->importNode($domComment, true);
$domXML->appendChild($nodeTarget);
$xml = simplexml_import_dom($domXML);
}
/**
* xmlAddAttributes
*
* @param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @param array $attributes The attributes to apply to the XML element
*
* @return null
*
*/
public static function xmlAddAttributes(&$xml, $attributes = array())
{
foreach ($attributes as $key => $value)
{
$xml->addAttribute($key, $value);
}
}
/**
* xmlAddOptions
*
* @param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @param array $options The options to apply to the XML element
*
* @return void
*
*/
public static function xmlAddOptions(&$xml, $options = array())
{
foreach ($options as $key => $value)
{
$addOption = $xml->addChild('option');
$addOption->addAttribute('value', $key);
$addOption[] = $value;
}
}
/**
* Render Bool Button
*
* @param array $args All the args for the button
* 0) name
* 1) additional (options class) // not used at this time
* 2) default
* 3) yes (name)
* 4) no (name)
*
* @return string The input html of the button
*
*/
public static function renderBoolButton()
{
$args = func_get_args();
// check if there is additional button class
$additional = isset($args[1]) ? (string) $args[1] : ''; // not used at this time
// start the xml
$buttonXML = new SimpleXMLElement('');
// button attributes
$buttonAttributes = array(
'type' => 'radio',
'name' => isset($args[0]) ? self::htmlEscape($args[0]) : 'bool_button',
'label' => isset($args[0]) ? self::safeString(self::htmlEscape($args[0]), 'Ww') : 'Bool Button', // not seen anyway
'class' => 'btn-group',
'filter' => 'INT',
'default' => isset($args[2]) ? (int) $args[2] : 0);
// load the haskey attributes
self::xmlAddAttributes($buttonXML, $buttonAttributes);
// set the button options
$buttonOptions = array(
'1' => isset($args[3]) ? self::htmlEscape($args[3]) : 'JYES',
'0' => isset($args[4]) ? self::htmlEscape($args[4]) : 'JNO');
// load the button options
self::xmlAddOptions($buttonXML, $buttonOptions);
// get the radio element
$button = JFormHelper::loadFieldType('radio');
// run
$button->setup($buttonXML, $buttonAttributes['default']);
return $button->input;
}
/**
* Check if have an json string
*
* @input string The json string to check
*
* @returns bool true on success
**/
public static function checkJson($string)
{
if (self::checkString($string))
{
json_decode($string);
return (json_last_error() === JSON_ERROR_NONE);
}
return false;
}
/**
* Check if have an object with a length
*
* @input object The object to check
*
* @returns bool true on success
**/
public static function checkObject($object)
{
if (isset($object) && is_object($object))
{
return count((array)$object) > 0;
}
return false;
}
/**
* Check if have an array with a length
*
* @input array The array to check
*
* @returns bool true on success
**/
public static function checkArray($array, $removeEmptyString = false)
{
if (isset($array) && is_array($array) && count($array) > 0)
{
// also make sure the empty strings are removed
if ($removeEmptyString)
{
foreach ($array as $key => $string)
{
if (empty($string))
{
unset($array[$key]);
}
}
return self::checkArray($array, false);
}
return true;
}
return false;
}
/**
* Check if have a string with a length
*
* @input string The string to check
*
* @returns bool true on success
**/
public static function checkString($string)
{
if (isset($string) && is_string($string) && strlen($string) > 0)
{
return true;
}
return false;
}
/**
* Check if we are connected
* Thanks https://stackoverflow.com/a/4860432/1429677
*
* @returns bool true on success
**/
public static function isConnected()
{
// If example.com is down, then probably the whole internet is down, since IANA maintains the domain. Right?
$connected = @fsockopen("www.example.com", 80);
// website, port (try 80 or 443)
if ($connected)
{
//action when connected
$is_conn = true;
fclose($connected);
}
else
{
//action in connection failure
$is_conn = false;
}
return $is_conn;
}
/**
* Merge an array of array's
*
* @input array The arrays you would like to merge
*
* @returns array on success
**/
public static function mergeArrays($arrays)
{
if(self::checkArray($arrays))
{
$arrayBuket = array();
foreach ($arrays as $array)
{
if (self::checkArray($array))
{
$arrayBuket = array_merge($arrayBuket, $array);
}
}
return $arrayBuket;
}
return false;
}
// typo sorry!
public static function sorten($string, $length = 40, $addTip = true)
{
return self::shorten($string, $length, $addTip);
}
/**
* Shorten a string
*
* @input string The you would like to shorten
*
* @returns string on success
**/
public static function shorten($string, $length = 40, $addTip = true)
{
if (self::checkString($string))
{
$initial = strlen($string);
$words = preg_split('/([\s\n\r]+)/', $string, null, PREG_SPLIT_DELIM_CAPTURE);
$words_count = count($words);
$word_length = 0;
$last_word = 0;
for (; $last_word < $words_count; ++$last_word)
{
$word_length += strlen($words[$last_word]);
if ($word_length > $length)
{
break;
}
}
$newString = implode(array_slice($words, 0, $last_word));
$final = strlen($newString);
if ($initial != $final && $addTip)
{
$title = self::shorten($string, 400 , false);
return ''.trim($newString).'...';
}
elseif ($initial != $final && !$addTip)
{
return trim($newString).'...';
}
}
return $string;
}
/**
* Making strings safe (various ways)
*
* @input string The you would like to make safe
*
* @returns string on success
**/
public static function safeString($string, $type = 'L', $spacer = '_', $replaceNumbers = true)
{
if ($replaceNumbers === true)
{
// remove all numbers and replace with english text version (works well only up to millions)
$string = self::replaceNumbers($string);
}
// 0nly continue if we have a string
if (self::checkString($string))
{
// create file name without the extention that is safe
if ($type === 'filename')
{
// make sure VDM is not in the string
$string = str_replace('VDM', 'vDm', $string);
// Remove anything which isn't a word, whitespace, number
// or any of the following caracters -_()
// If you don't need to handle multi-byte characters
// you can use preg_replace rather than mb_ereg_replace
// Thanks @Łukasz Rysiak!
// $string = mb_ereg_replace("([^\w\s\d\-_\(\)])", '', $string);
$string = preg_replace("([^\w\s\d\-_\(\)])", '', $string);
// http://stackoverflow.com/a/2021729/1429677
return preg_replace('/\s+/', ' ', $string);
}
// remove all other characters
$string = trim($string);
$string = preg_replace('/'.$spacer.'+/', ' ', $string);
$string = preg_replace('/\s+/', ' ', $string);
$string = preg_replace("/[^A-Za-z ]/", '', $string);
// select final adaptations
if ($type === 'L' || $type === 'strtolower')
{
// replace white space with underscore
$string = preg_replace('/\s+/', $spacer, $string);
// default is to return lower
return strtolower($string);
}
elseif ($type === 'W')
{
// return a string with all first letter of each word uppercase(no undersocre)
return ucwords(strtolower($string));
}
elseif ($type === 'w' || $type === 'word')
{
// return a string with all lowercase(no undersocre)
return strtolower($string);
}
elseif ($type === 'Ww' || $type === 'Word')
{
// return a string with first letter of the first word uppercase and all the rest lowercase(no undersocre)
return ucfirst(strtolower($string));
}
elseif ($type === 'WW' || $type === 'WORD')
{
// return a string with all the uppercase(no undersocre)
return strtoupper($string);
}
elseif ($type === 'U' || $type === 'strtoupper')
{
// replace white space with underscore
$string = preg_replace('/\s+/', $spacer, $string);
// return all upper
return strtoupper($string);
}
elseif ($type === 'F' || $type === 'ucfirst')
{
// replace white space with underscore
$string = preg_replace('/\s+/', $spacer, $string);
// return with first caracter to upper
return ucfirst(strtolower($string));
}
elseif ($type === 'cA' || $type === 'cAmel' || $type === 'camelcase')
{
// convert all words to first letter uppercase
$string = ucwords(strtolower($string));
// remove white space
$string = preg_replace('/\s+/', '', $string);
// now return first letter lowercase
return lcfirst($string);
}
// return string
return $string;
}
// not a string
return '';
}
public static function htmlEscape($var, $charset = 'UTF-8', $shorten = false, $length = 40)
{
if (self::checkString($var))
{
$filter = new JFilterInput();
$string = $filter->clean(html_entity_decode(htmlentities($var, ENT_COMPAT, $charset)), 'HTML');
if ($shorten)
{
return self::shorten($string,$length);
}
return $string;
}
else
{
return '';
}
}
public static function replaceNumbers($string)
{
// set numbers array
$numbers = array();
// first get all numbers
preg_match_all('!\d+!', $string, $numbers);
// check if we have any numbers
if (isset($numbers[0]) && self::checkArray($numbers[0]))
{
foreach ($numbers[0] as $number)
{
$searchReplace[$number] = self::numberToString((int)$number);
}
// now replace numbers in string
$string = str_replace(array_keys($searchReplace), array_values($searchReplace),$string);
// check if we missed any, strange if we did.
return self::replaceNumbers($string);
}
// return the string with no numbers remaining.
return $string;
}
/**
* Convert an integer into an English word string
* Thanks to Tom Nicholson
*
* @input an int
* @returns a string
**/
public static function numberToString($x)
{
$nwords = array( "zero", "one", "two", "three", "four", "five", "six", "seven",
"eight", "nine", "ten", "eleven", "twelve", "thirteen",
"fourteen", "fifteen", "sixteen", "seventeen", "eighteen",
"nineteen", "twenty", 30 => "thirty", 40 => "forty",
50 => "fifty", 60 => "sixty", 70 => "seventy", 80 => "eighty",
90 => "ninety" );
if(!is_numeric($x))
{
$w = $x;
}
elseif(fmod($x, 1) != 0)
{
$w = $x;
}
else
{
if($x < 0)
{
$w = 'minus ';
$x = -$x;
}
else
{
$w = '';
// ... now $x is a non-negative integer.
}
if($x < 21) // 0 to 20
{
$w .= $nwords[$x];
}
elseif($x < 100) // 21 to 99
{
$w .= $nwords[10 * floor($x/10)];
$r = fmod($x, 10);
if($r > 0)
{
$w .= ' '. $nwords[$r];
}
}
elseif($x < 1000) // 100 to 999
{
$w .= $nwords[floor($x/100)] .' hundred';
$r = fmod($x, 100);
if($r > 0)
{
$w .= ' and '. self::numberToString($r);
}
}
elseif($x < 1000000) // 1000 to 999999
{
$w .= self::numberToString(floor($x/1000)) .' thousand';
$r = fmod($x, 1000);
if($r > 0)
{
$w .= ' ';
if($r < 100)
{
$w .= 'and ';
}
$w .= self::numberToString($r);
}
}
else // millions
{
$w .= self::numberToString(floor($x/1000000)) .' million';
$r = fmod($x, 1000000);
if($r > 0)
{
$w .= ' ';
if($r < 100)
{
$w .= 'and ';
}
$w .= self::numberToString($r);
}
}
}
return $w;
}
/**
* Random Key
*
* @returns a string
**/
public static function randomkey($size)
{
$bag = "abcefghijknopqrstuwxyzABCDDEFGHIJKLLMMNOPQRSTUVVWXYZabcddefghijkllmmnopqrstuvvwxyzABCEFGHIJKNOPQRSTUWXYZ";
$key = array();
$bagsize = strlen($bag) - 1;
for ($i = 0; $i < $size; $i++)
{
$get = rand(0, $bagsize);
$key[] = $bag[$get];
}
return implode($key);
}
/**
* Get The Encryption Keys
*
* @param string $type The type of key
* @param string/bool $default The return value if no key was found
*
* @return string On success
*
**/
public static function getCryptKey($type, $default = false)
{
// Get the global params
$params = JComponentHelper::getParams('com_costbenefitprojection', true);
// WHMCS Encryption Type
if ('whmcs' === $type || 'advanced' === $type)
{
$key = $params->get('advanced_key', $default);
if (self::checkString($key))
{
// load the file
JLoader::import( 'whmcs', JPATH_COMPONENT_ADMINISTRATOR);
$the = new WHMCS($key);
return $the->_key;
}
}
return $default;
}
}