src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php

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