Bdf\Prime\Schema\Resolver

Complexity

Total Complexity

24

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Test Coverage

Coverage

94.94%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	table()	0	20	2
A	schema()	0	7	2
A	sequence()	0	15	2
A	__construct()	0	5	1
A	schemaSequence()	0	11	3
A	connection()	0	3	2
A	migrate()	0	10	2
A	insertSequenceId()	0	13	3
A	truncate()	0	3	1
A	diff()	0	21	2
A	drop()	0	16	4

<?php

namespace Bdf\Prime\Schema;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Exception\DBALException;
use Bdf\Prime\Exception\PrimeException;
use Bdf\Prime\Schema\Adapter\ConstraintTable;
use Bdf\Prime\Schema\Adapter\MapperInfo\MapperInfoConstraintSet;
use Bdf\Prime\Schema\Adapter\MapperInfo\Resolver\MapperInfoForeignKeyResolver;
use Bdf\Prime\Schema\Adapter\Metadata\MetadataTable;
use Bdf\Prime\Schema\Builder\TableBuilder;
use Bdf\Prime\ServiceLocator;
use Bdf\Prime\Mapper\Metadata;
use Doctrine\DBAL\Exception\TableNotFoundException;

/**
 * Schema resolver
 * 
 * manage update on schema

Doc comment long description must start with a capital letter

Doc comment long description must end with a full stop

 * 
 * @todo gestion du renommage de champs dans le cas où d'autres attributs ont été changés

Comment refers to a TODO task

@todo tag is not allowed in class comment

 */
class Resolver implements ResolverInterface
{
    /**
     * @var ServiceLocator 

Expected "ServiceLocator" but found "ServiceLocator " for @var tag in member variable comment

     */
    protected $service;
    
    /**
     * @var Metadata 

Expected "Metadata" but found "Metadata " for @var tag in member variable comment

     */
    protected $metadata;

    /**
     * @var SchemaManagerInterface
     */
    protected $schema;


    /**
     * @param ServiceLocator $service Prime service
     * @param Metadata $metadata The entity metadata
     * @param SchemaManagerInterface|null $schema If given, force using this schema manager instead of resolving using the configured connection name
     */
    public function __construct(ServiceLocator $service, Metadata $metadata, SchemaManagerInterface $schema = null)

Expected 1 blank line before function; 2 found

    {
        $this->service  = $service;
        $this->metadata = $metadata;
        $this->schema   = $schema;
    }
    
    /**

Parameter $listDrop should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function migrate($listDrop = true)
    {
        $schema = $this->schema()->useDrop($listDrop);
        $schema->add($this->table());

        if (($schemaSequence = $this->schemaSequence()) !== null) {

Variable assignment found within a condition. Did you mean to do a comparison ?

Assignments must be the first block of code on a line

            $schemaSequence->useDrop($listDrop);
            $schemaSequence->add($this->sequence());

            $this->insertSequenceId();
        }
    }
    
    /**

Parameter $listDrop should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function diff($listDrop = true)
    {
        $queries = $this->schema()
            ->simulate(function (SchemaManagerInterface $schema) use ($listDrop) {

Space found before object operator

Object operator not indented correctly; expected 10 spaces but found 12

                $schema->useDrop($listDrop);
                $schema->add($this->table());
            })
            ->pending();

Space found before object operator

        if (($schemaSequence = $this->schemaSequence()) === null) {

Variable assignment found within a condition. Did you mean to do a comparison ?

Assignments must be the first block of code on a line

            return $queries;
        }

        $sequenceQueries = $schemaSequence
            ->simulate(function (SchemaManagerInterface $schema) use ($listDrop) {

Space found before object operator

Object operator not indented correctly; expected 10 spaces but found 12

                $schema->useDrop($listDrop);
                $schema->add($this->sequence());
            })
            ->pending();

Space found before object operator

        return array_merge($queries, $sequenceQueries);
    }

    /**
     * Create table schema from meta
     *
     * @param bool $foreignKeys Add foreign key constraints to the schema ?

Expected "boolean" but found "bool" for parameter type

     *
     * @return TableInterface
     * @throws PrimeException

Comment missing for @throws tag in function comment

     */
    public function table($foreignKeys = false)
    {
        $table = new MetadataTable(
            $this->metadata,
            $this->connection()->platform()->types()
        );

        if ($foreignKeys) {
            $table = new ConstraintTable(
                $table,
                new MapperInfoConstraintSet(
                    $this->service->repository($this->metadata->entityName)->mapper()->info(),
                    [
                        new MapperInfoForeignKeyResolver($this->service)

A comma should follow the last multiline array item. Found: )

                    ]
                )
            );
        }

