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\TagRepository;
  10 use Wallabag\UserBundle\Entity\User;
  11
  12 class RuleBasedTagger
  13 {
  14     private $rulerz;
  15     private $tagRepository;
  16
  17     public function __construct(RulerZ $rulerz, TagRepository $tagRepository)
  18     {
  19         $this->rulerz        = $rulerz;
  20         $this->tagRepository = $tagRepository;
  21     }
  22
  23     /**
  24      * Add tags from rules defined by the user.
  25      *
  26      * @param Entry $entry Entry to tag.
  27      */
  28     public function tag(Entry $entry)
  29     {
  30         $rules = $this->getRulesForUser($entry->getUser());
  31
  32         foreach ($rules as $rule) {
  33             if (!$this->rulerz->satisfies($entry, $rule->getRule())) {
  34                 continue;
  35             }
  36
  37             foreach ($rule->getTags() as $label) {
  38                 $tag = $this->getTag($entry->getUser(), $label);
  39
  40                 $entry->addTag($tag);
  41             }
  42         }
  43     }
  44
  45     /**
  46      * Fetch a tag for a user.
  47      *
  48      * @param User   $user
  49      * @param string $label The tag's label.
  50      *
  51      * @return Tag
  52      */
  53     private function getTag(User $user, $label)
  54     {
  55         $tag = $this->tagRepository->findOneByLabelAndUserId($label, $user->getId());
  56
  57         if (!$tag) {
  58             $tag = new Tag($user);
  59             $tag->setLabel($label);
  60         }
  61
  62         return $tag;
  63     }
  64
  65     /**
  66      * Retrieves the tagging rules for a given user.
  67      *
  68      * @param User $user
  69      *
  70      * @return array<TaggingRule>
  71      */
  72     private function getRulesForUser(User $user)
  73     {
  74         return $user->getConfig()->getTaggingRules();
  75     }
  76 }