Evolution #163: Evenements: Prise en comptes des autres facteurs

app/Resources/translations/users.fr.yml

     no:                         Pas de nouveaux commentaires sur vos partages
     one:                        %count% nouveaux commentaire sur un de vos partages
     yes:                        %count% nouveaux commentaires sur vos partages
+  new_favoriteds:
+    no:                         Pas de nouveaux partages mis en favoris
+    one:                        %count% de vos partage a été mis en favoris
+    yes:                        %count% de vos partages ont été mis en favoris
     
 reputation:
   bar:

app/Resources/translations/userui.fr.yml

   mytags:  Tous mes tags
   network_all:   Réseau global
   network_my:    Mon réseau
-  new_comments:   Nvx commentaires
+  new_comments:     Nvx commentaires
+  new_favoriteds:   Nvx favoris
   
 element_add:
   url:

src/Muzich/CoreBundle/Actions/User/Event.php

 
 use Muzich\CoreBundle\Entity\User;
 use Muzich\CoreBundle\Entity\Event as EventEntity;
+use Symfony\Component\DependencyInjection\Container;
 
 /**
  * Refactorisation d'actions lié aux événement de l'utilisateur
    */
   protected $user;
   protected $event;
+  protected $new = false;
+  protected $container;
   
-  public function __construct(User $user, EventEntity $event)
+  /**
+   *
+   * @param User $user L'utilisateur concerné par l'événement
+   * @param Container $container 
+   */
+  public function __construct(User $user, Container $container)
   {
     $this->user = $user;
-    $this->event = $event;
+    $this->container = $container;
+  }
+  
+  /**
+   * Cette méthode récupére (si elle existe) en base l'objet Event
+   * correspondant a cet événement.
+   * 
+   * @param string $type 
+   */
+  protected function initialize($type)
+  {
+    $em = $this->container->get('doctrine')->getEntityManager();
+    try
+    {
+      $this->event = $em->createQuery(
+        'SELECT e FROM MuzichCoreBundle:Event e
+        WHERE e.user = :uid AND e.type = :type'
+      )->setParameters(array(
+        'uid'  => $this->user->getId(),
+        'type' => $type
+      ))->getSingleResult()
+      ;
+      $this->new = false;
+    } 
+    catch (\Doctrine\ORM\NoResultException $e)
+    {
+      $this->event = new EventEntity();
+      $this->new = true;
+    }
+  }
+  
+  /**
+   * Procéde a l'ajout de l'événement a la liste de l'utilisateur.
+   * 
+   * @param string $type
+   * @param int $element_id
+   * @return Event 
+   */
+  public function proceed($type, $element_id)
+  {
+    $this->initialize($type);
+    if ($this->new)
+    {
+      $this->initEvent($type, $element_id);
+    }
+    else
+    {
+      $this->updateEvent($element_id);
+    }
+    
+    return $this->event;
   }
   
-  /*
-   * Mise a jour de l'objet Eevnt
+  /**
+   * 
+   * 
+   * @param int $element_id 
    */
-  public function updateEvent($element_id)
+  protected function updateEvent($element_id)
   {
     $this->event->addId($element_id);
   }
    * @param string $type
    * @param int $element_id 
    */
-  public function createEvent($type, $element_id)
+  protected function initEvent($type, $element_id)
   {
     $this->event->addId($element_id);
     $this->event->setType($type);

src/Muzich/CoreBundle/Controller/CoreController.php

             'network_public'   => $search_object->isNetworkPublic(),
             'elements'         => $search_object->getElements($this->getDoctrine(), $this->getUserId()),
             'more_count'       => $this->container->getParameter('search_default_count')*2,
-            'display_comments' => false
+            'ids_display'      => $search_object->getIdsDisplay()
           ));
         }
         else
             'add_form_name' => (isset($add_form)) ? 'add' : null,
             'more_count'    => null,
             'more_route'    => 'show_group_more',
-            'display_comments' => false
+            'ids_display'   => $search_object->getIdsDisplay()
           ));
         }
 

