Added plugin admin parameters, replaced is_notifiable by listener for…

… user parameters
iCAPLyon1 · Apr 16, 2015 · 153f8f5 · 153f8f5
1 parent b908de4
commit 153f8f5
Show file tree

Hide file tree

Showing 33 changed files with 1,175 additions and 114 deletions.
diff --git a/Controller/NotificationController.php b/Controller/NotificationController.php
@@ -8,9 +8,6 @@
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
-
-use Icap\NotificationBundle\Entity\ColorChooser;
-
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
@@ -32,19 +29,11 @@ class NotificationController extends Controller
      */
     public function listAction(Request $request, $user, $page)
     {
-        if ($request->isXMLHttpRequest()) {
-            $maxResult = $this->container->getParameter('icap_notification.dropdown_items');
-            $page = 1;
-        } else {
-            $maxResult = $this->container->getParameter('icap_notification.max_per_page');
-        }
-
         $notificationManager = $this->getNotificationManager();
-        $result = $notificationManager->getUserNotificationsList($user->getId(), $page, $maxResult);
         $systemName = $notificationManager->getPlatformName();
-        $result['systemName'] = $systemName;
-
         if ($request->isXMLHttpRequest()) {
+            $result = $notificationManager->getDropdownNotifications($user->getId());
+            $result['systemName'] = $systemName;
             $unviewedNotifications = $notificationManager->countUnviewedNotifications(
                 $user->getId()
             );
@@ -55,8 +44,8 @@ public function listAction(Request $request, $user, $page)
                 $result
             );
         } else {
-            $defaultLayout = $this->container->getParameter('icap_notification.default_layout');
-            $result['layout'] = $defaultLayout;
+            $result = $notificationManager->getPaginatedNotifications($user->getId(), $page);
+            $result['systemName'] = $systemName;
 
             return $result;
         }
