TheCodingMachine\TDBM\Utils\Annotation\AnnotationParser

Complexity

Total Complexity

7

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	buildWithDefaultAnnotations()	0	9	1
A	parse()	0	8	1
A	getColumnAnnotations()	0	7	2
A	getTableAnnotations()	0	7	2
A	__construct()	0	4	1

<?php
declare(strict_types=1);

namespace TheCodingMachine\TDBM\Utils\Annotation;

use Doctrine\Common\Annotations\DocParser;
use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\Table;

/**
 * Parses annotations in database columns.
 */
class AnnotationParser
{
    /**
     * @var DocParser
     */
    private $docParser;

    /**
     * AnnotationParser constructor.
     * @param string[] $annotations An array mapping the annotation name to the fully qualified class name
     */
    public function __construct(array $annotations)
    {
        $this->docParser = new DocParser();
        $this->docParser->setImports(array_change_key_case($annotations, \CASE_LOWER));
    }

    /**
     * @param array<string,string> $additionalAnnotations An array associating the name of the annotation in DB comments to the name of a fully qualified Doctrine annotation class
     */
    public static function buildWithDefaultAnnotations(array $additionalAnnotations): self
    {
        $defaultAnnotations = [
            'UUID' => UUID::class,
            'Autoincrement' => Autoincrement::class,
            'Bean' => Bean::class
        ];
        $annotations = $defaultAnnotations + $additionalAnnotations;
        return new self($annotations);
    }

    /**
     * Parses the doc comment and initializes all the annotations.
     */
    private function parse(string $comment, string $context): Annotations
    {
        // compatibility with UUID annotation from TDBM 5.0
        $comment = \str_replace(['@UUID v1', '@UUID v4'], ['@UUID("v1")', '@UUID("v4")'], $comment);

        $annotations = $this->docParser->parse($comment, $context);

        return new Annotations($annotations);
    }

    public function getTableAnnotations(Table $table): Annotations
    {
        $options = $table->getOptions();
        if (isset($options['comment'])) {
            return $this->parse($options['comment'], ' comment in table '.$table->getName());
        }
        return new Annotations([]);
    }

    public function getColumnAnnotations(Column $column, Table $table): Annotations
    {
        $comment = $column->getComment();
        if ($comment === null) {
            return new Annotations([]);
        }
        return $this->parse($comment, sprintf('comment of column %s in table %s', $column->getName(), $table->getName()));
    }
}