        return $table;
    }

    /**
     * Create sequence schema from meta
     *
     * @return null|TableInterface
     * @throws PrimeException

Comment missing for @throws tag in function comment

     */
    public function sequence()
    {
        if (!$this->metadata->isSequencePrimaryKey()) {
            return null;
        }

        $table = new TableBuilder($this->metadata->sequence['table']);
        $table->options($this->metadata->sequence['options']);
        $table->add(
            $this->metadata->sequence['column'],
            $this->connection($this->metadata->sequence['connection'])->platform()->types()->native('bigint')
        );
        $table->primary($this->metadata->sequence['column']);

        return $table->build();
    }
    
    /**
     * Insert sequence id into sequence table
     *
     * @throws PrimeException

Comment missing for @throws tag in function comment

     */
    public function insertSequenceId()
    {
        if (!$this->metadata->isSequencePrimaryKey()) {
            return;
        }
        
        $connection = $this->connection($this->metadata->sequence['connection']);
        $table  = $this->metadata->sequence['table'];

Equals sign not aligned with surrounding assignments; expected 1 space but found 2 spaces

        
        $nb = $connection->from($table)->count();

The method count() does not exist on Bdf\Prime\Query\QueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\QueryInterface.

        
        if ($nb == 0) {
            $connection->insert($table, [$this->metadata->sequence['column'] => 0]);

The method insert() does not exist on Bdf\Prime\Connection\ConnectionInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Connection\ConnectionInterface.

        }
    }
    
    /**

Parameter $cascade should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function truncate($cascade =false)

Incorrect spacing between default value and equals sign for argument "$cascade"; expected 1 but found 0

    {
        return $this->schema()->truncate($this->metadata->table, $cascade);

The expression return $this->schema()->truncate($this->metadata->table, $cascade) returns the type Bdf\Prime\Schema\SchemaManagerInterface which is incompatible with the return type mandated by Bdf\Prime\Schema\ResolverInterface::truncate() of boolean.

    }
    
    /**
     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function drop()
    {
        try {
            $this->schema()->drop($this->metadata->table);

            if (($schemaSequence = $this->schemaSequence()) !== null) {

Variable assignment found within a condition. Did you mean to do a comparison ?

Assignments must be the first block of code on a line

                $schemaSequence->drop($this->metadata->sequence['table']);
            }
            
            return true;
        } catch (DBALException $e) {
            if ($e->getPrevious() instanceof TableNotFoundException) {
                return false;
            }

            throw $e;
        }
    }

    /**
     * Get the schema builder
     * 
     * @return SchemaManagerInterface
     * @throws PrimeException

Comment missing for @throws tag in function comment

     */
    protected function schema()
    {
        if ($this->schema !== null) {
            return $this->schema;
        }

        return $this->connection()->schema();
    }

    /**
     * Get the schema builder for sequence
     *
     * @return SchemaManagerInterface
     * @throws PrimeException

Comment missing for @throws tag in function comment

     */
    protected function schemaSequence()
    {
        if (!$this->metadata->isSequencePrimaryKey()) {
            return null;
        }

        if ($this->schema !== null) {
            return $this->schema;
        }

        return $this->connection($this->metadata->sequence['connection'])->schema();
    }

    /**
     * Get the connection
     * 
     * @param string $profile
     *
     * @return ConnectionInterface
     */
    protected function connection($profile = null)
    {
        return $this->service->connection($profile ?: $this->metadata->connection);

Inline shorthand IF statement requires brackets around comparison

    }
}