pkp/pkp-lib#1923: Refactor GridCellProvider::getTemplateVarsFromRowCo…

…lumn() to include current $request object ##ulsdevteam/add-request-to-gridcellprovider##
ulsdevteam · Feb 10, 2017 · b71efe7 · b71efe7
1 parent 011f4dd
commit b71efe7
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 33 deletions.
diff --git a/controllers/grid/articleGalleys/ArticleGalleyGridCellProvider.inc.php b/controllers/grid/articleGalleys/ArticleGalleyGridCellProvider.inc.php
@@ -35,7 +35,7 @@ function __construct($submission) {
 	/**
 	 * @copydoc GridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$element = $row->getData();
 		$columnId = $column->getId();
 		assert(is_a($element, 'DataObject') && !empty($columnId));
@@ -48,7 +48,7 @@ function getTemplateVarsFromRowColumn($row, $column) {
 				break;
 			default: assert(false);
 		}
-		return parent::getTemplateVarsFromRowColumn($row, $column);
+		return parent::getTemplateVarsFromRowColumn($request, $row, $column);
 	}
 
 	/**

diff --git a/controllers/grid/issueGalleys/IssueGalleyGridCellProvider.inc.php b/controllers/grid/issueGalleys/IssueGalleyGridCellProvider.inc.php
@@ -24,13 +24,9 @@ function __construct() {
 	}
 
 	/**
-	 * Extracts variables for a given column from a data element
-	 * so that they may be assigned to template before rendering.
-	 * @param $row GridRow
-	 * @param $column GridColumn
-	 * @return array
+	 * @copydoc GridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$issueGalley = $row->getData();
 		$columnId = $column->getId();
 		assert (is_a($issueGalley, 'IssueGalley'));

diff --git a/controllers/grid/issues/IssueGridCellProvider.inc.php b/controllers/grid/issues/IssueGridCellProvider.inc.php
@@ -56,13 +56,9 @@ function getCellActions($request, $row, $column, $position = GRID_ACTION_POSITIO
 	}
 
 	/**
-	 * Extracts variables for a given column from a data element
-	 * so that they may be assigned to template before rendering.
-	 * @param $row GridRow
-	 * @param $column GridColumn
-	 * @return array
+	 * @copydoc GridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$issue = $row->getData();
 		$columnId = $column->getId();
 		assert (is_a($issue, 'Issue'));

diff --git a/controllers/grid/pubIds/PubIdExportIssuesListGridCellProvider.inc.php b/controllers/grid/pubIds/PubIdExportIssuesListGridCellProvider.inc.php
@@ -88,7 +88,7 @@ function getCellActions($request, $row, $column, $position = GRID_ACTION_POSITIO
 	 *
 	 * @copydoc DataObjectGridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$publishedIssue = $row->getData();
 		$columnId = $column->getId();
 		assert(is_a($publishedIssue, 'Issue') && !empty($columnId));

diff --git a/controllers/grid/pubIds/PubIdExportRepresentationsListGridCellProvider.inc.php b/controllers/grid/pubIds/PubIdExportRepresentationsListGridCellProvider.inc.php
@@ -106,12 +106,9 @@ function getCellActions($request, $row, $column, $position = GRID_ACTION_POSITIO
 	}
 
 	/**
-	 * Extracts variables for a given column from a data element
-	 * so that they may be assigned to template before rendering.
-	 *
 	 * @copydoc DataObjectGridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$publishedSubmissionGalley = $row->getData();
 		$columnId = $column->getId();
 		assert(is_a($publishedSubmissionGalley, 'ArticleGAlley') && !empty($columnId));

diff --git a/controllers/grid/pubIds/PubIdExportSubmissionsListGridCellProvider.inc.php b/controllers/grid/pubIds/PubIdExportSubmissionsListGridCellProvider.inc.php
@@ -25,9 +25,9 @@ function __construct($plugin, $authorizedRoles = null) {
 	}
 
 	/**
-	 * @copydoc ExportPublishedSubmissionsListGridCellProvider::getTemplateVarsFromRowColumn()
+	 * @copydoc GridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$publishedSubmission = $row->getData();
 		$columnId = $column->getId();
 		assert(is_a($publishedSubmission, 'PublishedArticle') && !empty($columnId));
@@ -36,7 +36,7 @@ function getTemplateVarsFromRowColumn($row, $column) {
 			case 'pubId':
 				return array('label' => $publishedSubmission->getStoredPubId($this->_plugin->getPubIdType()));
 		}
-		return parent::getTemplateVarsFromRowColumn($row, $column);
+		return parent::getTemplateVarsFromRowColumn($request, $row, $column);
 	}
 
 }

diff --git a/controllers/grid/submissions/ExportPublishedSubmissionsListGridCellProvider.inc.php b/controllers/grid/submissions/ExportPublishedSubmissionsListGridCellProvider.inc.php
@@ -103,12 +103,9 @@ function getCellActions($request, $row, $column, $position = GRID_ACTION_POSITIO
 	}
 
 	/**
-	 * Extracts variables for a given column from a data element
-	 * so that they may be assigned to template before rendering.
-	 *
-	 * @copydoc DataObjectGridCellProvider::getTemplateVarsFromRowColumn()
+	 * @copydoc GridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$publishedSubmission = $row->getData();
 		$columnId = $column->getId();
 		assert(is_a($publishedSubmission, 'PublishedArticle') && !empty($columnId));

diff --git a/controllers/grid/toc/TocGridCellProvider.inc.php b/controllers/grid/toc/TocGridCellProvider.inc.php
@@ -24,13 +24,9 @@ function __construct($translate = false) {
 	}
 
 	/**
-	 * Extracts variables for a given column from a data element
-	 * so that they may be assigned to template before rendering.
-	 * @param $row GridRow
-	 * @param $column GridColumn
-	 * @return array
+	 * @copydoc GridCellProvider::getTemplateVarsFromRowColumn()
 	 */
-	function getTemplateVarsFromRowColumn($row, $column) {
+	function getTemplateVarsFromRowColumn($request, $row, $column) {
 		$element = $row->getData();
 		$columnId = $column->getId();
 		assert(!empty($columnId));