Add phpdoc for all Matches implementations

[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Operator / Doctrine / Matches.php

diff --git a/src/Wallabag/CoreBundle/Operator/Doctrine/Matches.php b/src/Wallabag/CoreBundle/Operator/Doctrine/Matches.php
index dc47c982a52a563d43bd9271bdd3e347bf87b3c1..e6bb03b12d4a5fd3b9ba2ccc114f114a71111d47 100644 (file)
--- a/src/Wallabag/CoreBundle/Operator/Doctrine/Matches.php
+++ b/src/Wallabag/CoreBundle/Operator/Doctrine/Matches.php
@@ -2,6 +2,16 @@
 
 namespace Wallabag\CoreBundle\Operator\Doctrine;
 
+/**
+ * Provides a "matches" operator used for tagging rules.
+ *
+ * It asserts that a given pattern is contained in a subject, in a
+ * case-insensitive way.
+ *
+ * This operator will be used to compile tagging rules in DQL, usable
+ * by Doctrine ORM.
+ * It's registered in RulerZ using a service (wallabag.operator.doctrine.matches);
+ */
 class Matches
 {
     public function __invoke($subject, $pattern)