Bdf\Prime\IdGenerators\AbstractGenerator

Complexity

Total Complexity

12

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Test Coverage

Coverage

93.94%

Importance

Changes	1
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	mapper()	0	3	1
A	connection()	0	3	1
A	generate()	0	9	2
A	__construct()	0	4	1
A	setCurrentConnection()	0	3	1
A	doGenerate()	0	2	1
A	postProcess()	0	15	3
A	getPropertyToHydrate()	0	3	1
A	lastGeneratedId()	0	3	1

<?php

namespace Bdf\Prime\IdGenerators;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Exception\PrimeException;
use Bdf\Prime\Mapper\Mapper;
use Bdf\Prime\ServiceLocator;

/**
 * AbstractGenerator
 *
 * A basic property generator. Let inheritance set its generation algorithm.
 *
 * @template C as ConnectionInterface
 * @implements GeneratorInterface<C>
 */
abstract class AbstractGenerator implements GeneratorInterface
{
    /**
     * The associated mapper
     *
     * @var Mapper
     */
    private $mapper;
    
    /**
     * The active connection
     *
     * @var C
     */
    private $connection;

    /**
     * The last generated id
     *
     * @var string
     */
    protected $lastGeneratedId;

    /**
     * Le primary attribute n'est effacé que s'il est vide.
     * La valeur du last insert ID sera injecté dans entity que si
     * son attribut primary aura été vidé
     *
     * @var bool

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

     */
    protected $hasBeenErased = true;
    
    /**
     * @param Mapper $mapper
     */
    public function __construct(Mapper $mapper = null)
    {
        // TODO: reference cyclique

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

        $this->mapper = $mapper;
    }
    
    /**
     * Get the mapper
     * 
     * @return Mapper
     */
    public function mapper()
    {
        return $this->mapper;
    }
    
    /**
     * Get connection
     * 
     * @return C
     */
    public function connection()
    {
        return $this->connection;
    }
    
    /**

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

     * {@inheritdoc}
     */
    public function setCurrentConnection(ConnectionInterface $connection)
    {
        $this->connection = $connection;

It seems like $connection of type Bdf\Prime\Connection\ConnectionInterface is incompatible with the declared type Bdf\Prime\IdGenerators\C of property $connection.

    }
    
    /**

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

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

     * {@inheritdoc}
     */
    public function generate(array &$data, ServiceLocator $serviceLocator)
    {
        $this->hasBeenErased = false;

        $property = $this->getPropertyToHydrate();

        if (empty($data[$property])) {
            $this->lastGeneratedId = $this->doGenerate($property, $data, $serviceLocator);

Are you sure the assignment to $this->lastGeneratedId is correct as $this->doGenerate($property, $data, $serviceLocator) targeting Bdf\Prime\IdGenerators\AbstractGenerator::doGenerate() seems to always return null.

            $this->hasBeenErased = true;
        }
    }

    /**
     * Do the ID generation
     *
     * @param string           $property        The aimed property
     * @param array            $data            By reference
     * @param ServiceLocator   $serviceLocator
     *
     * @return string|null   Returns the generated id

Function return type is not void, but function has no return statement

     * @throws PrimeException
     */
    protected function doGenerate($property, array &$data, ServiceLocator $serviceLocator)

The parameter $property is not used and could be removed.

    {
        // to overload

Inline comments must start with a capital letter

    }

    /**

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

     * {@inheritdoc}
     */
    public function postProcess($entity)
    {
        if (!$this->hasBeenErased) {
            return;
        }

        $propertyName = $this->getPropertyToHydrate();
        $propertyMetadata = $this->mapper->metadata()->attributes[$propertyName];
        $value = $this->lastGeneratedId();

        if (empty($propertyMetadata['phpOptions']['ignore_generator'])) {
            $value = $this->connection->fromDatabase($value, $propertyMetadata['type'], $propertyMetadata['phpOptions'] ?? []);

Operation must be bracketed

        }

        $this->mapper->hydrateOne($entity, $propertyName, $value);
    }

    /**
     * Get the last generated id
     *
     * @return string
     */
    protected function lastGeneratedId()
    {
        return $this->lastGeneratedId;
    }

    /**
     * Get the property name to hydrate
     *
     * Returns by default the primary property

Doc comment long description must end with a full stop

     *
     * @return string
     */
    protected function getPropertyToHydrate()
    {
        return $this->mapper->metadata()->primary['attributes'][0];
    }
}