Feature/manage view references with redis

.travis.yml

@@ -5,6 +5,9 @@ language: php
 php:
   - 5.6
 
+services:
+  - redis-server
+
 before_script:
   - phpenv config-add travis.php.ini
   - npm install less

Bundle/AnalyticsBundle/Helper/AnalyticsViewHelper.php

@@ -5,22 +5,29 @@
 use Doctrine\ORM\EntityManager;
 use Victoire\Bundle\BlogBundle\Entity\Article;
 use Victoire\Bundle\PageBundle\Helper\PageHelper;
-use Victoire\Bundle\ViewReferenceBundle\Cache\Xml\ViewReferenceXmlCacheRepository;
+use Victoire\Bundle\ViewReferenceBundle\Connector\ViewReferenceRepository;
 
 /**
  * Analytics View helper
  * ref: victoire_analytics.view_helper.
  */
 class AnalyticsViewHelper
 {
-    protected $viewCacheRepository;
+    protected $viewReferenceRepository;
     protected $entityManager;
     protected $pageHelper;
 
-    public function __construct(ViewReferenceXmlCacheRepository $viewCacheRepository, EntityManager $entityManager, PageHelper $pageHelper)
+    /**
+     * AnalyticsViewHelper constructor.
+     *
+     * @param ViewReferenceRepository $viewReferenceRepository
+     * @param EntityManager           $entityManager
+     * @param PageHelper              $pageHelper
+     */
+    public function __construct(ViewReferenceRepository $viewReferenceRepository, EntityManager $entityManager, PageHelper $pageHelper)
     {
         $this->entityManager = $entityManager;
-        $this->viewCacheRepository = $viewCacheRepository;
+        $this->viewReferenceRepository = $viewReferenceRepository;
         $this->pageHelper = $pageHelper;
     }
 
@@ -40,7 +47,7 @@ public function getMostReadByViewType($viewNamespace, $number)
                 $repo = $this->entityManager->getRepository($viewNamespace);
                 //get pages and viewReferenceIds
                 foreach ($repo->getAll()->run() as $key => $page) {
-                    $viewReference = $this->viewCacheRepository->getOneReferenceByParameters(
+                    $viewReference = $this->viewReferenceRepository->getOneReferenceByParameters(
                         [
                             'viewNamespace' => $viewNamespace,
                             'viewId'        => $page->getId(),
@@ -63,7 +70,7 @@ public function getMostReadByViewType($viewNamespace, $number)
                 break;
 
             default:
-                # code...
+                // code...
                 break;
         }
 
@@ -85,7 +92,7 @@ public function getMostReadArticlesByBlog($blog, $number, $excludeUnpublished =
                     ->run();
 
         foreach ($articles as $key => $article) {
-            if ($viewReference = $this->viewCacheRepository->getOneReferenceByParameters(
+            if ($viewReference = $this->viewReferenceRepository->getOneReferenceByParameters(
                 [
                     'entityNamespace' => 'Victoire\Bundle\BlogBundle\Entity\Article',
                     'entityId'        => $article->getId(),

Bundle/AnalyticsBundle/Resources/config/services.yml

@@ -13,6 +13,6 @@ services:
     victoire_analytics.view_helper:
         class: %victoire_analytics_view_helper_class%
         arguments:
-            - @victoire_view_reference.cache.repository
+            - @victoire_view_reference.repository
             - @doctrine.orm.entity_manager
             - @victoire_page.page_helper

Bundle/BlogBundle/Builder/BlogReferenceBuilder.php

@@ -23,6 +23,9 @@ public function buildReference(View $view, EntityManager $em)
         $viewReference->setViewId($view->getId());
         $viewReference->setSlug($view->getSlug());
         $viewReference->setViewNamespace($em->getClassMetadata(get_class($view))->name);
+        if ($parent = $view->getParent()) {
+            $viewReference->setParent(ViewReferenceHelper::generateViewReferenceId($parent));
+        }
 
         return $viewReference;
     }

Bundle/BlogBundle/Controller/ArticleController.php

@@ -213,7 +213,7 @@ public function deleteAction(Article $article)
             ]
         );
 
-        $blogViewReference = $this->container->get('victoire_view_reference.cache.repository')->getOneReferenceByParameters(
+        $blogViewReference = $this->container->get('victoire_view_reference.repository')->getOneReferenceByParameters(
             [
                 'viewId' => $article->getBlog()->getId(),
             ]

Bundle/BlogBundle/Controller/BlogController.php

@@ -130,7 +130,7 @@ public function settingsAction(Request $request, BasePage $blog)
             $entityManager->flush();
 
             /** @var ViewReference $reference */
-            $reference = $this->container->get('victoire_view_reference.cache.repository')
+            $reference = $this->get('victoire_view_reference.repository')
             ->getOneReferenceByParameters(['viewId' => $blog->getId()]);
 
             return new JsonResponse([

Bundle/BusinessEntityBundle/EventSubscriber/BusinessEntitySubscriber.php

@@ -6,31 +6,39 @@
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Event\LifecycleEventArgs;
 use Doctrine\ORM\UnitOfWork;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity;
 use Victoire\Bundle\BusinessEntityBundle\Helper\BusinessEntityHelper;
 use Victoire\Bundle\BusinessPageBundle\Builder\BusinessPageBuilder;
 use Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage;
+use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
 use Victoire\Bundle\BusinessPageBundle\Helper\BusinessPageHelper;
 use Victoire\Bundle\BusinessPageBundle\Repository\BusinessPageRepository;
+use Victoire\Bundle\ViewReferenceBundle\Event\ViewReferenceEvent;
+use Victoire\Bundle\ViewReferenceBundle\ViewReferenceEvents;
 
 class BusinessEntitySubscriber implements EventSubscriber
 {
     protected $viewCacheManager;
     protected $viewCacheDriver;
     protected $businessPageBuilder;
+    protected $dispatcher;
 
     /**
-     * @param BusinessPageBuilder  $businessPageBuilder
-     * @param BusinessEntityHelper $businessEntityHelper
-     * @param BusinessPageHelper   $businessPageHelper
+     * @param BusinessPageBuilder      $businessPageBuilder
+     * @param BusinessEntityHelper     $businessEntityHelper
+     * @param BusinessPageHelper       $businessPageHelper
+     * @param EventDispatcherInterface $dispatcher
      */
     public function __construct(BusinessPageBuilder          $businessPageBuilder,
                                 BusinessEntityHelper         $businessEntityHelper,
-                                BusinessPageHelper           $businessPageHelper
+                                BusinessPageHelper           $businessPageHelper,
+                                EventDispatcherInterface     $dispatcher
     ) {
         $this->businessPageBuilder = $businessPageBuilder;
         $this->businessEntityHelper = $businessEntityHelper;
         $this->businessPageHelper = $businessPageHelper;
+        $this->dispatcher = $dispatcher;
     }
 
     /**
@@ -42,6 +50,8 @@ public function getSubscribedEvents()
     {
         return [
             'postUpdate',
+            'postPersist',
+            'preRemove',
         ];
     }
 
@@ -66,6 +76,15 @@ public function postUpdate(LifecycleEventArgs $eventArgs)
                 );
             }
         }
+        $this->updateViewReference($eventArgs);
+    }
+
+    /**
+     * @param LifecycleEventArgs $eventArgs
+     */
+    public function postPersist(LifecycleEventArgs $eventArgs)
+    {
+        $this->updateViewReference($eventArgs);
     }
 
     /**
@@ -130,4 +149,122 @@ public function updateBusinessPages($entity, BusinessEntity $businessEntity, Ent
             }
         }
     }
+
+    /**
+     * This method throw an event if needed for a view related to a businessEntity.
+     *
+     * @param LifecycleEventArgs $eventArgs
+     *
+     * @throws \Exception
+     */
+    private function updateViewReference(LifecycleEventArgs $eventArgs)
+    {
+        $entity = $eventArgs->getEntity();
+        //if it's a businessEntity we need to rebuild virtuals (BPs are rebuild in businessEntitySubscriber)
+        if ($businessEntity = $this->businessEntityHelper->findByEntityInstance($entity)) {
+            $em = $eventArgs->getEntityManager();
+            //find all BT that can represent the businessEntity
+            $businessTemplates = $em->getRepository('VictoireBusinessPageBundle:BusinessTemplate')->findPagePatternByBusinessEntity($businessEntity);
+            foreach ($businessTemplates as $businessTemplate) {
+                if ($page = $em->getRepository('Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage')->findPageByBusinessEntityAndPattern($businessTemplate, $entity, $businessEntity)) {
+                    //if it's a BP we update the BP
+                    $this->businessPageBuilder->updatePageParametersByEntity($page, $entity);
+                } else {
+                    $page = $this->businessPageBuilder->generateEntityPageFromTemplate(
+                        $businessTemplate,
+                        $entity,
+                        $em
+                    );
+                }
+                //update the reference
+                $event = new ViewReferenceEvent($page);
+                $this->dispatcher->dispatch(ViewReferenceEvents::UPDATE_VIEW_REFERENCE, $event);
+            }
+        }
+        //if it a businessTemplate we have to rebuild virtuals or update BP
+        if ($entity instanceof BusinessTemplate) {
+            $em = $eventArgs->getEntityManager();
+            $businessEntityId = $entity->getBusinessEntityId();
+            $businessEntity = $this->businessEntityHelper->findById($businessEntityId);
+            //find all entities
+            $entities = $this->businessPageHelper->getEntitiesAllowed($entity, $em);
+            foreach ($entities as $be) {
+                if ($page = $em->getRepository('Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage')->findPageByBusinessEntityAndPattern($entity, $be, $businessEntity)) {
+                    //rebuild page if its a BP
+                    $this->businessPageBuilder->updatePageParametersByEntity($page, $be);
+                } else {
+                    $page = $this->businessPageBuilder->generateEntityPageFromTemplate(
+                        $entity,
+                        $be,
+                        $em
+                    );
+                }
+                // update reference
+                $event = new ViewReferenceEvent($page);
+                $this->dispatcher->dispatch(ViewReferenceEvents::UPDATE_VIEW_REFERENCE, $event);
+            }
+        }
+    }
+
+    /**
+     * @param LifecycleEventArgs $eventArgs
+     *
+     * @throws \Exception
+     */
+    public function preRemove(LifecycleEventArgs $eventArgs)
+    {
+        $entity = $eventArgs->getEntity();
+
+        //if we remove a BP we need to remplace by a VBP ref
+        if ($entity instanceof BusinessPage) {
+            //remove BP ref
+            $event = new ViewReferenceEvent($entity);
+            $this->dispatcher->dispatch(ViewReferenceEvents::REMOVE_VIEW_REFERENCE, $event);
+            $em = $eventArgs->getEntityManager();
+            $businessTemplate = $entity->getTemplate();
+            $page = $this->businessPageBuilder->generateEntityPageFromTemplate(
+                $businessTemplate,
+                $entity->getBusinessEntity(),
+                $em
+            );
+            //create VBP ref
+            //TODO :: dont rebuild if businessEntity or businessTemplate doesn't exist
+            $event = new ViewReferenceEvent($page);
+            $this->dispatcher->dispatch(ViewReferenceEvents::UPDATE_VIEW_REFERENCE, $event);
+        }
+
+        //if it's a businessEntity, we need to remove all BP and VBP ref
+        if ($businessEntity = $this->businessEntityHelper->findByEntityInstance($entity)) {
+            $em = $eventArgs->getEntityManager();
+            $businessTemplates = $em->getRepository('VictoireBusinessPageBundle:BusinessTemplate')->findPagePatternByBusinessEntity($businessEntity);
+            foreach ($businessTemplates as $businessTemplate) {
+                if ($page = $em->getRepository('Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage')->findPageByBusinessEntityAndPattern($businessTemplate, $entity, $businessEntity)) {
+                    $event = new ViewReferenceEvent($page);
+                    $this->dispatcher->dispatch(ViewReferenceEvents::REMOVE_VIEW_REFERENCE, $event);
+                } else {
+                    $page = $this->businessPageBuilder->generateEntityPageFromTemplate(
+                        $businessTemplate,
+                        $entity,
+                        $em
+                    );
+                    $event = new ViewReferenceEvent($page);
+                    $this->dispatcher->dispatch(ViewReferenceEvents::REMOVE_VIEW_REFERENCE, $event);
+                }
+            }
+        }
+        //if we remove a businessTemplate remove all VBT ref (BP cascade remove)
+        if ($entity instanceof BusinessTemplate) {
+            $em = $eventArgs->getEntityManager();
+            $entities = $this->businessPageHelper->getEntitiesAllowed($entity, $em);
+            foreach ($entities as $be) {
+                $page = $this->businessPageBuilder->generateEntityPageFromTemplate(
+                    $entity,
+                    $be,
+                    $em
+                );
+                $event = new ViewReferenceEvent($page);
+                $this->dispatcher->dispatch(ViewReferenceEvents::REMOVE_VIEW_REFERENCE, $event);
+            }
+        }
+    }
 }

Bundle/BusinessEntityBundle/Resources/config/services.yml

@@ -18,6 +18,7 @@ services:
             - @victoire_business_page.business_page_builder
             - @victoire_core.helper.business_entity_helper
             - @victoire_business_page.business_page_helper
+            - @event_dispatcher
         tags:
             - { name: doctrine.event_subscriber, connection: default }
 

Bundle/BusinessPageBundle/Builder/BusinessPageBuilder.php

@@ -51,7 +51,9 @@ public function __construct(BusinessEntityHelper $businessEntityHelper, UrlBuild
      * Generate update the page parameters with the entity.
      *
      * @param BusinessTemplate $businessTemplate
-     * @param BusinessEntity   $entity
+     * @param entity           $entity
+     *
+     * @return VirtualBusinessPage
      */
     public function generateEntityPageFromTemplate(BusinessTemplate $businessTemplate, $entity, EntityManager $em)
     {
@@ -72,6 +74,7 @@ public function generateEntityPageFromTemplate(BusinessTemplate $businessTemplat
         }
 
         //find Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity object according to the given $entity
+
         $businessEntity = $this->businessEntityHelper->findByEntityInstance($entity);
 
         if ($businessEntity !== null) {

Bundle/BusinessPageBundle/Builder/BusinessPageReferenceBuilder.php

@@ -38,6 +38,9 @@ public function buildReference(View $businessPage, EntityManager $em)
         $businessPageReference->setEntityId($businessPage->getBusinessEntity()->getId());
         $businessPageReference->setEntityNamespace($em->getClassMetadata(get_class($businessPage->getBusinessEntity()))->name);
         $businessPageReference->setViewNamespace($em->getClassMetadata(get_class($businessPage))->name);
+        if ($parent = $businessPage->getParent()) {
+            $businessPageReference->setParent(ViewReferenceHelper::generateViewReferenceId($parent));
+        }
 
         return $businessPageReference;
     }

Bundle/BusinessPageBundle/Entity/BusinessTemplate.php

@@ -27,7 +27,7 @@ class BusinessTemplate extends Template
     protected $seo;
 
     /**
-     * @ORM\OneToMany(targetEntity="\Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage", mappedBy="template")
+     * @ORM\OneToMany(targetEntity="\Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage", mappedBy="template", cascade={"remove"})
      */
     protected $inheritors;
 

Bundle/BusinessPageBundle/Helper/BusinessPageHelper.php

@@ -11,7 +11,7 @@
 use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
 use Victoire\Bundle\CoreBundle\Helper\UrlBuilder;
 use Victoire\Bundle\QueryBundle\Helper\QueryHelper;
-use Victoire\Bundle\ViewReferenceBundle\Cache\Xml\ViewReferenceXmlCacheRepository;
+use Victoire\Bundle\ViewReferenceBundle\Connector\ViewReferenceRepository;
 use Victoire\Bundle\ViewReferenceBundle\ViewReference\BusinessPageReference;
 
 /**
@@ -21,22 +21,22 @@
 class BusinessPageHelper
 {
     protected $queryHelper = null;
-    protected $viewCacheRepository = null;
+    protected $viewReferenceRepository = null;
     protected $businessEntityHelper = null;
     protected $parameterConverter = null;
     protected $urlBuilder = null;
 
     /**
-     * @param QueryHelper                     $queryHelper
-     * @param ViewReferenceXmlCacheRepository $viewCacheRepository
-     * @param BusinessEntityHelper            $businessEntityHelper
-     * @param ParameterConverter              $parameterConverter
-     * @param UrlBuilder                      $urlBuilder
+     * @param QueryHelper             $queryHelper
+     * @param ViewReferenceRepository $viewReferenceRepository
+     * @param BusinessEntityHelper    $businessEntityHelper
+     * @param ParameterConverter      $parameterConverter
+     * @param UrlBuilder              $urlBuilder
      */
-    public function __construct(QueryHelper $queryHelper, ViewReferenceXmlCacheRepository $viewCacheRepository, BusinessEntityHelper $businessEntityHelper, ParameterConverter $parameterConverter, UrlBuilder $urlBuilder)
+    public function __construct(QueryHelper $queryHelper, ViewReferenceRepository $viewReferenceRepository, BusinessEntityHelper $businessEntityHelper, ParameterConverter $parameterConverter, UrlBuilder $urlBuilder)
     {
         $this->queryHelper = $queryHelper;
-        $this->viewCacheRepository = $viewCacheRepository;
+        $this->viewReferenceRepository = $viewReferenceRepository;
         $this->businessEntityHelper = $businessEntityHelper;
         $this->parameterConverter = $parameterConverter;
         $this->urlBuilder = $urlBuilder;
@@ -208,8 +208,7 @@ public function guessBestPatternIdForEntity($refClass, $entityId, $em, $original
                 'entityId'        => $entityId,
                 'entityNamespace' => $originalRefClassName,
             ];
-
-            $viewReference = $this->viewCacheRepository->getOneReferenceByParameters($parameters);
+            $viewReference = $this->viewReferenceRepository->getOneReferenceByParameters($parameters);
         }
 
         if (!$viewReference) {