addColumn(new GridColumn('indent', null, null, 'controllers/grid/gridCell.tpl', new NullGridCellProvider(), array('indent' => true))); } // // Getters and setters. // /** * Get the empty rows text for a category. * @return string */ function getEmptyCategoryRowText() { return $this->_emptyCategoryRowText; } /** * Set the empty rows text for a category. * @param string $translationKey */ function setEmptyCategoryRowText($translationKey) { $this->_emptyCategoryRowText = $translationKey; } // // Public handler methods // /** * Render a category with all the rows inside of it. * @param $args array * @param $request Request * @return string the serialized row JSON message or a flag * that indicates that the row has not been found. */ function fetchCategory(&$args, &$request) { // Instantiate the requested row (includes a // validity check on the row id). $row =& $this->getRequestedCategoryRow($request, $args); $json = new JSONMessage(true); if (is_null($row)) { // Inform the client that the category does no longer exist. $json->setAdditionalAttributes(array('elementNotFound' => (int)$args['rowId'])); } else { // Render the requested category $this->setFirstDataColumn(); $json->setContent($this->_renderCategoryInternally($request, $row)); } // Render and return the JSON message. return $json->getString(); } // // Extended methods from GridHandler // function initialize(&$request) { parent::initialize($request); if (!is_null($request->getUserVar('rowCategoryId'))) { $this->_currentCategoryId = (string) $request->getUserVar('rowCategoryId'); } } /** * @see GridHandler::getRequestArgs() */ function getRequestArgs() { $args = parent::getRequestArgs(); // If grid is rendering grid rows inside category, // add current category id value so rows will also know // their parent category. if (!is_null($this->_currentCategoryId)) { if ($this->getCategoryRowIdParameterName()) { $args[$this->getCategoryRowIdParameterName()] = $this->_currentCategoryId; } } return $args; } /** * @see GridHandler::getJSHandler() */ function getJSHandler() { return '$.pkp.controllers.grid.CategoryGridHandler'; } /** * @see GridHandler::setUrls() */ function setUrls(&$request) { $router =& $request->getRouter(); $url = array('fetchCategoryUrl' => $router->url($request, null, null, 'fetchCategory', null, $this->getRequestArgs())); parent::setUrls($request, $url); } /** * @see GridHandler::doSpecificFetchGridActions($args, $request) */ function doSpecificFetchGridActions($args, $request, &$templateMgr) { // Render the body elements (category groupings + rows inside a ) $gridBodyParts = $this->_renderCategoriesInternally($request); $templateMgr->assign_by_ref('gridBodyParts', $gridBodyParts); } /** * @see GridHandler::getRowDataElement() */ function getRowDataElement($request, $rowId) { $rowData = parent::getRowDataElement($request, $rowId); $rowCategoryId = $request->getUserVar('rowCategoryId'); if (is_null($rowData) && !is_null($rowCategoryId)) { // Try to get row data inside category. $categoryRowData = parent::getRowDataElement($request, $rowCategoryId); if (!is_null($categoryRowData)) { $categoryElements = $this->getCategoryData($categoryRowData, null); assert(is_array($categoryElements)); if (!isset($categoryElements[$rowId])) return null; // Let grid (and also rows) knowing the current category id. // This value will be published by the getRequestArgs method. $this->_currentCategoryId = $rowCategoryId; return $categoryElements[$rowId]; } } else { return $rowData; } } /** * @see GridHandler::setFirstDataColumn() */ function setFirstDataColumn() { $columns =& $this->getColumns(); reset($columns); // Category grids will always have indent column firstly, // so we need to consider the first column the second one. $secondColumn =& next($columns); /* @var $secondColumn GridColumn */ $secondColumn->addFlag('firstColumn', true); } // // Protected methods to be overridden/used by subclasses // /** * Get a new instance of a category grid row. May be * overridden by subclasses if they want to * provide a custom row definition. * @return CategoryGridRow */ function &getCategoryRowInstance() { //provide a sensible default category row definition $row = new GridCategoryRow(); return $row; } /** * Get the category row id parameter name. * @return string */ function getCategoryRowIdParameterName() { // Must be implemented by subclasses. return null; } /** * Fetch the contents of a category. * @param $categoryDataElement mixed * @return array */ function &getCategoryData(&$categoryDataElement, $filter = null) { $gridData = array(); $dataProvider =& $this->getDataProvider(); if (is_a($dataProvider, 'CategoryGridDataProvider')) { // Populate the grid with data from the // data provider. $gridData =& $dataProvider->getCategoryData($categoryDataElement, $filter); } return $gridData; } /** * Tries to identify the data element in the grids * data source that corresponds to the requested row id. * Raises a fatal error if such an element cannot be * found. * @param $request PKPRequest * @param $args array * @return GridRow the requested grid row, already * configured with id and data or null if the row * could not been found. */ function &getRequestedCategoryRow($request, $args) { if (isset($args['rowId'])) { // A row ID was specified. Fetch it $elementId = $args['rowId']; // Retrieve row data for the requested row id // (we can use the default getRowData element, works for category grids as well). $dataElement = $this->getRowDataElement($request, $elementId); if (is_null($dataElement)) { // If the row doesn't exist then // return null. It may be that the // row has been deleted in the meantime // and the client does not yet know about this. $nullVar = null; return $nullVar; } } // Instantiate a new row $row =& $this->_getInitializedCategoryRowInstance($request, $elementId, $dataElement); return $row; } /** * Get the category data element sequence value. * @param $gridDataElement mixed * @return int */ function getCategoryDataElementSequence(&$gridDataElement) { assert(false); } /** * Operation to save the category data element new sequence. * @param $gridDataElement mixed * @param $newSequence int */ function saveCategoryDataElementSequence(&$gridDataElement, $newSequence) { assert(false); } /** * @see GridHandler::saveRowDataElementSequence() */ function saveRowDataElementSequence($gridDataElement, $categoryId, $newSequence) { assert(false); } /** * @see GridHandler::renderRowInternally() */ function renderRowInternally($request, $row) { if ($this->getCategoryRowIdParameterName()) { $param = $this->getRequestArg($this->getCategoryRowIdParameterName()); $templateMgr =& TemplateManager::getManager(); $templateMgr->assign('categoryId', $param); } return parent::renderRowInternally($request, $row); } // // Private helper methods // /** * Instantiate a new row. * @param $request Request * @param $elementId string * @param $element mixed * @param $isModified boolean optional * @return GridRow */ function &_getInitializedCategoryRowInstance(&$request, $elementId, &$element) { // Instantiate a new row $row =& $this->getCategoryRowInstance(); $row->setGridId($this->getId()); $row->setId($elementId); $row->setData($element); $row->setRequestArgs($this->getRequestArgs()); // Initialize the row before we render it $row->initialize($request); $this->callFeaturesHook('getInitializedCategoryRowInstance', array('request' => &$request, 'grid' => &$this, 'row' => &$row)); return $row; } /** * Render all the categories internally * @param $request PKPRequest */ function _renderCategoriesInternally(&$request) { // Iterate through the rows and render them according // to the row definition. $renderedCategories = array(); $elements = $this->getGridDataElements($request); foreach($elements as $key => $element) { // Instantiate a new row $categoryRow =& $this->_getInitializedCategoryRowInstance($request, $key, $element); // Render the row $renderedCategories[] = $this->_renderCategoryInternally($request, $categoryRow); unset($element); } return $renderedCategories; } /** * Render a category row and its data. * @param $request PKPRequest * @param $categoryRow GridCategoryRow * @return String HTML for all the rows (including category) */ function _renderCategoryInternally(&$request, &$categoryRow) { // Prepare the template to render the category. $templateMgr =& TemplateManager::getManager(); $templateMgr->assign_by_ref('grid', $this); $columns = $this->getColumns(); $templateMgr->assign_by_ref('columns', $columns); $categoryDataElement =& $categoryRow->getData(); $filter = $this->getFilterSelectionData($request); $rowData =& $this->getCategoryData($categoryDataElement, $filter); // Render the data rows $templateMgr->assign_by_ref('categoryRow', $categoryRow); // Let grid (and also rows) knowing the current category id. // This value will be published by the getRequestArgs method. $this->_currentCategoryId = $categoryRow->getId(); $renderedRows = $this->_renderRowsInternally($request, $rowData); $templateMgr->assign_by_ref('rows', $renderedRows); $renderedCategoryRow = $this->renderRowInternally($request, $categoryRow); // Finished working with this category, erase the current id value. $this->_currentCategoryId = null; $templateMgr->assign_by_ref('renderedCategoryRow', $renderedCategoryRow); return $templateMgr->fetch('controllers/grid/gridBodyPartWithCategory.tpl'); } } ?>