vendor/doctrine/mongodb-odm/lib/Doctrine/ODM/MongoDB/Event/OnClearEventArgs.php line 29

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ODM\MongoDB\Event;
  7. use Doctrine\ODM\MongoDB\DocumentManager;
  8. use Doctrine\Persistence\Event\OnClearEventArgs as BaseOnClearEventArgs;
  10. use function func_num_args;
  11. use function method_exists;
  12. use function trigger_deprecation;
  14. /**
  15.  * Provides event arguments for the onClear event.
  16.  *
  17.  * @template-extends BaseOnClearEventArgs<DocumentManager>
  18.  */
  19. final class OnClearEventArgs extends BaseOnClearEventArgs
  20. {
  21.     /**
  22.      * @deprecated
  23.      *
  24.      * @var class-string|null
  25.      */
  26.     private ?string $entityClass;
  28.     /** @param class-string|null $entityClass */
  29.     public function __construct($objectManager, $entityClass = null)
  30.     {
  31.         if (method_exists(parent::class, 'getEntityClass') && $entityClass !== null) {
  32.             parent::__construct($objectManager, $entityClass);
  33.         } else {
  34.             if (func_num_args() > 1) {
  35.                 trigger_deprecation(
  36.                     'doctrine/mongodb-odm',
  37.                     '2.4',
  38.                     'Passing $entityClass argument to %s::%s() is deprecated and will not be supported in Doctrine ODM 3.0.',
  39.                     self::class,
  40.                     __METHOD__,
  41.                 );
  42.             }
  44.             parent::__construct($objectManager);
  45.         }
  47.         $this->entityClass = $entityClass;
  48.     }
  50.     public function getDocumentManager(): DocumentManager
  51.     {
  52.         return $this->getObjectManager();
  53.     }
  55.     /**
  56.      * @deprecated no replacement planned
  57.      *
  58.      * @return class-string|null
  59.      */
  60.     public function getDocumentClass(): ?string
  61.     {
  62.         trigger_deprecation(
  63.             'doctrine/mongodb-odm',
  64.             '2.4',
  65.             'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
  66.             __METHOD__,
  67.         );
  69.         return $this->entityClass;
  70.     }
  72.     /**
  73.      * Returns whether this event clears all documents.
  74.      *
  75.      * @deprecated no replacement planned
  76.      */
  77.     public function clearsAllDocuments(): bool
  78.     {
  79.         trigger_deprecation(
  80.             'doctrine/mongodb-odm',
  81.             '2.4',
  82.             'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
  83.             __METHOD__,
  84.         );
  86.         return $this->entityClass !== null;
  87.     }
  89.     /** @deprecated no replacement planned */
  90.     public function clearsAllEntities(): bool
  91.     {
  92.         if (method_exists(parent::class, 'clearsAllEntities')) {
  93.             return parent::clearsAllEntities();
  94.         }
  96.         trigger_deprecation(
  97.             'doctrine/mongodb-odm',
  98.             '2.4',
  99.             'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
  100.             __METHOD__,
  101.         );
  103.         return $this->entityClass !== null;
  104.     }
  106.     /**
  107.      * @deprecated no replacement planned
  108.      *
  109.      * @return class-string|null
  110.      */
  111.     public function getEntityClass(): ?string
  112.     {
  113.         if (method_exists(parent::class, 'getEntityClass')) {
  114.             return parent::getEntityClass();
  115.         }
  117.         trigger_deprecation(
  118.             'doctrine/mongodb-odm',
  119.             '2.4',
  120.             'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
  121.             __METHOD__,
  122.         );
  124.         return $this->entityClass;
  125.     }
  126. }