src/Muzich/CoreBundle/Entity/Event.php

 {
   
   const TYPE_COMMENT_ADDED_ELEMENT = "com.adde.ele";
+  const TYPE_FAV_ADDED_ELEMENT     = "fav.adde.ele";
   
   /**
    * @ORM\Id

src/Muzich/CoreBundle/Extension/MyTwigExtension.php

       case 'TYPE_COMMENT_ADDED_ELEMENT':
         return \Muzich\CoreBundle\Entity\Event::TYPE_COMMENT_ADDED_ELEMENT;
       break;
+      case 'TYPE_FAV_ADDED_ELEMENT':
+        return \Muzich\CoreBundle\Entity\Event::TYPE_FAV_ADDED_ELEMENT;
+      break;
+      default:
+        throw new \Exception('Constante non géré dans MyTwigExtension::event_const');
+      break;
     }
     return null;
   }

src/Muzich/CoreBundle/Propagator/EventElement.php

    */
   public function commentAdded(Element $element)
   {
-    $em = $this->container->get('doctrine')->getEntityManager();
-    
-    try
-    {
-      $event = $em->createQuery(
-        'SELECT e FROM MuzichCoreBundle:Event e
-        WHERE e.user = :uid AND e.type = :type'
-      )->setParameters(array(
-        'uid' => $element->getOwner()->getId(),
-        'type' => Event::TYPE_COMMENT_ADDED_ELEMENT
-      ))->getSingleResult()
-      ;
-      $new = false;
-    } 
-    catch (\Doctrine\ORM\NoResultException $e)
-    {
-      $event = new Event();
-      $new = true;
-    }
-    
-    $uea = new UserEventAction($element->getOwner(), $event);
-    if ($new)
-    {
-      $uea->createEvent(
-        Event::TYPE_COMMENT_ADDED_ELEMENT,
-        $element->getId()
-      );
-    }
-    else
-    {
-      $uea->updateEvent($element->getId());
-    }
-    
-    $em->persist($event);
+    $uea = new UserEventAction($element->getOwner(), $this->container);
+    $event = $uea->proceed(Event::TYPE_COMMENT_ADDED_ELEMENT, $element->getId());
+    $this->container->get('doctrine')->getEntityManager()->persist($event);
   }
   
   /**
     $ur->addPoints(
       $this->container->getParameter('reputation_element_favorite_value')
     );
+    
+    $uea = new UserEventAction($element->getOwner(), $this->container);
+    $event = $uea->proceed(Event::TYPE_FAV_ADDED_ELEMENT, $element->getId());
+    $this->container->get('doctrine')->getEntityManager()->persist($event);
   }
   
   /**

src/Muzich/CoreBundle/Resources/views/SearchElement/form.html.twig

       {{ form_widget(search_form.network, { 'attr': {'style': 'display: none;'} }) }}
     </div>
     
-    <a href="#" class="button all_network {% if network_public and not display_comments %}active{% endif %}">
+    <a href="#" class="button all_network {% if network_public and not ids_display %}active{% endif %}">
       {{ 'filter.network_all'|trans({}, 'userui') }}
     </a>
-    <a href="#" class="button my_network {% if not network_public and not display_comments %}active{% endif %}">
+    <a href="#" class="button my_network {% if not network_public and not ids_display %}active{% endif %}">
       {{ 'filter.network_my'|trans({}, 'userui') }}
     </a>
       
   </div>
 
   <div class="more_filters">
-    <a href="{{ path('ajax_filter_remove_ids') }}" class="button active new_comments" style="{% if not display_comments %}display: none;{% endif %}">
+    <a href="{{ path('ajax_filter_remove_ids') }}" class="button active new_comments" 
+       style="{% if ids_display != event_const('TYPE_COMMENT_ADDED_ELEMENT') %}display: none;{% endif %}"
+    >
       {{ 'filter.new_comments'|trans({}, 'userui') }}
       <img src="{{ asset('bundles/muzichcore/img/1328276855_list-remove.png') }}" alt="remove" />
     </a>
+    <a href="{{ path('ajax_filter_remove_ids') }}" class="button active new_favorites" 
+       style="{% if ids_display != event_const('TYPE_FAV_ADDED_ELEMENT') %}display: none;{% endif %}"
+    >
+      {{ 'filter.new_favoriteds'|trans({}, 'userui') }}
+      <img src="{{ asset('bundles/muzichcore/img/1328276855_list-remove.png') }}" alt="remove" />
+    </a>
   </div>
   
   {% include "MuzichCoreBundle:Tag:tagsPrompt.html.twig" with { 

src/Muzich/CoreBundle/Searcher/ElementSearcher.php

   protected $ids;
   
   /**
+   * On stocke la dedans le bouton a afficher dans le gestionnaire de filtres
+   * correspondant aux ids filtrés. La valeur doit correspondre a une constante
+   * de l'Entité metier Event.
+   * 
+   * @var string 
+   */
+  protected $ids_display;
+  
+  /**
    * @see SearcherInterface
    * @param array $params 
    */
     
     // Mise a jour des attributs
     $this->setAttributes(array(
-      'network', 'tags', 'count', 'user_id', 'group_id', 'favorite', 'id_limit', 'searchnew', 'ids'
+      'network', 'tags', 'count', 'user_id', 'group_id', 'favorite', 'id_limit', 'searchnew', 'ids', 'ids_display'
     ), $params);
     
   }
   {
     // Mise a jour des attributs
     $this->setAttributes(array(
-      'network', 'tags', 'count', 'user_id', 'group_id', 'favorite', 'id_limit', 'searchnew', 'ids'
+      'network', 'tags', 'count', 'user_id', 'group_id', 'favorite', 'id_limit', 'searchnew', 'ids', 'ids_display'
     ), $params);
   }
   
   public function getParams($tags_string = false)
   {
     return array(
-      'network'  => $this->getNetwork(),
-      'tags'     => $this->getTags($tags_string),
-      'count'    => $this->getCount(),
-      'user_id'  => $this->getUserId(),
-      'group_id' => $this->getGroupId(),
-      'favorite' => $this->isFavorite(),
-      'ids'      => $this->getIds()
+      'network'     => $this->getNetwork(),
+      'tags'        => $this->getTags($tags_string),
+      'count'       => $this->getCount(),
+      'user_id'     => $this->getUserId(),
+      'group_id'    => $this->getGroupId(),
+      'favorite'    => $this->isFavorite(),
+      'ids'         => $this->getIds(),
+      'ids_display' => $this->getIdsDisplay()
     );
   }
   
     }
     return false;
   }
