CustomBlockGridHandler.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.GridHandler');
import('plugins.generic.customBlockManager.controllers.grid.CustomBlockGridRow');
 
class CustomBlockGridHandler extends GridHandler {
   var $plugin;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER, ROLE_ID_SITE_ADMIN),
         array('fetchGrid', 'fetchRow', 'addCustomBlock', 'editCustomBlock', 'updateCustomBlock', 'deleteCustomBlock')
      );
      $this->plugin = PluginRegistry::getPlugin('generic', CUSTOMBLOCKMANAGER_PLUGIN_NAME);
   }
 
 
   //
   // Overridden template methods
   //
   function authorize($request, &$args, $roleAssignments) {
      if ($request->getContext()) {
         import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
         $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      } else {
         import('lib.pkp.classes.security.authorization.PKPSiteAccessPolicy');
         $this->addPolicy(new PKPSiteAccessPolicy($request, null, $roleAssignments));
      }
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : 0;
 
      // Set the grid title.
      $this->setTitle('plugins.generic.customBlockManager.customBlocks');
      // Set the grid instructions.
      $this->setEmptyRowText('plugins.generic.customBlockManager.noneCreated');
 
      // Get the blocks and add the data to the grid
      $customBlockManagerPlugin = $this->plugin;
      $blocks = $customBlockManagerPlugin->getSetting($contextId, 'blocks');
      $gridData = array();
      if (is_array($blocks)) foreach ($blocks as $block) {
         $gridData[$block] = array(
            'title' => $block
         );
      }
      $this->setGridDataElements($gridData);
 
      // Add grid-level actions
      $router = $request->getRouter();
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $this->addAction(
         new LinkAction(
            'addCustomBlock',
            new AjaxModal(
               $router->url($request, null, null, 'addCustomBlock'),
               __('plugins.generic.customBlockManager.addBlock'),
               'modal_add_item'
            ),
            __('plugins.generic.customBlockManager.addBlock'),
            'add_item'
         )
      );
 
      // Columns
      $this->addColumn(
         new GridColumn(
            'title',
            'plugins.generic.customBlockManager.blockName',
            null,
            'controllers/grid/gridCell.tpl'
         )
      );
   }
 
   //
   // Overridden methods from GridHandler
   //
   function getRowInstance() {
      return new CustomBlockGridRow();
   }
 
   //
   // Public Grid Actions
   //
   function addCustomBlock($args, $request) {
      // Calling editCustomBlock with an empty ID will add
      // a new custom block.
      return $this->editCustomBlock($args, $request);
   }
 
   function editCustomBlock($args, $request) {
      $blockName = $request->getUserVar('blockName');
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : 0;
      $this->setupTemplate($request);
 
      $customBlockPlugin = null;
      // If this is the edit of the existing custom block plugin,
      if ($blockName) {
         // Create the custom block plugin
         import('plugins.generic.customBlockManager.CustomBlockPlugin');
         $customBlockPlugin = new CustomBlockPlugin($blockName, CUSTOMBLOCKMANAGER_PLUGIN_NAME);
      }
 
      // Create and present the edit form
      import('plugins.generic.customBlockManager.controllers.grid.form.CustomBlockForm');
      $customBlockManagerPlugin = $this->plugin;
      $template = $customBlockManagerPlugin->getTemplateResource('editCustomBlockForm.tpl');
      $customBlockForm = new CustomBlockForm($template, $contextId, $customBlockPlugin);
      $customBlockForm->initData();
      return new JSONMessage(true, $customBlockForm->fetch($request));
   }
 
   function updateCustomBlock($args, $request) {
      $pluginName = $request->getUserVar('existingBlockName');
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : 0;
      $this->setupTemplate($request);
 
      $customBlockPlugin = null;
      // If this was the edit of the existing custom block plugin
      if ($pluginName) {
         // Create the custom block plugin
         import('plugins.generic.customBlockManager.CustomBlockPlugin');
         $customBlockPlugin = new CustomBlockPlugin($pluginName, CUSTOMBLOCKMANAGER_PLUGIN_NAME);
      }
 
      // Create and populate the form
      import('plugins.generic.customBlockManager.controllers.grid.form.CustomBlockForm');
      $customBlockManagerPlugin = $this->plugin;
      $template = $customBlockManagerPlugin->getTemplateResource('editCustomBlockForm.tpl');
      $customBlockForm = new CustomBlockForm($template, $contextId, $customBlockPlugin);
      $customBlockForm->readInputData();
 
      // Check the results
      if ($customBlockForm->validate()) {
         // Save the results
         $customBlockForm->execute();
         return DAO::getDataChangedEvent();
      } else {
         // Present any errors
         return new JSONMessage(true, $customBlockForm->fetch($request));
      }
   }
 
   function deleteCustomBlock($args, $request) {
      $blockName = $request->getUserVar('blockName');
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : 0;
 
      // Delete all the entries for this block plugin
      $pluginSettingsDao = DAORegistry::getDAO('PluginSettingsDAO');
      $pluginSettingsDao->deleteSetting($contextId, $blockName, 'enabled');
      $pluginSettingsDao->deleteSetting($contextId, $blockName, 'context');
      $pluginSettingsDao->deleteSetting($contextId, $blockName, 'seq');
      $pluginSettingsDao->deleteSetting($contextId, $blockName, 'blockContent');
 
      // Remove this block plugin from the list of the custom block plugins
      $customBlockManagerPlugin = $this->plugin;
      $blocks = $customBlockManagerPlugin->getSetting($contextId, 'blocks');
      $newBlocks = array_diff($blocks, array($blockName));
      ksort($newBlocks);
      $customBlockManagerPlugin->updateSetting($contextId, 'blocks', $newBlocks);
      return DAO::getDataChangedEvent();
   }
}