Server : Apache/2.4.41 (Ubuntu) System : Linux journalup 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /var/www/html/lib/pkp/classes/controllers/listbuilder/
Upload File :
Current File : /var/www/html/lib/pkp/classes/controllers/listbuilder/ListbuilderHandler.inc.php
<?php
/**
* @file classes/controllers/listbuilder/ListbuilderHandler.inc.php
*
* Copyright (c) 2014-2020 Simon Fraser University
* Copyright (c) 2000-2020 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class ListbuilderHandler
* @ingroup controllers_listbuilder
*
* @brief Class defining basic operations for handling Listbuilder UI elements
*/
import('lib.pkp.classes.controllers.grid.GridHandler');
import('lib.pkp.classes.controllers.listbuilder.ListbuilderGridRow');
import('lib.pkp.classes.controllers.listbuilder.ListbuilderGridColumn');
import('lib.pkp.classes.controllers.listbuilder.MultilingualListbuilderGridColumn');
/* Listbuilder source types: text-based, pulldown, ... */
define('LISTBUILDER_SOURCE_TYPE_TEXT', 0);
define('LISTBUILDER_SOURCE_TYPE_SELECT', 1);
/* Listbuilder save types */
define('LISTBUILDER_SAVE_TYPE_EXTERNAL', 0); // Outside the listbuilder handler
define('LISTBUILDER_SAVE_TYPE_INTERNAL', 1); // Using ListbuilderHandler::save
/* String to identify optgroup in the returning options data. If you want to use
* optgroup in listbuilder select, return the options data in a multidimensional array
* array[columnIndex][optgroupId][selectItemId] and also with
* array[columnIndex][LISTBUILDER_OPTGROUP_LABEL][optgroupId] */
define('LISTBUILDER_OPTGROUP_LABEL', 'optGroupLabel');
class ListbuilderHandler extends GridHandler {
/** @var int Definition of the type of source LISTBUILDER_SOURCE_TYPE_... */
var $_sourceType;
/** @var int Constant indicating the save approach for the LB LISTBUILDER_SAVE_TYPE_... */
var $_saveType = LISTBUILDER_SAVE_TYPE_INTERNAL;
/** @var string Field for LISTBUILDER_SAVE_TYPE_EXTERNAL naming the field used to send the saved contents of the LB */
var $_saveFieldName = null;
/**
* @copydoc GridHandler::initialize
*/
function initialize($request, $args = null) {
parent::initialize($request, $args);
if ($this->canAddItems()) {
import('lib.pkp.classes.linkAction.request.NullAction');
$this->addAction($this->getAddItemLinkAction(new NullAction()));
}
}
//
// Getters and Setters
//
/**
* Get the listbuilder template.
* @return string
*/
function getTemplate() {
if (is_null($this->_template)) {
$this->setTemplate('controllers/listbuilder/listbuilder.tpl');
}
return $this->_template;
}
/**
* Set the type of source (Free text input, select from list, autocomplete)
* @param $sourceType int LISTBUILDER_SOURCE_TYPE_...
*/
function setSourceType($sourceType) {
$this->_sourceType = $sourceType;
}
/**
* Get the type of source (Free text input, select from list, autocomplete)
* @return int LISTBUILDER_SOURCE_TYPE_...
*/
function getSourceType() {
return $this->_sourceType;
}
/**
* Set the save type (using this handler or another external one)
* @param $sourceType int LISTBUILDER_SAVE_TYPE_...
*/
function setSaveType($saveType) {
$this->_saveType = $saveType;
}
/**
* Get the save type (using this handler or another external one)
* @return int LISTBUILDER_SAVE_TYPE_...
*/
function getSaveType() {
return $this->_saveType;
}
/**
* Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL
* @param $fieldName string
*/
function setSaveFieldName($fieldName) {
$this->_saveFieldName = $fieldName;
}
/**
* Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL.
* This will be the HTML field that receives the data upon submission.
* @return string
*/
function getSaveFieldName() {
assert(isset($this->_saveFieldName));
return $this->_saveFieldName;
}
/**
* Get the "add item" link action.
* @param $actionRequest ActionRequest
* @return LinkAction
*/
function getAddItemLinkAction($actionRequest) {
return new LinkAction(
'addItem',
$actionRequest,
__('grid.action.addItem'),
'add_item'
);
}
/**
* Get the new row ID from the request. For multi-column listbuilders,
* this is an array representing the row. For single-column
* listbuilders, this is a single piece of data (i.e. a string or int)
* @param $request PKPRequest
* @return mixed
*/
function getNewRowId($request) {
return $request->getUserVar('newRowId');
}
/**
* Delete an entry.
* @param $request Request object
* @param $rowId mixed ID of row to modify
* @return boolean
*/
function deleteEntry($request, $rowId) {
fatalError('ABSTRACT METHOD');
}
/**
* Persist an update to an entry.
* @param $request Request object
* @param $rowId mixed ID of row to modify
* @param $newRowId mixed ID of the new entry
* @return boolean
*/
function updateEntry($request, $rowId, $newRowId) {
// This may well be overridden by a subclass to modify
// an existing entry, e.g. to maintain referential integrity.
// If not, we can simply delete and insert.
if (!$this->deleteEntry($request, $rowId)) return false;
return $this->insertEntry($request, $newRowId);
}
/**
* Persist a new entry insert.
* @param $request Request object
* @param $newRowId mixed ID of row to modify
* @return boolean
*/
function insertEntry($request, $newRowId) {
fatalError('ABSTRACT METHOD');
}
/**
* Fetch the options for a LISTBUILDER_SOURCE_TYPE_SELECT LB
* Should return a multidimensional array:
* array(
* array('column 1 option 1', 'column 2 option 1'),
* array('column 1 option 2', 'column 2 option 2'
* );
* @param request Request
* @return array
*/
function getOptions($request) {
return array();
}
//
// Publicly (remotely) available listbuilder functions
//
/**
* Fetch the listbuilder.
* @param $args array
* @param $request PKPRequest
*/
function fetch($args, $request) {
$templateMgr = TemplateManager::getManager($request);
$options = $this->getOptions($request);
$availableOptions = false;
if (is_array($options) && !empty($options)) {
$firstColumnOptions = current($options);
$optionsCount = count($firstColumnOptions);
if (is_array(current($firstColumnOptions))) { // Options with opt group, count only the selectable options.
unset($firstColumnOptions[LISTBUILDER_OPTGROUP_LABEL]);
$optionsCount--;
$optionsCount = count($firstColumnOptions, COUNT_RECURSIVE) - $optionsCount;
}
$listElements = $this->getGridDataElements($request);
if (count($listElements) < $optionsCount) {
$availableOptions = true;
}
}
$templateMgr->assign('availableOptions', $availableOptions);
return $this->fetchGrid($args, $request);
}
/**
* Unpack data to save using an external handler.
* @param $data String (the json encoded data from the listbuilder itself)
* @param $deletionCallback array callback to be used for each deleted element
* @param $insertionCallback array callback to be used for each updated element
* @param $updateCallback array callback to be used for each updated element
*/
static function unpack($request, $data, $deletionCallback, $insertionCallback, $updateCallback) {
$data = json_decode($data);
$status = true;
// Handle deletions
if (isset($data->deletions) && $data->deletions !== '') {
foreach (explode(' ', trim($data->deletions)) as $rowId) {
if (!call_user_func($deletionCallback, $request, $rowId, $data->numberOfRows)) {
$status = false;
}
}
}
// Handle changes and insertions
if (isset($data->changes)) foreach ($data->changes as $entry) {
// Get the row ID, if any, from submitted data
if (isset($entry->rowId)) {
$rowId = $entry->rowId;
unset($entry->rowId);
} else {
$rowId = null;
}
// $entry should now contain only submitted modified or new rows.
// Go through each and unpack the data in prep for application.
$changes = array();
foreach ($entry as $key => $value) {
// Match the column name and localization data, if any.
if (!preg_match('/^newRowId\[([a-zA-Z]+)\](\[([a-z][a-z]_[A-Z][A-Z](@([A-Za-z0-9]{5,8}|\d[A-Za-z0-9]{3}))?)\])?$/', $key, $matches)) assert(false);
// Get the column name
$column = $matches[1];
// If this is a multilingual input, fetch $locale; otherwise null
$locale = isset($matches[3])?$matches[3]:null;
if ($locale) $changes[$column][$locale] = $value;
else $changes[$column] = $value;
}
// $changes should now contain e.g.:
// array ('localizedColumnName' => array('en_US' => 'englishValue'),
// 'nonLocalizedColumnName' => 'someNonLocalizedValue');
if (is_null($rowId)) {
if (!call_user_func($insertionCallback, $request, $changes)) $status = false;
} else {
if (!call_user_func($updateCallback, $request, $rowId, $changes)) $status = false;
}
}
return $status;
}
/**
* Save the listbuilder using the internal handler.
* @param $args array
* @param $request PKPRequest
*/
function save($args, $request) {
// The ListbuilderHandler will post a list of changed
// data in the "data" post var. Need to go through it
// and reconcile the data against this list, adding/
// updating/deleting as needed.
$data = $request->getUserVar('data');
self::unpack(
$request, $data,
array($this, 'deleteEntry'),
array($this, 'insertEntry'),
array($this, 'updateEntry')
);
}
/**
* Load the set of options for a select list type listbuilder.
* @param $args array
* @param $request PKPRequest
* @return JSONMessage JSON object
*/
function fetchOptions($args, $request) {
$options = $this->getOptions($request);
return new JSONMessage(true, $options);
}
/**
* Can items be added to this list builder?
*
* @return boolean
*/
public function canAddItems() {
return true;
}
//
// Overridden methods from GridHandler
//
/**
* @see GridHandler::getRowInstance()
* @return ListbuilderGridRow
*/
protected function getRowInstance() {
// Return a citation row
return new ListbuilderGridRow();
}
}