+  
+  public function setIdsDisplay($display)
+  {
+    $this->ids_display = $display;
+  }
+  
+  public function getIdsDisplay()
+  {
+    return $this->ids_display;
+  }
 
   /**
    * Construction de l'objet Query

src/Muzich/CoreBundle/Tests/Controller/EventTest.php

     
   }
   
+  public function testFavoriteAdded()
+  {
+    $this->client = self::createClient();
+    $this->connectUser('paul', 'toor');
+    
+    $paul = $this->getUser();
+    $bux = $this->getUser('bux');
+    
+    // Actuellement il n'y a aucun event d'ouvert pour bux (fixtures)
+    $result = $this->getDoctrine()->getEntityManager()
+      ->createQuery('SELECT e FROM MuzichCoreBundle:Event e
+        WHERE e.user = :uid'
+      )
+      ->setParameter('uid', $bux->getId())
+      ->getArrayResult()
+    ;
+    $this->assertEquals(count($result), 0);
+    
+    $element = $this->getDoctrine()->getRepository('MuzichCoreBundle:Element')
+      ->findOneByName('Ed Cox - La fanfare des teuffeurs (Hardcordian)')
+    ;
+        
+    // Ajout d'un élément en favoris
+    // Il ajoute cet élément en favoris
+    $url = $this->generateUrl('favorite_add', array(
+      'id'    => $element->getId(),
+      'token' => $paul->getPersonalHash()
+    ));
+    
+    $crawler = $this->client->request('GET', $url, array(), array(), array(
+        'HTTP_X-Requested-With' => 'XMLHttpRequest',
+    ));
+    
+    $this->isResponseSuccess();
+    
+    // On contrôle la présence du favoris
+    $fav = $this->getDoctrine()->getRepository('MuzichCoreBundle:UsersElementsFavorites')
+      ->findOneBy(array(
+        'user'    => $paul->getId(),
+        'element' => $element->getId()
+      ));
+    
+    $this->assertTrue(!is_null($fav));
+    
+    // bux a maintenant un event en base
+    $result = $this->getDoctrine()->getEntityManager()
+      ->createQuery('
+        SELECT e FROM MuzichCoreBundle:Event e
+        WHERE e.user = :uid'
+      )
+      ->setParameter('uid', $bux->getId())
+      ->getArrayResult()
+    ;
+    $this->assertEquals(count($result), 1);
+    $this->assertEquals($result[0]['type'], Event::TYPE_FAV_ADDED_ELEMENT);
+    $this->assertEquals($result[0]['count'], 1);
+    $this->assertEquals($result[0]['ids'], json_encode(array((string)$element->getId())));
+    
+    // On enlève des favoris
+    $url = $this->generateUrl('favorite_remove', array(
+      'id'    => $element->getId(),
+      'token' => $paul->getPersonalHash()
+    ));
+    
+    $crawler = $this->client->request('GET', $url, array(), array(), array(
+        'HTTP_X-Requested-With' => 'XMLHttpRequest',
+    ));
+    
+    // On contrôle l'absence du favoris
+    $fav = $this->getDoctrine()->getRepository('MuzichCoreBundle:UsersElementsFavorites')
+      ->findOneBy(array(
+        'user'    => $paul->getId(),
+        'element' => $element->getId()
+      ));
+    
+    $this->assertTrue(is_null($fav));
+    
+    // bux a toujours qu'un event avec un seul element signalé.
+    $result = $this->getDoctrine()->getEntityManager()
+      ->createQuery('
+        SELECT e FROM MuzichCoreBundle:Event e
+        WHERE e.user = :uid'
+      )
+      ->setParameter('uid', $bux->getId())
+      ->getArrayResult()
+    ;
+    $this->assertEquals(count($result), 1);
+    $this->assertEquals($result[0]['type'], Event::TYPE_FAV_ADDED_ELEMENT);
+    $this->assertEquals($result[0]['count'], 1);
+    $this->assertEquals($result[0]['ids'], json_encode(array((string)$element->getId())));
+    
+    // Pour le moment pas de tests supplémentaire comme mettre de nouveaux favoris 
+    // ou consulter la liste des éléments concernés. Il faudrait coder ces test certe.
+    // Mais la refactorisation du code fait qu'il n'y a que le type (Event) de diféfrent.
+    // donc a coder (tests) mais pas urgent a l'isntant.
+  }
+  
 }

src/Muzich/CoreBundle/Tests/Searcher/ElementSearcherTest.php

         'user_id'   => 185, 
         'group_id'  => null, 
         'favorite'  => false,
-        'ids'       => null
+        'ids'       => null,
+        'ids_display' => null
     ));
 
     $this->assertEquals($ia, $es->getParams());
         'user_id'   => 115, 
         'group_id'  => null, 
         'favorite'  => false,
-        'ids'       => null
+        'ids'       => null,
+        'ids_display' => null
     ));
 
     $this->assertEquals($ua, $es->getParams());

src/Muzich/HomeBundle/Controller/HomeController.php

     
     return array(
       'search_tags_id'   => $search_object->getTags(),
-      'display_comments' => $search_object->hasIds(),
+      'ids_display'      => $search_object->getIdsDisplay(),
       'user'             => $this->getUser(),
       'add_form'         => $add_form->createView(),
       'add_form_name'    => 'add',

src/Muzich/UserBundle/Controller/EventController.php

     
     $es = $this->getElementSearcher();
     $es->setIds($event->getIds());
+    $es->setIdsDisplay($event->getType());
     $this->setElementSearcherParams($es->getParams());
     $this->getDoctrine()->getEntityManager()->remove($event);
     $this->getDoctrine()->getEntityManager()->flush();

src/Muzich/UserBundle/Resources/views/Info/bar.html.twig

           <img title="{{ 'events.new_comments.no'|trans({}, 'users') }}" src="{{ asset('bundles/muzichcore/img/1332286007_comments_reply.png') }}" alt="comments" />
           <span class="new_comments">0</span>
         {% endif %}
+          
+    </div>
+    
+    <div class="favorites">
+      
+        {% if events[event_const('TYPE_FAV_ADDED_ELEMENT')] is defined %}
+          <a 
+            href="{{ path('event_view_elements', {'event_id':events[event_const('TYPE_FAV_ADDED_ELEMENT')].id}) }}" 
+            title="{%if events[event_const('TYPE_FAV_ADDED_ELEMENT')].count == 1 %}{{ 'events.new_favoriteds.one'|trans({'%count%':1}, 'users') }}{% else %}{{ 'events.new_favoriteds.yes'|trans({'%count%':events[event_const('TYPE_FAV_ADDED_ELEMENT')].count}, 'users') }}{% endif %}"
+            class="view_elements_event"
+          >
+            <img src="{{ asset('bundles/muzichcore/img/favorite.png') }}" alt="favoriteds" />
+            <span class="new_comments">{{ events[event_const('TYPE_FAV_ADDED_ELEMENT')].count }}</span>
+          </a>
+        {% else %}
+          <img title="{{ 'events.new_favoriteds.no'|trans({}, 'users') }}" src="{{ asset('bundles/muzichcore/img/favorite_bw.png') }}" alt="favoriteds" />
+          <span class="new_comments">0</span>
+        {% endif %}
+          
     </div>
   
   </div>

web/bundles/muzichcore/css/main.css

 {
   font-weight: bold;
   margin-left: 5px;
+}
+
+div#events div.favorites img
+{
+  margin-left: 3px;
+  margin-bottom: -2px;
+}
+
+div#events div.favorites span
+{
+  font-weight: bold;
+  margin-left: 5px;
 }

web/bundles/muzichcore/js/muzich.js

   
   
   // Enlever les ids du ElementSearch
-  $('div.more_filters a.new_comments').live('click', function(){
+  $('div.more_filters a.new_comments, div.more_filters a.new_favorites').live('click', function(){
     
     $('img.elements_more_loader').show();
     $('ul.elements').html('');
       {
         $('form[name="search"]').submit();
         $('div.more_filters a.new_comments').hide();
+        $('div.more_filters a.new_favorites').hide();
       }
       
     });

web/bundles/muzichhome/css/home.css

   background-position: 2px 3px;
 }
 
-div.more_filters a.new_comments img
+div.more_filters a.new_favorites
+{
+  margin-top: 5px;
+  padding-left: 20px;
+  background-image: url(/bundles/muzichcore/img/favorite.png);
+  background-repeat: no-repeat;
+  background-position: 2px 3px;
+}
+
+div.more_filters a.new_comments img, div.more_filters a.new_favorites img
 {
   margin-bottom: -3px;
 }