Initial update to make functional on Zikula 3.1

The only major change was getting rid of the Action suffixes on controller classes. I also updated a bit of the javascript
paustian · Jan 20, 2022 · 373b948 · 373b948
1 parent 4b9b7f8
commit 373b948
Show file tree

Hide file tree

Showing 13 changed files with 64 additions and 64 deletions.
diff --git a/Controller/AdminController.php b/Controller/AdminController.php
@@ -44,15 +44,15 @@ class AdminController extends AbstractController {
      * @Route("")
      * @Theme("admin")
      * @param request - the incoming request.
-     * @Template("@PaustianBookModule/Admin/book_admin_menu.html.twig'")
+     * @Template("@PaustianBookModule/Admin/book_admin_menu.html.twig")
      * @return Response|array
      * The main entry point
      *
      * @return Response The rendered output consisting mainly of the admin menu
      *
      * @throws AccessDeniedException Thrown if the user does not have the appropriate access level for the function.
      */
-    public function indexAction(Request $request) {
+    public function index(Request $request) {
         //security check
         if (!$this->hasPermission($this->name . '::', '::', ACCESS_ADMIN)) {
             throw new AccessDeniedException($this->trans('You do not have pemission to access the Book admin interface.'));
@@ -71,7 +71,7 @@ public function indexAction(Request $request) {
      *
      * @throws AccessDeniedException Thrown if the user does not have the appropriate access level for the function.
      */
-    public function editAction(Request $request, BookEntity $book = null) {
+    public function edit(Request $request, BookEntity $book = null) {
         $doMerge = false;
         if (null === $book) {
             if (!$this->hasPermission($this->name . '::', '::', ACCESS_ADD)) {
@@ -114,7 +114,7 @@ public function editAction(Request $request, BookEntity $book = null) {
      * @param BookEntity $book
      * @return Response
      */
-    public function deleteAction(Request $request, BookEntity $book = null) {
+    public function delete(Request $request, BookEntity $book = null) {
         if (!$this->hasPermission('book::', $book->getBid() . "::", ACCESS_DELETE)) {
             throw new AccessDeniedException($this->trans("You do not have permission to delete that book."));
         }
@@ -146,7 +146,7 @@ public function deleteAction(Request $request, BookEntity $book = null) {
      * @return RedirectRespsonse | Response | AccessDeniedException
      * @throws AccessDeniedException
      */
-    public function editchapterAction(Request $request,
+    public function editchapter(Request $request,
                                       BookChaptersEntity $chapter = null) {
         $doMerge = false;
         if (null === $chapter) {
@@ -206,7 +206,7 @@ public function editchapterAction(Request $request,
      * @param BookArticlesEntity|null $article
      * @return RedirectResponse|Response
      */
-    public function editarticleAction(Request $request,
+    public function editarticle(Request $request,
                                       BookArticlesEntity $article = null,
                                       HookDispatcherInterface $hookDispatcher) {
         $doMerge = false;
@@ -260,7 +260,7 @@ public function editarticleAction(Request $request,
      * @param BookFiguresEntity|null $figure
      * @return RedirectResponse|Response
      */
-    public function editfigureAction(Request $request,
+    public function editfigure(Request $request,
                                      BookFiguresEntity $figure = null,
                                      HookDispatcherInterface $hookDispatcher) {
         $doMerge = false;
@@ -317,7 +317,7 @@ public function editfigureAction(Request $request,
      * @return Response
      * @return RedirectResponse
      */
-    public function editglossaryAction(Request $request,
+    public function editglossary(Request $request,
                                        BookGlossEntity $gloss = null,
                                        HookDispatcherInterface $hookDispatcher) {
         if (!$this->hasPermission($this->name . '::', '.*::', ACCESS_ADD)) {
@@ -362,7 +362,7 @@ public function editglossaryAction(Request $request,
      * @param Request $request
      * @return Response
      */
-    public function modifyAction(Request $request) {
+    public function modify(Request $request) {
         $repo = $this->getDoctrine()->getManager()->getRepository('PaustianBookModule:BookEntity');
         $books = $repo->getBooks();
 
@@ -392,7 +392,7 @@ private function _getChaptersAndBooks(&$chapters, &$books) {
      * @param Request $request
      * @return Response
      */
-    public function modifychapterAction(Request $request) {
+    public function modifychapter(Request $request) {
 
         $chapters = array();
         $books = array();
@@ -409,7 +409,7 @@ public function modifychapterAction(Request $request) {
      * @param Request $request
      * @return Response
      */
-    public function modifyarticleAction(Request $request, BookArticlesEntity $article = null) {
+    public function modifyarticle(Request $request, BookArticlesEntity $article = null) {
         //build an organization of the book
         $repo = $this->getDoctrine()->getRepository('PaustianBookModule:BookEntity');
         $books = $repo->buildtoc();
@@ -423,7 +423,7 @@ public function modifyarticleAction(Request $request, BookArticlesEntity $articl
      * @param Request $request
      * @return Response
      */
-    public function modifyfigureAction(Request $request) {
+    public function modifyfigure(Request $request) {
         //get the list of books
         $repo = $this->getDoctrine()->getManager()->getRepository('PaustianBookModule:BookEntity');
         $books = $repo->getBooks();
@@ -451,7 +451,7 @@ public function modifyfigureAction(Request $request) {
      * @Theme("admin")
      * @return Response
      */
-    public function modifyglossaryAction(string $letter) {
+    public function modifyglossary(string $letter) {
         $repo = $this->getDoctrine()->getManager()->getRepository('PaustianBookModule:BookGlossEntity');
         $terms = $repo->getGloss($letter, ['col' => 'u.term', 'direction' => 'ASC'], null, ['u.term', 'u.gid']);
         return $this->render('@PaustianBookModule/Admin/book_admin_modifyglossary.html.twig', ['terms' => $terms]);
@@ -523,7 +523,7 @@ private function _generate_chapter_menu() {
      * @param BookChaptersEntity $chapter - the chapter to export
      * @return Response
      */
-    public function exportAction(Request $request, BookChaptersEntity $chapter = null, $inlinefig=true) {
+    public function export(Request $request, BookChaptersEntity $chapter = null, $inlinefig=true) {
         $response = $this->redirect($this->generateUrl('paustianbookmodule_admin_modifychapter'));
         if ($chapter == null) {
             //you want the edit interface, which has a delete option.
@@ -554,7 +554,7 @@ public function exportAction(Request $request, BookChaptersEntity $chapter = nul
      * @return Response
      * @throws AccessDeniedException
      */
-    public function deletechapterAction(Request $request, BookChaptersEntity $chapter = null) {
+    public function deletechapter(Request $request, BookChaptersEntity $chapter = null) {
         $response = $this->redirect($this->generateUrl('paustianbookmodule_admin_modifychapter'));
         if ($chapter == null) {
             //you want the edit interface, which has a delete option.
@@ -589,7 +589,7 @@ public function deletechapterAction(Request $request, BookChaptersEntity $chapte
      * @param BookArticlesEntity $article
      * @return RedirectResponse
      */
-    public function deletearticleAction(Request $request,
+    public function deletearticle(Request $request,
                                         BookArticlesEntity $article = null,
                                         HookDispatcherInterface $hookDispatcher) {
 
@@ -623,7 +623,7 @@ public function deletearticleAction(Request $request,
      * @return RedirectResponse
      * @throws AccessDeniedException
      */
-    public function deletefigureAction(Request $request, BookFiguresEntity $figure = null) {
+    public function deletefigure(Request $request, BookFiguresEntity $figure = null) {
         $response = $this->redirect($this->generateUrl('paustianbookmodule_admin_modifyfigure'));
         if ($figure == null) {
             if (!$this->hasPermission($this->name . '::', "::", ACCESS_DELETE)) {
@@ -647,7 +647,7 @@ public function deletefigureAction(Request $request, BookFiguresEntity $figure =
      * @return Response
      * @throws AccessDeniedException
      */
-    public function deleteglossaryAction(Request $request, BookGlossEntity $gloss = null) {
+    public function deleteglossary(Request $request, BookGlossEntity $gloss = null) {
         if (!$this->hasPermission($this->name . '::', "::", ACCESS_DELETE)) {
             throw new AccessDeniedException($this->trans("You do not have permission to delete that glossary item."));
         }
@@ -677,7 +677,7 @@ public function updateconfig() {
      * @param Request $request
      * @return Response
      */
-    public function arrangearticlesAction(Request $request)  : Response {
+    public function arrangearticles(Request $request)  : Response {
         $repo = $this->getDoctrine()->getRepository('PaustianBookModule:BookEntity');
         $chapterids= "";
         $books = $repo->buildtoc(0, $chapterids);
@@ -692,7 +692,7 @@ public function arrangearticlesAction(Request $request)  : Response {
      * @param Request $request
      * @return Response
      */
-    public function savearrangementAction(Request $request) {
+    public function savearrangement(Request $request) {
         $chapterIds = $request->request->get('chapterids');
         $chapterId_array = explode(',', $chapterIds);
         //walk each chapter and associate the articles in it's box with it
@@ -763,7 +763,7 @@ public function savearrangementAction(Request $request) {
      * I will have to do some serious checking for missing params, and if not
      * there, unwind the whole process.
      */
-    public function importAction(Request $request) {
+    public function import(Request $request) {
         if (!$this->hasPermission($this->name. '::', '::', ACCESS_ADD)) {
             throw new AccessDeniedException($this->trans("You do not have permission to import text to books."));
         }
@@ -834,7 +834,7 @@ public function importAction(Request $request) {
      * and their article location. Note, this does not list internal links, since those return
      * without error due to the way zikula is set up.
      */
-    public function verifyurlsAction(Request $request, BookChaptersEntity $chapter = null) {
+    public function verifyurls(Request $request, BookChaptersEntity $chapter = null) {
         $this->theRequest = $request;
         //if there is not chapter, then redirect to the modify chapter screen.
         $response = $this->redirect($this->generateUrl('paustianbookmodule_admin_modifychapter'));
@@ -972,7 +972,7 @@ private function _is_valid_url(string $url) {
      * This routine will find all empty definitions in the glossary and then display them to the author.
      * The author can then define them.
      */
-    public function checkstudentdefsAction(Request $request) {
+    public function checkstudentdefs(Request $request) {
         if (!$this->hasPermission($this->name. '::', '::', ACCESS_EDIT)) {
             throw new AccessDeniedException($this->trans("You do not have permission to edit glossary items."));
         }
@@ -988,7 +988,7 @@ public function checkstudentdefsAction(Request $request) {
      * @param Request $request
      * @return Response
      */
-    public function importglossaryAction(Request $request) {
+    public function importglossary(Request $request) {
         if (!$this->hasPermission($this->name. '::', '::', ACCESS_ADD)) {
             throw new AccessDeniedException($this->trans("You do not have permission to import glossary items."));
         }
@@ -1022,7 +1022,7 @@ public function importglossaryAction(Request $request) {
      * @param BookChaptersEntity $chapter
      * @return Response
      */
-    public function searchreplaceAction(Request $request, BookChaptersEntity $chapter = null) {
+    public function searchreplace(Request $request, BookChaptersEntity $chapter = null) {
         if (!$this->hasPermission($this->name. '::', '::', ACCESS_ADD)) {
             throw new AccessDeniedException($this->trans("You do not have permission to perform a search and replace."));
         }
@@ -1067,7 +1067,7 @@ public function searchreplaceAction(Request $request, BookChaptersEntity $chapte
      * @return Response
      *
      */
-    public function addglossarytoarticleAction(Request $request, BookArticlesEntity $article = null){
+    public function addglossarytoarticle(Request $request, BookArticlesEntity $article = null){
         if (!$this->hasPermission($this->name. '::', '::', ACCESS_ADD)) {
             throw new AccessDeniedException($this->trans("You do not have permission to perform a glossary add."));
         }

diff --git a/Controller/UserController.php b/Controller/UserController.php
@@ -71,7 +71,7 @@ public function __construct(
      * @param $request
      * @return Response
      */
-    public function indexAction(Request $request) : Response {
+    public function index(Request $request) : Response {
         // Security check
         if (!$this->hasPermission($this->name . '::', '::', ACCESS_READ)) {
             throw new AccessDeniedException($this->trans('You do not have pemission to access any books.'));
@@ -90,7 +90,7 @@ public function indexAction(Request $request) : Response {
      * @param BookEntity $book
      * @return Response
      */
-    public function tocAction(Request $request, BookEntity $book = null) : Response {
+    public function toc(Request $request, BookEntity $book = null) : Response {
         $bid = -1;
         if (null === $book) {
             $bid = $request->query->getInt('bid');
@@ -128,15 +128,15 @@ public function tocAction(Request $request, BookEntity $book = null) : Response
      * @param Request $request
      * @return Response
      */
-    public function viewAction(Request $request) : Response {
+    public function view(Request $request) : Response {
         return $this->redirect($this->generateUrl('paustianbookmodule_user_index'));
     }
 
     /**
      * @Route("/display")
      * @return Response
      */
-    public function displayAction(Request $request) : Response {
+    public function display(Request $request) : Response {
         return $this->redirect($this->generateUrl('paustianbookmodule_user_index'));
     }
 
@@ -148,7 +148,7 @@ public function displayAction(Request $request) : Response {
      * @param bool $doglossary
      * @return Response
      */
-    public function displayarticleAction(Request $request,
+    public function displayarticle(Request $request,
                                          BookArticlesEntity $article = null,
                                          bool $doglossary = true) : Response {
         if (null === $article) {
@@ -336,7 +336,7 @@ private function _process_highlights(string $content,
      * @param BookFiguresEntity $figure
      * @return Response
      */
-    public function displayfigureAction(Request $request, BookFiguresEntity $figure = null) : Response{
+    public function displayfigure(Request $request, BookFiguresEntity $figure = null) : Response{
         if (null === $figure) {
             return $this->redirect($this->generateUrl('paustianbookmodule_user_index'));
         }
@@ -370,7 +370,7 @@ public function displayfigureAction(Request $request, BookFiguresEntity $figure
      * @param Request $request
      * @return Response
      */
-    public function displayglossaryAction(Request $request) : Response {
+    public function displayglossary(Request $request) : Response {
 //you must have permission to read some book.
         if (!$this->hasPermission($this->name . '::', '::', ACCESS_OVERVIEW)) {
             throw new AccessDeniedException($this->trans('You do not have pemission to access any glossry items.'));
@@ -390,7 +390,7 @@ public function displayglossaryAction(Request $request) : Response {
      * @param BookEntity $book
      * @return Response
      */
-    public function displaybookAction(Request $request, BookEntity $book) : Response {
+    public function displaybook(Request $request, BookEntity $book) : Response {
         $bid = -1;
         if (null === $book) {
             $bid = $request->get('bid');
@@ -412,7 +412,7 @@ public function displaybookAction(Request $request, BookEntity $book) : Response
         foreach ($chapters as $chap_item) {
             $cid = $chap_item->getCid();
             if ($this->hasPermission($this->name . '::Chapter', "$bid::$cid", ACCESS_READ)) {
-                $ret_text .= $this->displaychapterAction($request, $chap_item);
+                $ret_text .= $this->displaychapter($request, $chap_item);
             }
         }
         return $ret_text;
@@ -425,7 +425,7 @@ public function displaybookAction(Request $request, BookEntity $book) : Response
      * @param BookChaptersEntity $chapter
      * @return Response
      */
-    public function displaychapterAction(Request $request, BookChaptersEntity $chapter = null) : Response {
+    public function displaychapter(Request $request, BookChaptersEntity $chapter = null) : Response {
         if (null === $chapter) {
             //Old style URL, look for the chapter using the cid
             $cid = $request->get('cid');
@@ -458,7 +458,7 @@ public function displaychapterAction(Request $request, BookChaptersEntity $chapt
      * @param BookChaptersEntity $chapter
      * @return Response
      */
-    public function displayarticlesinchapterAction(Request $request, BookChaptersEntity $chapter = null) : Response {
+    public function displayarticlesinchapter(Request $request, BookChaptersEntity $chapter = null) : Response {
         if (null === $chapter) {
             $cid = $request->get('cid');
             if (isset($cid)) {
@@ -504,7 +504,7 @@ public function displayarticlesinchapterAction(Request $request, BookChaptersEnt
      * @param Request $request
      * @return Response
      */
-    public function collecthighlightsAction(Request $request, BookArticlesEntity $article = null) :Response
+    public function collecthighlights(Request $request, BookArticlesEntity $article = null) :Response
     {
         //build an organization of the book
         $repo = $this->getDoctrine()->getRepository('PaustianBookModule:BookEntity');
@@ -526,7 +526,7 @@ public function collecthighlightsAction(Request $request, BookArticlesEntity $ar
      * @param Request $request
      * @return Response
      */
-    public function studypageAction(Request $request) : Response {
+    public function studypage(Request $request) : Response {
         $response = $this->redirect($this->generateUrl('paustianbookmodule_user_collecthighlights'));
         $uid = $this->currentUserApi->get('uid');
         if ($uid == "") {
@@ -582,7 +582,7 @@ public function studypageAction(Request $request) : Response {
      *
      * @return boolean|RedirectResponse|Response
      */
-    public function customizeTextAction(Request $request,
+    public function customizeText(Request $request,
                                         BookArticlesEntity $article) : Response {
         $button = $request->get('buttonpress');
         $text = $request->get('text');
@@ -591,7 +591,7 @@ public function customizeTextAction(Request $request,
         } elseif ($button == 'dodef') {
             return $this->_dodef($request, $article, $text, $this->currentUserApi);
         } else {
-            return $this->collecthighlightsAction($request, $article);
+            return $this->collecthighlights($request, $article);
         }
     }
 
@@ -725,7 +725,7 @@ private function _dodef(Request $request, BookArticlesEntity $article,
      * @param Request $request
      * @return Response
      */
-    public function downloadAction(Request $request) : Response
+    public function download(Request $request) : Response
     {
         $allow_dl = false;
         if ($this->currentUserApi->isLoggedIn()) {

diff --git a/Resources/views/Admin/book_admin_arrangearticles.html.twig b/Resources/views/Admin/book_admin_arrangearticles.html.twig
@@ -1,5 +1,7 @@
-{{ pageSetVar('title', 'Arrange Articles') }}
+{{ pageAddAsset('javascript', zasset('jqueryui/jquery-ui.js')) }}
+{{ pageAddAsset('stylesheet', asset('jqueryui/themes/base/jquery-ui.min.css')) }}
 {{ pageAddAsset('stylesheet', zasset('@PaustianBookModule:css/forms.css')) }}
+{{ pageSetVar('title', 'Arrange Articles') }}
 
 <h3>
     <span class="fa fa-book"></span>