blackicedbear/FHC-Core
1
0
Fork 0
mirror of https://github.com/FH-Complete/FHC-Core.git synced 2026-07-15 14:02:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

- Placed a timestamp in the filter/table widget session

Browse Source 
- Added a constant as fallback timeout for filter/table widget
- Added a parameter to specify the filter/table widget life time
- Filter/table widget on load removes expired filter/table widgets from session
This commit is contained in:
Paolo
2019-11-28 16:51:38 +01:00
parent 819face9f9
commit c2bc48d320
4 changed files with 189 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files
application/libraries/TableWidgetLib.php
+45 -14
View File
@@ -9,33 +9,40 @@ class TableWidgetLib
{
const TABLE_UNIQUE_ID = 'tableUniqueId'; // TableWidget unique id
// Session parameters names
const SESSION_NAME = 'FHC_TABLE_WIDGET'; // Table session name
// TableWidget session name
const SESSION_NAME = 'FHC_TABLE_WIDGET';
// Session elements
const SESSION_FIELDS = 'fields';
const SESSION_COLUMNS_ALIASES = 'columnsAliases';
const SESSION_ADDITIONAL_COLUMNS = 'additionalColumns';
const SESSION_CHECKBOXES = 'checkboxes';
const SESSION_METADATA = 'datasetMetadata';
const SESSION_DATASET = 'dataset';
const SESSION_ROW_NUMBER = 'rowNumber';
const SESSION_RELOAD_DATASET = 'reloadDataset';
// Session dataset elements
const SESSION_DATASET = 'dataset';
const SESSION_DATASET_RELOAD = 'reloadDataset';
const SESSION_DATASET_REPRESENTATION = 'datasetRepresentation';
const SESSION_DATASET_REP_OPTIONS = 'datasetRepresentationOptions';
const SESSION_DATASET_REP_FIELDS_DEFS = 'datasetRepresentationFieldsDefinitions';
// Default session timeout
const SESSION_DEFAULT_TIMEOUT = 30;
// Alias for the dynamic table used to retrieve the dataset
const DATASET_TABLE_ALIAS = 'datasetTableWidget';
// Parameters names...
// ...to reload the dataset
const DATASET_RELOAD_PARAMETER = 'reloadDataset';
const DATASET_RELOAD = 'reloadDataset';
// ...to specify permissions that are needed to use this TableWidget
const REQUIRED_PERMISSIONS_PARAMETER = 'requiredPermissions';
const REQUIRED_PERMISSIONS = 'requiredPermissions';
// ...stament to retrieve the dataset
const QUERY_PARAMETER = 'query';
const QUERY = 'query';
// ...to specify more columns or aliases for them
const ADDITIONAL_COLUMNS = 'additionalColumns';
@@ -50,6 +57,7 @@ class TableWidgetLib
const DATASET_REPRESENTATION = 'datasetRepresentation';
const DATASET_REP_OPTIONS = 'datasetRepOptions';
const DATASET_REP_FIELDS_DEFS = 'datasetRepFieldsDefs';
const DATASET_TIMEOUT = 'datasetTimeout'; // ...and its expiring time
// Different dataset representations
const DATASET_REP_TABLESORTER = 'tablesorter';
@@ -86,13 +94,13 @@ class TableWidgetLib
// Gets the required permissions from the session if they are not provided as parameter
$rq = $requiredPermissions;
if ($rq == null) $rq = $this->getSessionElement(self::REQUIRED_PERMISSIONS_PARAMETER);
if ($rq == null) $rq = $this->getSessionElement(self::REQUIRED_PERMISSIONS);
return $this->_ci->permissionlib->hasAtLeastOne($rq, self::PERMISSION_TABLE_METHOD, self::PERMISSION_TYPE);
}
/**
* Wrapper method to the session helper funtions to retrieve the whole session for this filter
* Wrapper method to the session helper funtions to retrieve the whole session for this table widget
*/
public function getSession()
{
@@ -100,7 +108,7 @@ class TableWidgetLib
}
/**
* Wrapper method to the session helper funtions to retrieve one element from the session of this filter
* Wrapper method to the session helper funtions to retrieve one element from the session of this table widget
*/
public function getSessionElement($name)
{
@@ -115,7 +123,7 @@ class TableWidgetLib
}
/**
* Wrapper method to the session helper funtions to set the whole session for this filter
* Wrapper method to the session helper funtions to set the whole session for this table widget
*/
public function setSession($data)
{
@@ -123,7 +131,7 @@ class TableWidgetLib
}
/**
* Wrapper method to the session helper funtions to set one element in the session for this filter
* Wrapper method to the session helper funtions to set one element in the session for this table widget
*/
public function setSessionElement($name, $value)
{
@@ -135,7 +143,30 @@ class TableWidgetLib
}
/**
* Generate the query to retrieve the dataset for a filter
*
*/
public function dropExpiredTableWidgets()
{
// Loads the session for all the table widgets
$tableWidgetsSession = getSession(self::SESSION_NAME);
// If something is present in session
if ($tableWidgetsSession != null)
{
// Loops in the session for all the table widgets
foreach ($tableWidgetsSession as $tableWidget => $tableWidgetData)
{
// If this table widget is not the currrent used table widget and the it is expired...
if ($this->_tableUniqueId != $tableWidget && $tableWidgetData[self::SESSION_TIMEOUT] <= time())
{
cleanSessionElement(self::SESSION_NAME, $tableWidget); // ...remove it
}
}
}
}
/**
* Generate the query to retrieve the dataset for a table widget
*/
public function generateDatasetQuery($query)
{
@@ -177,7 +208,7 @@ class TableWidgetLib
}
/**
* Return an unique string that identify this filter widget
* Return an unique string that identify this table widget
* NOTE: The default value is the URI where the FilterWidget is called
* If the fhc_controller_id is present then is also used
*/