DoctrineORMModule\Collector\MappingCollector

Complexity

Total Complexity

10

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

86.67%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getName()	0	4	1
A	getPriority()	0	4	1
A	collect()	0	16	3
A	canHide()	0	4	1
A	serialize()	0	9	1
A	unserialize()	0	6	1
A	getClasses()	0	4	1

<?php

declare(strict_types=1);

namespace DoctrineORMModule\Collector;

use Doctrine\Common\Persistence\Mapping\ClassMetadata;
use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory;
use Laminas\DeveloperTools\Collector\AutoHideInterface;
use Laminas\DeveloperTools\Collector\CollectorInterface;
use Laminas\Mvc\MvcEvent;
use Serializable;
use function ksort;
use function serialize;
use function unserialize;

/**
 * Collector to be used in DeveloperTools to record and display mapping information
 */
class MappingCollector implements CollectorInterface, AutoHideInterface, Serializable
{
    /**
     * Collector priority
     */
    public const PRIORITY = 10;

    /** @var string */
    protected $name;

    /** @var ClassMetadataFactory|null */
    protected $classMetadataFactory = [];

    /** @var ClassMetadata[] indexed by class name */
    protected $classes = [];

    public function __construct(ClassMetadataFactory $classMetadataFactory, string $name)
    {
        $this->classMetadataFactory = $classMetadataFactory;
        $this->name                 = (string) $name;
    }

    /**
     * {@inheritDoc}
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * {@inheritDoc}
     */
    public function getPriority()
    {
        return self::PRIORITY;
    }

    /**
     * {@inheritDoc}
     */
    public function collect(MvcEvent $mvcEvent)
    {
        if (! $this->classMetadataFactory) {
            return;
        }

        /** @var ClassMetadata[] $metadata */
        $metadata      = $this->classMetadataFactory->getAllMetadata();
        $this->classes = [];

        foreach ($metadata as $class) {
            $this->classes[$class->getName()] = $class;
        }

        ksort($this->classes);
    }

    /**
     * {@inheritDoc}
     */
    public function canHide()
    {
        return empty($this->classes);
    }

    /**
     * {@inheritDoc}
     */
    public function serialize()
    {
        return serialize(
            [
                'name'    => $this->name,
                'classes' => $this->classes,
            ]
        );
    }

    /**
     * {@inheritDoc}
     */
    public function unserialize($serialized)
    {
        $data          = unserialize($serialized);
        $this->name    = $data['name'];
        $this->classes = $data['classes'];
    }

    /**
     * @return ClassMetadata[]
     */
    public function getClasses() : array
    {
        return $this->classes;
    }
}