@@ -75,9 +64,8 @@ public function listAction(Request $request, $user, $page)
     public function rssAction($rssId)
     {
         $notificationManager = $this->getNotificationManager();
-        $maxResult = $this->container->getParameter('icap_notification.max_per_page');
         try {
-            $result = $notificationManager->getUserNotificationsListRss($rssId, $maxResult);
+            $result = $notificationManager->getUserNotificationsListRss($rssId);
             $result["systemName"] = $notificationManager->getPlatformName();
         } catch (NoResultException $nre) {
             $result = array("error" => "no_rss_defined");

diff --git a/Controller/NotificationPluginConfigurationController.php b/Controller/NotificationPluginConfigurationController.php
@@ -0,0 +1,74 @@
+<?php
+/**
+ * This file is part of the Claroline Connect package
+ *
+ * (c) Claroline Consortium <[email protected]>
+ *
+ * Author: Panagiotis TSAVDARIS
+ * 
+ * Date: 4/14/15
+ */
+
+namespace Icap\NotificationBundle\Controller;
+
+use Claroline\CoreBundle\Entity\User;
+use Icap\NotificationBundle\Exception\InvalidNotificationFormException;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Component\HttpFoundation\Request;
+
+class NotificationPluginConfigurationController extends Controller
+{
+    /**
+     * @Route("/configuration", name="icap_notification_configuration")
+     * @Template("IcapNotificationBundle:Configuration:config.html.twig")
+     * @Method({"GET"})
+     * @ParamConverter("user", options={"authenticatedUser" = true})
+     * @Security("has_role('ROLE_ADMIN')")
+     */
+    public function getAction(User $user)
+    {
+        $configManager = $this->getNotificationPluginConfigurationManager();
+        $form = $configManager->getForm();
+
+        return array('form' => $form->createView());
+    }
+
+    /**
+     * @Route("/configuration", name="icap_notification_configuration_save")
+     * @Template("IcapNotificationBundle:Configuration:config.html.twig")
+     * @Method({"POST"})
+     * @ParamConverter("user", options={"authenticatedUser" = true})
+     * @Security("has_role('ROLE_ADMIN')")
+     */
+    public function postAction(Request $request, User $user)
+    {
+        $configManager = $this->getNotificationPluginConfigurationManager();
+        try{
+            $form = $configManager->processForm($request);
+            $this->addFlash('success', 'successfully_saved_configuration');
+        } catch (InvalidNotificationFormException $infe) {
+            $form = $infe->getForm();
+            $this->addFlash('error', $infe->getMessage());
+        }
+
+        return array('form' => $form->createView());
+    }
+
+    /**
+     * @return \Icap\NotificationBundle\Manager\NotificationPluginConfigurationManager
+     */
+    private function getNotificationPluginConfigurationManager()
+    {
+        return $this->get('icap.notification.manager.plugin_configuration');
+    }
+
+    private function addFlash($key, $message)
+    {
+        $this->get("session")->getFlashBag()->add($key, $message);
+    }
+} 
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
diff --git a/DependencyInjection/IcapNotificationExtension.php b/DependencyInjection/IcapNotificationExtension.php
@@ -23,13 +23,6 @@ class IcapNotificationExtension extends Extension
      */
     public function load(array $configs, ContainerBuilder $container)
     {
-        $configuration = new Configuration();
-        $config = $this->processConfiguration($configuration, $configs);
-
-        foreach (array('default_layout', 'max_per_page', 'dropdown_items') as $attribute) {
-            $container->setParameter("icap_notification." . $attribute, $config[$attribute]);
-        }
-
         $locator = new FileLocator(__DIR__ . '/../Resources/config/services');
         $loader = new YamlFileLoader($container, $locator);
         $loader->load('services.yml');

diff --git a/Entity/NotificationPluginConfiguration.php b/Entity/NotificationPluginConfiguration.php
@@ -0,0 +1,153 @@
+<?php
+/**
+ * This file is part of the Claroline Connect package
+ *
+ * (c) Claroline Consortium <[email protected]>
+ *
+ * Author: Panagiotis TSAVDARIS
+ * 
+ * Date: 4/13/15
+ */
+
+namespace Icap\NotificationBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Class NotificationPluginConfiguration
+ * @package Icap\NotificationBundle\Entity
+ *
+ * @ORM\Entity()
+ * @ORM\Table(name="icap__notification_plugin_configuration")
+ */
+class NotificationPluginConfiguration
+{
+    /**
+     * @ORM\Id
+     * @ORM\Column(type="integer")
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    protected $id;
+
+    /**
+     * @ORM\Column(type="integer", name="dropdown_items")
+     */
+    protected $dropdownItems = 10;
+
+    /**
+     * @ORM\Column(type="integer", name="max_per_page")
+     */
+    protected $maxPerPage = 50;
+
+    /**
+     * @ORM\Column(type="boolean", name="purge_enabled")
+     */
+    protected $purgeEnabled = true;
+
+    /**
+     * @ORM\Column(type="integer", name="purge_after_days")
+     */
+    protected $purgeAfterDays = 60;
+
+    /**
+     * @ORM\Column(type="datetime", name="last_purge_date", nullable=true)
+     */
+    protected $lastPurgeDate;
+
+    /**
+     * @return mixed
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getDropdownItems()
+    {
+        return $this->dropdownItems;
+    }
+
+    /**
+     * @param $dropdownItems
+     * @return $this
+     */
+    public function setDropdownItems($dropdownItems)
+    {
+        $this->dropdownItems = $dropdownItems;
+
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getMaxPerPage()
+    {
+        return $this->maxPerPage;
+    }
+
+    /**
+     * @param mixed $maxPerPage
+     * @return $this
+     */
+    public function setMaxPerPage($maxPerPage)
+    {
+        $this->maxPerPage = $maxPerPage;
+
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getPurgeEnabled()
+    {
+        return $this->purgeEnabled;
+    }
+
+    /**
+     * @param mixed $purgeEnabled
+     * @return $this
+     */
+    public function setPurgeEnabled($purgeEnabled)
+    {
+        $this->purgeEnabled = $purgeEnabled;
+
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getPurgeAfterDays()
+    {
+        return $this->purgeAfterDays;
+    }
+
+    /**
+     * @param mixed $purgeAfterDays
+     */
+    public function setPurgeAfterDays($purgeAfterDays)
+    {
+        $this->purgeAfterDays = $purgeAfterDays;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getLastPurgeDate()
+    {
+        return $this->lastPurgeDate;
+    }
+
+    /**
+     * @param mixed $lastPurgeDate
+     */
+    public function setLastPurgeDate($lastPurgeDate)
+    {
+        $this->lastPurgeDate = $lastPurgeDate;
+    }
+}
diff --git a/Exception/InvalidNotificationFormException.php b/Exception/InvalidNotificationFormException.php
@@ -0,0 +1,32 @@
+<?php
+/**
+ * This file is part of the Claroline Connect package
+ *
+ * (c) Claroline Consortium <[email protected]>
+ *
+ * Author: Panagiotis TSAVDARIS
+ * 
+ * Date: 4/14/15
+ */
+
+namespace Icap\NotificationBundle\Exception;
+
+
+class InvalidNotificationFormException extends \RuntimeException
+{
+    protected $form;
+
+    public function __construct($message, $form = null)
+    {
+        parent::__construct($message);
+        $this->form = $form;
+    }
+
+    /**
+     * @return array|null
+     */
+    public function getForm()
+    {
+        return $this->form;
+    }
+}