src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Helper;
   4
   5 use RulerZ\RulerZ;
   6 use Wallabag\CoreBundle\Entity\Entry;
   7 use Wallabag\CoreBundle\Entity\Tag;
   8 use Wallabag\CoreBundle\Repository\EntryRepository;
   9 use Wallabag\CoreBundle\Repository\TagRepository;
  10 use Wallabag\UserBundle\Entity\User;
  11
  12 class RuleBasedTagger
  13 {
  14     private $rulerz;
  15     private $tagRepository;
  16     private $entryRepository;
  17
  18     public function __construct(RulerZ $rulerz, TagRepository $tagRepository, EntryRepository $entryRepository)
  19     {
  20         $this->rulerz = $rulerz;
  21         $this->tagRepository = $tagRepository;
  22         $this->entryRepository = $entryRepository;
  23     }
  24
  25     /**
  26      * Add tags from rules defined by the user.
  27      *
  28      * @param Entry $entry Entry to tag.
  29      */
  30     public function tag(Entry $entry)
  31     {
  32         $rules = $this->getRulesForUser($entry->getUser());
  33
  34         foreach ($rules as $rule) {
  35             if (!$this->rulerz->satisfies($entry, $rule->getRule())) {
  36                 continue;
  37             }
  38
  39             foreach ($rule->getTags() as $label) {
  40                 $tag = $this->getTag($entry->getUser(), $label);
  41
  42                 $entry->addTag($tag);
  43             }
  44         }
  45     }
  46
  47     /**
  48      * Apply all the tagging rules defined by a user on its entries.
  49      *
  50      * @param User $user
  51      *
  52      * @return array<Entry> A list of modified entries.
  53      */
  54     public function tagAllForUser(User $user)
  55     {
  56         $rules = $this->getRulesForUser($user);
  57         $entries = array();
  58
  59         foreach ($rules as $rule) {
  60             $qb = $this->entryRepository->getBuilderForAllByUser($user->getId());
  61             $entries = $this->rulerz->filter($qb, $rule->getRule());
  62
  63             foreach ($entries as $entry) {
  64                 foreach ($rule->getTags() as $label) {
  65                     $tag = $this->getTag($user, $label);
  66
  67                     $entry->addTag($tag);
  68                     $entries[] = $entry;
  69                 }
  70             }
  71         }
  72
  73         return $entries;
  74     }
  75
  76     /**
  77      * Fetch a tag for a user.
  78      *
  79      * @param User   $user
  80      * @param string $label The tag's label.
  81      *
  82      * @return Tag
  83      */
  84     private function getTag(User $user, $label)
  85     {
  86         $tag = $this->tagRepository->findOneByLabelAndUserId($label, $user->getId());
  87
  88         if (!$tag) {
  89             $tag = new Tag($user);
  90             $tag->setLabel($label);
  91         }
  92
  93         return $tag;
  94     }
  95
  96     /**
  97      * Retrieves the tagging rules for a given user.
  98      *
  99      * @param User $user
 100      *
 101      * @return array<TaggingRule>
 102      */
 103     private function getRulesForUser(User $user)
 104     {
 105         return $user->getConfig()->getTaggingRules();
 106     }
 107 }