Use tag for rule constraints and a compiler pass to get them

ptsavdar · Mar 9, 2015 · 5703682 · 5703682
1 parent ff7d107
commit 5703682
Show file tree

Hide file tree

Showing 11 changed files with 113 additions and 73 deletions.
diff --git a/ClarolineCoreBundle.php b/ClarolineCoreBundle.php
@@ -14,6 +14,7 @@
 use Claroline\CoreBundle\DependencyInjection\Compiler\DoctrineEntityListenerPass;
 use Claroline\CoreBundle\DependencyInjection\Compiler\DynamicConfigPass;
 use Claroline\CoreBundle\DependencyInjection\Compiler\ImportersConfigPass;
+use Claroline\CoreBundle\DependencyInjection\Compiler\RuleConstraintsConfigPass;
 use FOS\OAuthServerBundle\FOSOAuthServerBundle;
 use IDCI\Bundle\ExporterBundle\IDCIExporterBundle;
 use Nelmio\ApiDocBundle\NelmioApiDocBundle;
@@ -35,6 +36,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new DynamicConfigPass());
         $container->addCompilerPass(new ImportersConfigPass());
         $container->addCompilerPass(new DoctrineEntityListenerPass());
+        $container->addCompilerPass(new RuleConstraintsConfigPass());
     }
 
     public function supports($environment)

diff --git a/DependencyInjection/Compiler/RuleConstraintsConfigPass.php b/DependencyInjection/Compiler/RuleConstraintsConfigPass.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Claroline Connect package.
+ *
+ * (c) Claroline Consortium <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Claroline\CoreBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class RuleConstraintsConfigPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $ruleValidatorServiceKey = 'claroline.rule.validator';
+
+        if (false === $container->hasDefinition($ruleValidatorServiceKey)) {
+            return;
+        }
+
+        $ruleValidator = $container->getDefinition($ruleValidatorServiceKey);
+
+        foreach ($container->findTaggedServiceIds('claroline.rule.constraint') as $id => $attributes) {
+//            echo "<pre>";
+//            var_dump($id);
+//            echo "</pre>" . PHP_EOL;
+            $ruleValidator->addMethodCall('addConstraint', array(new Reference($id)));
+        }
+    }
+} 
diff --git a/Rule/Constraints/ActionConstraint.php b/Rule/Constraints/ActionConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class ActionConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Constraints/BadgeConstraint.php b/Rule/Constraints/BadgeConstraint.php
diff --git a/Rule/Constraints/DoerConstraint.php b/Rule/Constraints/DoerConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class DoerConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Constraints/OccurenceConstraint.php b/Rule/Constraints/OccurenceConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class OccurenceConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Constraints/ReceiverConstraint.php b/Rule/Constraints/ReceiverConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class ReceiverConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Constraints/ResourceConstraint.php b/Rule/Constraints/ResourceConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class ResourceConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Constraints/ResultConstraint.php b/Rule/Constraints/ResultConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class ResultConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Constraints/RuleActiveDateConstraint.php b/Rule/Constraints/RuleActiveDateConstraint.php
@@ -13,7 +13,12 @@
 
 use Claroline\CoreBundle\Rule\Entity\Rule;
 use Doctrine\ORM\QueryBuilder;
+use JMS\DiExtraBundle\Annotation as DI;
 
+/**
+ * @DI\Service
+ * @DI\Tag("claroline.rule.constraint")
+ */
 class RuleActiveDateConstraint extends AbstractConstraint
 {
     /**

diff --git a/Rule/Validator.php b/Rule/Validator.php
@@ -13,6 +13,7 @@
 
 use Claroline\CoreBundle\Rule\Constraints\ActionConstraint;
 use Claroline\CoreBundle\Rule\Constraints\BadgeConstraint;
+use Claroline\CoreBundle\Rule\Constraints\AbstractConstraint;
 use Claroline\CoreBundle\Rule\Constraints\DoerConstraint;
 use Claroline\CoreBundle\Rule\Constraints\OccurenceConstraint;
 use Claroline\CoreBundle\Rule\Constraints\ReceiverConstraint;
@@ -24,6 +25,7 @@
 use Claroline\CoreBundle\Entity\User;
 use Claroline\CoreBundle\Entity\Log\Log;
 use Claroline\CoreBundle\Repository\Log\LogRepository;
+use Doctrine\Common\Collections\ArrayCollection;
 use JMS\DiExtraBundle\Annotation as DI;
 
 /**
@@ -36,6 +38,11 @@ class Validator
      */
     private $logRepository;
 
+    /**
+     * @var AbstractConstraint[]
+     */
+    protected $constraints;
+
     /**
      * @DI\InjectParams({
      *     "logRepository" = @DI\Inject("claroline.repository.log"),
@@ -44,6 +51,37 @@ class Validator
     public function __construct(LogRepository $logRepository)
     {
         $this->logRepository = $logRepository;
+        $this->constraints   = new ArrayCollection();
+    }
+
+    /**
+     * @return Constraints\AbstractConstraint[]
+     */
+    public function getConstraints()
+    {
+        return $this->constraints;
+    }
+
+    /**
+     * @param Constraints\AbstractConstraint[] $constraints
+     *
+     * @return Validator
+     */
+    public function setConstraints($constraints)
+    {
+        $this->constraints = $constraints;
+
+        return $this;
+    }
+
+    /**
+     * @param AbstractConstraint $constraint
+     *
+     * @return bool
+     */
+    public function addConstraint(AbstractConstraint $constraint)
+    {
+        return $this->constraints->add($constraint);
     }
 
     /**
@@ -95,17 +133,7 @@ public function validateRule(Rule $rule, array $restrictions = array())
     {
         /** @var \Claroline\CoreBundle\Rule\Constraints\AbstractConstraint[] $usedConstraints */
         $usedConstraints    = array();
-        /** @var \Claroline\CoreBundle\Rule\Constraints\AbstractConstraint[] $existedConstraints */
-        $existedConstraints = array(
-            new OccurenceConstraint(),
-            new ResultConstraint(),
-            new ResourceConstraint(),
-            new DoerConstraint(),
-            new ReceiverConstraint(),
-            new ActionConstraint(),
-            new BadgeConstraint(),
-            new RuleActiveDateConstraint()
-        );
+        $existedConstraints = $this->getConstraints();
 
         foreach ($existedConstraints as $existedConstraint) {
             if ($existedConstraint->isApplicableTo($rule)) {