first commit

plugins/generic/staticPages/controllers/grid/StaticPageGridHandler.php

@@ -0,0 +1,228 @@
+<?php
+
+/**
+ * @file controllers/grid/StaticPageGridHandler.php
+ *
+ * Copyright (c) 2014-2020 Simon Fraser University
+ * Copyright (c) 2003-2020 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class StaticPageGridHandler
+ *
+ * @ingroup controllers_grid_staticPages
+ *
+ * @brief Handle static pages grid requests.
+ */
+
+namespace APP\plugins\generic\staticPages\controllers\grid;
+
+use APP\plugins\generic\staticPages\classes\StaticPagesDAO;
+use APP\plugins\generic\staticPages\controllers\grid\form\StaticPageForm;
+use APP\plugins\generic\staticPages\StaticPagesPlugin;
+use PKP\controllers\grid\GridColumn;
+use PKP\controllers\grid\GridHandler;
+use PKP\core\JSONMessage;
+use PKP\core\PKPRequest;
+use PKP\db\DAO;
+use PKP\db\DAORegistry;
+use PKP\form\Form;
+use PKP\linkAction\LinkAction;
+use PKP\linkAction\request\AjaxModal;
+use PKP\security\authorization\ContextAccessPolicy;
+use PKP\security\Role;
+
+class StaticPageGridHandler extends GridHandler
+{
+    /** @var StaticPagesPlugin The static pages plugin */
+    public $plugin;
+
+    /**
+     * Constructor
+     */
+    public function __construct(StaticPagesPlugin $plugin)
+    {
+        parent::__construct();
+        $this->addRoleAssignment(
+            [Role::ROLE_ID_MANAGER],
+            ['index', 'fetchGrid', 'fetchRow', 'addStaticPage', 'editStaticPage', 'updateStaticPage', 'delete']
+        );
+        $this->plugin = $plugin;
+    }
+
+
+    //
+    // Overridden template methods
+    //
+    /**
+     * @copydoc PKPHandler::authorize()
+     */
+    public function authorize($request, &$args, $roleAssignments)
+    {
+        $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
+        return parent::authorize($request, $args, $roleAssignments);
+    }
+
+    /**
+     * @copydoc GridHandler::initialize()
+     *
+     * @param null|mixed $args
+     */
+    public function initialize($request, $args = null)
+    {
+        parent::initialize($request, $args);
+        $context = $request->getContext();
+
+        // Set the grid details.
+        $this->setTitle('plugins.generic.staticPages.staticPages');
+        $this->setEmptyRowText('plugins.generic.staticPages.noneCreated');
+
+        // Get the pages and add the data to the grid
+        /** @var StaticPagesDAO */
+        $staticPagesDao = DAORegistry::getDAO('StaticPagesDAO');
+        $this->setGridDataElements($staticPagesDao->getByContextId($context->getId()));
+
+        // Add grid-level actions
+        $router = $request->getRouter();
+        $this->addAction(
+            new LinkAction(
+                'addStaticPage',
+                new AjaxModal(
+                    $router->url($request, null, null, 'addStaticPage'),
+                    __('plugins.generic.staticPages.addStaticPage'),
+                    'modal_add_item'
+                ),
+                __('plugins.generic.staticPages.addStaticPage'),
+                'add_item'
+            )
+        );
+
+        // Columns
+        $cellProvider = new StaticPageGridCellProvider();
+        $this->addColumn(new GridColumn(
+            'title',
+            'plugins.generic.staticPages.pageTitle',
+            null,
+            'controllers/grid/gridCell.tpl', // Default null not supported in OMP 1.1
+            $cellProvider
+        ));
+        $this->addColumn(new GridColumn(
+            'path',
+            'plugins.generic.staticPages.path',
+            null,
+            'controllers/grid/gridCell.tpl', // Default null not supported in OMP 1.1
+            $cellProvider
+        ));
+    }
+
+    //
+    // Overridden methods from GridHandler
+    //
+    /**
+     * @copydoc GridHandler::getRowInstance()
+     */
+    public function getRowInstance()
+    {
+        return new StaticPageGridRow();
+    }
+
+    //
+    // Public Grid Actions
+    //
+    /**
+     * Display the grid's containing page.
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     * @return JSONMessage
+     */
+    public function index($args, $request)
+    {
+        $form = new Form($this->plugin->getTemplateResource('staticPages.tpl'));
+        return new JSONMessage(true, $form->fetch($request));
+    }
+
+    /**
+     * An action to add a new custom static page
+     *
+     * @param array $args Arguments to the request
+     * @param PKPRequest $request Request object
+     */
+    public function addStaticPage($args, $request)
+    {
+        // Calling editStaticPage with an empty ID will add
+        // a new static page.
+        return $this->editStaticPage($args, $request);
+    }
+
+    /**
+     * An action to edit a static page
+     *
+     * @param array $args Arguments to the request
+     * @param PKPRequest $request Request object
+     *
+     * @return JSONMessage Serialized JSON object
+     */
+    public function editStaticPage($args, $request)
+    {
+        $staticPageId = $request->getUserVar('staticPageId');
+        $context = $request->getContext();
+        $this->setupTemplate($request);
+
+        // Create and present the edit form
+        $staticPageForm = new StaticPageForm($this->plugin, $context->getId(), $staticPageId);
+        $staticPageForm->initData();
+        return new JSONMessage(true, $staticPageForm->fetch($request));
+    }
+
+    /**
+     * Update a custom block
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     *
+     * @return JSONMessage Serialized JSON object
+     */
+    public function updateStaticPage($args, $request)
+    {
+        $staticPageId = $request->getUserVar('staticPageId');
+        $context = $request->getContext();
+        $this->setupTemplate($request);
+
+        // Create and populate the form
+        $staticPageForm = new StaticPageForm($this->plugin, $context->getId(), $staticPageId);
+        $staticPageForm->readInputData();
+
+        // Check the results
+        if ($staticPageForm->validate()) {
+            // Save the results
+            $staticPageForm->execute();
+            return DAO::getDataChangedEvent();
+        }
+        // Present any errors
+        return new JSONMessage(true, $staticPageForm->fetch($request));
+    }
+
+    /**
+     * Delete a static page
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     *
+     * @return JSONMessage Serialized JSON object
+     */
+    public function delete($args, $request)
+    {
+        if (!$request->checkCSRF()) return new JSONMessage(false);
+
+        $staticPageId = $request->getUserVar('staticPageId');
+        $context = $request->getContext();
+
+        // Delete the static page
+        /** @var StaticPagesDAO */
+        $staticPagesDao = DAORegistry::getDAO('StaticPagesDAO');
+        $staticPage = $staticPagesDao->getById($staticPageId, $context->getId());
+        $staticPagesDao->deleteObject($staticPage);
+
+        return DAO::getDataChangedEvent();
+    }
+}