Rename SearchOr.php to SearchOrFilter.php and improve description

chamilo · Jun 11, 2024 · 1576694 · 1576694
1 parent 1b5754c
commit 1576694
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/src/CoreBundle/Entity/Message.php b/src/CoreBundle/Entity/Message.php
@@ -16,7 +16,7 @@
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Post;
 use ApiPlatform\Metadata\Put;
-use Chamilo\CoreBundle\Filter\SearchOr;
+use Chamilo\CoreBundle\Filter\SearchOrFilter;
 use Chamilo\CoreBundle\Repository\MessageRepository;
 use Chamilo\CoreBundle\State\MessageByGroupStateProvider;
 use Chamilo\CoreBundle\State\MessageProcessor;
@@ -77,7 +77,7 @@
     BooleanFilter::class,
     properties: ['receivers.read']
 )]
-#[ApiFilter(SearchOr::class, properties: ['title', 'content'])]
+#[ApiFilter(SearchOrFilter::class, properties: ['title', 'content'])]
 class Message
 {
     public const MESSAGE_TYPE_INBOX = 1;

diff --git a/src/CoreBundle/Entity/User.php b/src/CoreBundle/Entity/User.php
@@ -18,7 +18,7 @@
 use ApiPlatform\Metadata\Put;
 use Chamilo\CoreBundle\Controller\Api\UserSkillsController;
 use Chamilo\CoreBundle\Entity\Listener\UserListener;
-use Chamilo\CoreBundle\Filter\SearchOr;
+use Chamilo\CoreBundle\Filter\SearchOrFilter;
 use Chamilo\CoreBundle\Repository\Node\UserRepository;
 use Chamilo\CoreBundle\Traits\UserCreatorTrait;
 use Chamilo\CourseBundle\Entity\CGroupRelTutor;
@@ -78,7 +78,7 @@
         'lastname' => 'partial',
     ]
 )]
-#[ApiFilter(SearchOr::class, properties: ['username', 'firstname', 'lastname'])]
+#[ApiFilter(SearchOrFilter::class, properties: ['username', 'firstname', 'lastname'])]
 #[ApiFilter(filterClass: BooleanFilter::class, properties: ['isActive'])]
 class User implements UserInterface, EquatableInterface, ResourceInterface, ResourceIllustrationInterface, PasswordAuthenticatedUserInterface, LegacyPasswordAuthenticatedUserInterface, ExtraFieldItemInterface, Stringable
 {

diff --git a/src/CoreBundle/Filter/SearchOr.php → src/CoreBundle/Filter/SearchOrFilter.php b/src/CoreBundle/Filter/SearchOr.php → src/CoreBundle/Filter/SearchOrFilter.php
@@ -1,9 +1,9 @@
 <?php
 
-declare(strict_types=1);
-
 /* For licensing terms, see /license.txt */
 
+declare(strict_types=1);
+
 namespace Chamilo\CoreBundle\Filter;
 
 use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;
@@ -12,7 +12,7 @@
 use Doctrine\ORM\QueryBuilder;
 use InvalidArgumentException;
 
-class SearchOr extends AbstractFilter
+class SearchOrFilter extends AbstractFilter
 {
     protected function filterProperty(
         string $property,
@@ -59,7 +59,7 @@ public function getDescription(string $resourceClass): array
                 'property' => null,
                 'type' => 'string',
                 'required' => false,
-                'description' => 'Do a "Search OR" across multiple fields',
+                'description' => 'It does a "Search OR" using `LIKE %text%` to search for fields that contain `text`',
             ],
         ];
     }