OnClassMetadataNotFoundEventArgs.php 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <?php
  2. /*
  3. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. *
  15. * This software consists of voluntary contributions made by many individuals
  16. * and is licensed under the MIT license. For more information, see
  17. * <http://www.doctrine-project.org>.
  18. */
  19. namespace Doctrine\ORM\Event;
  20. use Doctrine\Persistence\Event\ManagerEventArgs;
  21. use Doctrine\Persistence\Mapping\ClassMetadata;
  22. use Doctrine\Persistence\ObjectManager;
  23. /**
  24. * Class that holds event arguments for a `onClassMetadataNotFound` event.
  25. *
  26. * This object is mutable by design, allowing callbacks having access to it to set the
  27. * found metadata in it, and therefore "cancelling" a `onClassMetadataNotFound` event
  28. */
  29. class OnClassMetadataNotFoundEventArgs extends ManagerEventArgs
  30. {
  31. /** @var string */
  32. private $className;
  33. /** @var ClassMetadata|null */
  34. private $foundMetadata;
  35. /**
  36. * @param string $className
  37. */
  38. public function __construct($className, ObjectManager $objectManager)
  39. {
  40. $this->className = (string) $className;
  41. parent::__construct($objectManager);
  42. }
  43. public function setFoundMetadata(?ClassMetadata $classMetadata = null)
  44. {
  45. $this->foundMetadata = $classMetadata;
  46. }
  47. /**
  48. * @return ClassMetadata|null
  49. */
  50. public function getFoundMetadata()
  51. {
  52. return $this->foundMetadata;
  53. }
  54. /**
  55. * Retrieve class name for which a failed metadata fetch attempt was executed
  56. *
  57. * @return string
  58. */
  59. public function getClassName()
  60. {
  61. return $this->className;
  62. }
  63. }