Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs

Complexity

Total Complexity

5

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setFoundMetadata()	0	4	1
A	getFoundMetadata()	0	4	1
A	getClassName()	0	4	1
A	__construct()	0	11	1
A	getClassMetadataBuildingContext()	0	4	1

<?php

declare(strict_types=1);

namespace Doctrine\ORM\Event;

use Doctrine\Common\Persistence\Event\ManagerEventArgs;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Mapping\ClassMetadataBuildingContext;

/**
 * Class that holds event arguments for a `onClassMetadataNotFound` event.
 *
 * This object is mutable by design, allowing callbacks having access to it to set the
 * found metadata in it, and therefore "cancelling" a `onClassMetadataNotFound` event
 *
 * @package Doctrine\ORM\Event
 * @since 2.5
 *
 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author Marco Pivetta <ocramius@gmail.com>
 */
class OnClassMetadataNotFoundEventArgs extends ManagerEventArgs
{
    /**
     * @var string
     */
    private $className;

    /**
     * @var ClassMetadataBuildingContext
     */
    private $metadataBuildingContext;

    /**
     * @var ClassMetadata|null
     */
    private $foundMetadata;

    /**
     * Constructor.
     *
     * @param string                       $className
     * @param ClassMetadataBuildingContext $metadataBuildingContext
     * @param EntityManagerInterface       $entityManager
     */
    public function __construct(
        string $className,
        ClassMetadataBuildingContext $metadataBuildingContext,
        EntityManagerInterface $entityManager
    )
    {
        parent::__construct($entityManager);

        $this->className               = $className;
        $this->metadataBuildingContext = $metadataBuildingContext;
    }

    /**
     * @param ClassMetadata|null $classMetadata
     *
     * @return void
     */
    public function setFoundMetadata(?ClassMetadata $classMetadata) : void
    {
        $this->foundMetadata = $classMetadata;
    }

    /**
     * @return ClassMetadata|null
     */
    public function getFoundMetadata() : ?ClassMetadata
    {
        return $this->foundMetadata;
    }

    /**
     * Retrieve class name for which a failed metadata fetch attempt was executed
     *
     * @return string
     */
    public function getClassName() : string
    {
        return $this->className;
    }

    /**
     * @return ClassMetadataBuildingContext
     */
    public function getClassMetadataBuildingContext() : ClassMetadataBuildingContext
    {
        return $this->metadataBuildingContext;
    }
}