Add phpdoc for all Matches implementations

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

diff --git a/src/Wallabag/CoreBundle/Operator/PHP/Matches.php b/src/Wallabag/CoreBundle/Operator/PHP/Matches.php
index 4768900ce23738bcf5436a981da5c9c736eb9863..987ed2a50b26127adf95d842d681d6a199bd9643 100644 (file)
--- a/src/Wallabag/CoreBundle/Operator/PHP/Matches.php
+++ b/src/Wallabag/CoreBundle/Operator/PHP/Matches.php
@@ -2,6 +2,16 @@
 
 namespace Wallabag\CoreBundle\Operator\PHP;
 
+/**
+ * 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 PHP, usable
+ * directly on Entry objects for instance.
+ * It's registered in RulerZ using a service (wallabag.operator.array.matches);
+ */
 class Matches
 {
     public function __invoke($subject, $pattern)