Bdf\Prime\Mapper\Mapper

Complexity

Total Complexity

63

Size/Duplication

Total Lines	803
Duplicated Lines	0 %

Test Coverage

Coverage

97.44%

Importance

Changes	1
Bugs	0	Features	0

47 Methods

Rating	Name	Duplication	Size	Complexity
A	relation()	0	9	2
A	customConstraints()	0	3	1
A	entity()	0	13	2
A	queries()	0	3	1
A	constraints()	0	9	2
A	customEvents()	0	2	1
A	events()	0	6	2
A	buildFields()	0	3	1
A	setGenerator()	0	7	3
A	getId()	0	3	1
A	getDefinedBehaviors()	0	3	1
A	getRepositoryClass()	0	3	1
A	indexes()	0	7	1
A	destroy()	0	6	1
A	relations()	0	8	2
A	info()	0	5	1
A	getEntityClass()	0	3	1
A	__construct()	0	12	3
A	setQuoteIdentifier()	0	3	1
A	primaryCriteria()	0	3	1
A	filters()	0	3	1
A	fields()	0	10	2
A	buildIndexes()	0	2	1
A	extractOne()	0	3	1
A	getPropertyAccessorClass()	0	3	1
A	metadata()	0	3	1
A	prepareFromRepository()	0	7	1
A	setId()	0	3	1
A	disableSchemaManager()	0	3	1
A	setPropertyAccessorClass()	0	3	1
A	instantiate()	0	4	1
A	isReadOnly()	0	3	1
A	hasSchemaManager()	0	3	1
A	repository()	0	5	2
A	setHydrator()	0	7	1
A	buildRelations()	0	2	1
A	hydrateOne()	0	3	1
A	sequence()	0	7	1
A	behaviors()	0	7	2
A	prepareToRepository()	0	3	1
A	generator()	0	16	5
A	configure()	0	2	1
A	setRepositoryClass()	0	3	1
A	scopes()	0	3	1
A	setReadOnly()	0	3	1
A	hydrator()	0	3	1
A	hasQuoteIdentifier()	0	3	1

<?php

namespace Bdf\Prime\Mapper;

use Bdf\Prime\Behaviors\BehaviorInterface;

Unused use statement

use Bdf\Prime\Cache\CacheInterface;
use Bdf\Prime\Entity\ImportableInterface;
use Bdf\Prime\Entity\Hydrator\MapperHydrator;
use Bdf\Prime\Entity\Hydrator\MapperHydratorInterface;
use Bdf\Prime\Mapper\Builder\IndexBuilder;
use Bdf\Prime\Mapper\Info\MapperInfo;
use Bdf\Prime\Platform\PlatformInterface;
use Bdf\Prime\Relations\Exceptions\RelationNotFoundException;
use Bdf\Prime\Repository\EntityRepository;
use Bdf\Prime\Repository\RepositoryInterface;

Unused use statement

use Bdf\Prime\ServiceLocator;
use Bdf\Prime\IdGenerators\GeneratorInterface;
use Bdf\Prime\IdGenerators\AutoIncrementGenerator;
use Bdf\Prime\IdGenerators\NullGenerator;
use Bdf\Prime\IdGenerators\TableGenerator;
use Bdf\Prime\Mapper\Builder\FieldBuilder;
use Bdf\Prime\Relations\Builder\RelationBuilder;
use Bdf\Serializer\PropertyAccessor\ReflectionAccessor;
use LogicException;

/**
 * Mapper
 * 
 * Contient les méta données de la table.
 * 
 * @todo Convertir la donnée avec le type approprié sur les methodes setId, hydrateOne

Comment refers to a TODO task

@todo tag is not allowed in class comment

 *
 * @package Bdf\Prime\Mapper

@package tag is not allowed in class comment

 */
abstract class Mapper
{
    /**
     * Enable/Disable query result cache on repository
     * If null global cache will be set.
     * Set it to false to deactivate cache on this repository
     * Set the cache instance in configure method

Doc comment short description must be on a single line, further text should be a separate paragraph

     * 
     * @var false|CacheInterface
     */
    protected $resultCache;

Expected 1 blank line(s) before first member var; 0 found

    
    /**
     * @var Metadata
     */
    private $metadata;
    
    /**
     * Id generator
     * 
     * Could be defined as string (generator class name). It would be instantiated
     * by mapper on generator() method

Doc comment long description must end with a full stop

     * 
     * @var \Bdf\Prime\IdGenerators\GeneratorInterface
     */
    protected $generator;
    
    /**
     * @var string
     */
    private $repositoryClass = EntityRepository::class;
    
    /**
     * The real name of entity class. Could be an none existing class
     * 
     * @var string
     */
    private $entityClass;

    /**
     * The property accessor class name to use by default
     *
     * @var string
     */
    private $propertyAccessorClass = ReflectionAccessor::class;

    /**
     * Set repository read only.
     * 
     * @var bool

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

     */
    private $readOnly = false;
    
    /**
     * Use schema resolver
     * Disable if schema has not to be manage by this app

Doc comment short description must be on a single line, further text should be a separate paragraph

     * 
     * @var bool

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

     */
    private $useSchemaManager = true;

    /**
     * Use quote identifier
     * Allows query builder to use quote identifier

Doc comment short description must be on a single line, further text should be a separate paragraph

     *
     * @var bool

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

     */
    private $useQuoteIdentifier = false;

    /**
     * The relation builder
     *
     * @var RelationBuilder
     */
    private $relationBuilder;

    /**
     * The collection of behaviors
     *
     * @var BehaviorInterface[]
     */
    private $behaviors;

    /**
     * The service locator
     *
     * @var ServiceLocator
     */
    protected $serviceLocator;

    /**
     * @var MapperHydratorInterface
     */
    protected $hydrator;


    /**
     * Mapper constructor
     *
     * @param ServiceLocator $serviceLocator
     * @param string $entityClass
     * @param Metadata|null $metadata
     * @param MapperHydratorInterface|null $hydrator
     * @param CacheInterface|null $resultCache
     */
    public function __construct(ServiceLocator $serviceLocator, $entityClass, $metadata = null, MapperHydratorInterface $hydrator = null, CacheInterface $resultCache = null)

Expected 1 blank line before function; 2 found

    {
        $this->entityClass = $entityClass;
        $this->metadata = $metadata ?: new Metadata();

The value of a comparison must not be assigned to a variable

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

        $this->serviceLocator = $serviceLocator;
        $this->resultCache = $resultCache;

        $this->configure();
        
        $this->metadata->build($this);

        $this->setHydrator($hydrator ?: new MapperHydrator());

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

    }
    
    /**
     * Custom configuration
     */
    public function configure()
    {
        // to overwrite

Inline comments must start with a capital letter

    }

    /**
     * Get entity class
     * 
     * @return string
     */
    public function getEntityClass()
    {
        return $this->entityClass;
    }
    
    /**
     * Get metadata
     * 
     * @return Metadata
     */
    public function metadata()
    {
        return $this->metadata;
    }
    
    /**
     * Set property accessor class name
     * 
     * @param string $className
     */
    public function setPropertyAccessorClass($className)
    {
        $this->propertyAccessorClass = $className;
    }
    
    /**
     * Get property accessor class name
     * 
     * @return string
     */
    public function getPropertyAccessorClass()
    {
        return $this->propertyAccessorClass;
    }

    /**
     * Set repository class name
     *
     * @param string $className
     */
    public function setRepositoryClass($className)
    {
        $this->repositoryClass = $className;
    }

    /**
     * Get repository class name
     *
     * @return string
     */
    public function getRepositoryClass()
    {
        return $this->repositoryClass;
    }

    /**
     * Set the repository read only
     * 
     * @param bool $flag

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

     */
    public function setReadOnly($flag)
    {
        $this->readOnly = (bool)$flag;

Expected 1 space(s) after cast statement; 0 found

    }
    
    /**
     * Get repository read only state
     * 
     * @return bool

Expected "boolean" but found "bool" for function return type

     */
    public function isReadOnly()
    {
        return $this->readOnly;
    }
    
    /**
     * Disable schema manager on repository
     */
    public function disableSchemaManager()
    {
        $this->useSchemaManager = false;
    }
    
    /**
     * Does repository have a schema manager
     * 
     * @return bool

Expected "boolean" but found "bool" for function return type

     */
    public function hasSchemaManager()
    {
        return $this->useSchemaManager;
    }

    /**
     * Set the query builder quote identifier
     *
     * @param bool $flag

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

     */
    public function setQuoteIdentifier($flag)
    {
        $this->useQuoteIdentifier = (bool)$flag;

Expected 1 space(s) after cast statement; 0 found

    }

    /**
     * Does query builder use quote identifier
     *
     * @return bool

Expected "boolean" but found "bool" for function return type

     */
    public function hasQuoteIdentifier()
    {
        return $this->useQuoteIdentifier;
    }

    /**
     * Set generator ID
     * 
     * @param string|GeneratorInterface $generator
     */

Missing @throws tag in function comment

    public function setGenerator($generator)
    {
        if (!is_string($generator) && !$generator instanceof GeneratorInterface) {

$generator is always a sub-type of Bdf\Prime\IdGenerators\GeneratorInterface.

            throw new LogicException('Trying to set an invalid generator in "' . get_class($this) . '"');
        }
        
        $this->generator = $generator;

It seems like $generator can also be of type string. However, the property $generator is declared as type Bdf\Prime\IdGenerators\GeneratorInterface. Maybe add an additional type check?

    }
    
    /**
     * Get generator ID
     * 
     * @return object
     */
    public function generator()
    {
        if ($this->generator === null) {
            if ($this->metadata->isAutoIncrementPrimaryKey()) {
                $this->generator = new AutoIncrementGenerator($this);
            } elseif ($this->metadata->isSequencePrimaryKey()) {

Usage of ELSEIF not allowed; use ELSE IF instead

                $this->generator = new TableGenerator($this);
            } else {
                $this->generator = new NullGenerator();
            }
        } elseif (is_string($this->generator)) {

The condition is_string($this->generator) is always false.

Usage of ELSEIF not allowed; use ELSE IF instead

            $className = $this->generator;
            $this->generator = new $className($this);
        }

        return $this->generator;
    }

    /**
     * @return MapperHydratorInterface
     */
    public function hydrator()
    {
        return $this->hydrator;
    }

    /**
     * @param MapperHydratorInterface $hydrator
     *
     * @return $this
     */
    public function setHydrator(MapperHydratorInterface $hydrator)
    {
        $this->hydrator = $hydrator;
        $this->hydrator->setPrimeInstantiator($this->serviceLocator->instantiator());
        $this->hydrator->setPrimeMetadata($this->metadata);

        return $this;
    }

    /**
     * Set ID value en entity
     * Only sequenceable attribute is set (the first one)

Doc comment short description must be on a single line, further text should be a separate paragraph

     *
     * @param object $entity
     * @param mixed $value
     */
    public function setId($entity, $value)
    {
        $this->hydrateOne($entity, $this->metadata->primary['attributes'][0], $value);
    }

    /**
     * Get ID value of an entity
     * Only sequenceable attribute is get (the first one)

Doc comment short description must be on a single line, further text should be a separate paragraph

     * 
     * @param object $entity
     *
     * @return mixed
     */
    public function getId($entity)
    {
        return $this->extractOne($entity, $this->metadata->primary['attributes'][0]);
    }
    
    /**
     * Get attribute value of an entity
     * 
     * @param object $entity
     * @param string $attribute
     *
     * @return mixed
     */
    public function extractOne($entity, $attribute)
    {
        return $this->hydrator->extractOne($entity, $attribute);
    }
    
    /**
     * Hydrate on property value of an entity
     * 
     * @param object $entity
     * @param string $attribute
     * @param mixed  $value
     */
    public function hydrateOne($entity, $attribute, $value)
    {
        $this->hydrator->hydrateOne($entity, $attribute, $value);
    }
    
    /**
     * Get primary key criteria
     * 
     * @param object $entity
     *
     * @return array
     */
    public function primaryCriteria($entity)
    {
        return $this->hydrator->flatExtract($entity, array_flip($this->metadata->primary['attributes']));
    }

    /**
     * Instanciate the related class entity
     *
     * @return object
     */
    public function instantiate()
    {
        return $this->serviceLocator->instantiator()
            ->instantiate($this->metadata->entityClass, $this->metadata->instantiatorHint);

Space found before object operator

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

    }

    /**
     * User api to instantiate related entity
     * 
     * @param array $data
     *
     * @return object
     */
    public function entity(array $data)
    {
        $entity = $this->instantiate();

        // Allows custom import from developpers.
        if ($entity instanceof ImportableInterface) {
            $entity->import($data);
        } else {
            $this->serviceLocator->hydrator($this->metadata->entityClass)
                ->hydrate($entity, $data);

Space found before object operator

Object operator not indented correctly; expected 14 spaces but found 16

        }

        return $entity;
    }

    /**
     * Transform entity to db one dimension array
     * 
     * @param object $entity      Entity object
     * @param array  $attributes  Attribute should be flipped as ['key' => true]
     *
     * @return array
     *
     * @throws \Exception

Comment missing for @throws tag in function comment

     */
    public function prepareToRepository($entity, array $attributes = null)
    {
        return $this->hydrator->flatExtract($entity, $attributes);
    }
    
    /**
     * Get valid array for entity
     * 
     * Inject one dimension array (db field) into entity
     * Map attribute and cast value

Doc comment long description must end with a full stop

     * 
     * $optimisation est un tableau donné par le query builder dans le but
     * d'optimiser le chargement des relations et des tableaux associatifs. Il contient les entités regroupés par
     * la valeur du champs demandé
     * 
     * @param array             $data  Db data
     * @param PlatformInterface $platform
     *
     * @return object
     */
    public function prepareFromRepository(array $data, PlatformInterface $platform)
    {
        $entity = $this->instantiate();

        $this->hydrator->flatHydrate($entity, $data, $platform->types());

        return $entity;
    }
    
    /**
     * Get the repository
     * 
     * @return RepositoryInterface
     */
    public function repository()
    {
        $className = $this->repositoryClass;

        return new $className($this, $this->serviceLocator, $this->resultCache === false ? null : $this->resultCache);

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

    }

    /**
     * Get the mapper info
     *
     * @return MapperInfo
     */
    public function info()
    {
        $platform = $this->serviceLocator->connection($this->metadata()->connection)->platform();

        return new MapperInfo($this, $platform->types());
    }

    /**
     * Get defined relation
     * 
     * Build object relation defined by user

Doc comment long description must end with a full stop

     * 
     * @param string $relationName
     *
     * @return array  Metadata for relation definition
     *
     * @throws \RuntimeException  If relation or type does not exist

@throws comment must be on the next line

@throws tag comment must end with a full stop

     */

Missing @throws tag for "RelationNotFoundException" exception

    public function relation($relationName)
    {
        $relations = $this->relations();
        
        if (!isset($relations[$relationName])) {
            throw new RelationNotFoundException('Relation "' . $relationName . '" is not set in ' . $this->metadata->entityName);
        }
        
        return $relations[$relationName];
    }
    
    //
    //------------ API configuration du mapping

No space found before comment text; expected "// ------------ API configuration du mapping" but found "//------------ API configuration du mapping"

    //
    
    /**
     * Definition du schema
     * 
     * Definition
     *  - connection         : The connection name declare in connection manager (mandatory).
     *  - database           : The database name.
     *  - table              : The table name (mandatory).
     *  - tableOptions       : The table options (ex: engine => myisam).
     * 
     * <code>
     *  return [
     *     'connection'   => (string),
     *     'database'     => (string),
     *     'table'        => (string),
     *     'tableOptions' => (array),
     *  ];
     * </code>
     * 
     * @return array|null
     */
    abstract public function schema();
    
    /**
     * Gets repository fields builder
     * 
     * @return FieldBuilder
     *
     * @todo should be final

Comment refers to a TODO task

     */
    public function fields()
    {
        $builder = new FieldBuilder();
        $this->buildFields($builder);

        foreach ($this->behaviors() as $behavior) {
            $behavior->changeSchema($builder);
        }

        return $builder;
    }
    
    /**
     * Build fields from this mapper.
     * 
     * To overwrite.
     * 
     * @param FieldBuilder $builder
     */

Missing @throws tag in function comment

    public function buildFields($builder)

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

The method parameter $builder is never used

Type hint "FieldBuilder" missing for $builder

    {
        throw new LogicException('Fields must be defined in mapper '.__CLASS__);
    }
    
    /**
     * Sequence definition.
     *
     * The metadata will build the sequence info using this method if the primary key is defined as sequence (Metadata::PK_SEQUENCE).
     * Definition:
     *  - connection         : The connection name declare in connection manager. The table connection will be used by default.
     *  - table              : The table sequence name.
     *                         The table name with suffix '_seq' will be used by default.
     *  - column             : The sequence column name. Default 'id'.
     *  - tableOptions       : The sequence table options (ex: engine => myisam).
     *
     * <code>
     *  return [
     *     'connection'   => (string),
     *     'table'        => (string),
     *     'column'       => (string),
     *     'tableOptions' => (array),
     *  ];
     * </code>
     * 
     * @return array
     */
    public function sequence()
    {
        return [
            'connection'   => null,
            'table'        => null,
            'column'       => null,
            'tableOptions' => [],
        ];
    }
    
    /**
     * Gets custom filters
     * To overwrite

Doc comment short description must be on a single line, further text should be a separate paragraph

     * 
     * <code>
     *  return [
     *      'customFilterName' => function(<Bdf\Prime\Query\QueryInterface> $query, <mixed> $value) {
     *          return <void>
     *      },
     *  ];
     * </code>
     * 
     * @return array
     */
    public function filters()
    {
        return [];
    }
    
    /**
     * Array of index
     * 
     * <code>
     *  return [
     *      ['attribute1', 'attribute2']
     *  ];
     * </code>
     * 
     * @return array
     *
     * @todo Make final

Comment refers to a TODO task

     */
    public function indexes()
    {
        $builder = new IndexBuilder();

        $this->buildIndexes($builder);

        return $builder->build();
    }

    /**
     * Build the table indexes
     * Note: Indexes can be added on undeclared fields

Doc comment short description must be on a single line, further text should be a separate paragraph

     *
     * <code>
     * public function buildIndexes(IndexBuilder $builder)
     * {
     *     $builder
     *         ->add()->on('name')->unique()
     *         ->add()->on('reference', ['length' => 12])
     *         ->add()->on(['type', 'date'])
     * }
     * </code>
     *
     * @param IndexBuilder $builder
     */
    public function buildIndexes(IndexBuilder $builder)

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

    {

    }

Function closing brace must go on the next line following the body; found 1 blank lines before brace

    
    /**
     * Repository extension
     * returns additionnals methods in repository

Doc comment short description must be on a single line, further text should be a separate paragraph

     * 
     * <code>
     * return [
     *     'customMethod' => function($query, $test) {
     *         
     *     },
     * ];
     * 
     * $repository->customMethod('test');
     * </code>
     * @return array

There must be exactly one blank line before the tags in a doc comment

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

@return doc comment specified, but function has no return statement

     */

Missing @throws tag in function comment

    public function scopes()
    {
        throw new LogicException('No scopes have been defined in "' . get_class($this) . '"');
    }

    /**
     * Get custom queries for repository
     * A custom query works mostly like scopes, but with some differences :
     * - Cannot be called using a query (i.e. $query->where(...)->myScope())
     * - The function has responsability of creating the query instance
     * - The first argument is the repository

Doc comment short description must be on a single line, further text should be a separate paragraph

     *
     * <code>
     * return [
     *     'findByCustom' => function (EntityRepository $repository, $search) {
     *         return $repository->make(MyCustomQuery::class)->where('first', $search)->first();
     *     }
     * ];
     * </code>
     *
     * @return callable[]
     */
    public function queries()
    {
        return [];
    }
    
    /**
     * Register event on notifier
     * 
     * @param \Bdf\Event\EventNotifier $notifier
     */
    public function events($notifier)

Type hint "\Bdf\Event\EventNotifier" missing for $notifier

    {
        $this->customEvents($notifier);

        foreach ($this->behaviors() as $behavior) {
            $behavior->subscribe($notifier);
        }
    }

    /**
     * Register custom event on notifier
     *
     * To overwrite.
     *
     * @param \Bdf\Event\EventNotifier $notifier
     */
    public function customEvents($notifier)

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

Type hint "\Bdf\Event\EventNotifier" missing for $notifier

    {
        // To overwrite
    }

    /**
     * Get all behaviors
     *
     * @return BehaviorInterface[]
     */
    final public function behaviors()
    {
        if ($this->behaviors === null) {
            $this->behaviors = $this->getDefinedBehaviors();
        }

        return $this->behaviors;
    }

    /**
     * Custom definition of behaviors
     *
     * To overwrite.
     *
     * @return BehaviorInterface[]
     */
    public function getDefinedBehaviors()
    {
        return [];
    }

    /**
     * Get all relations
     *
     * @return RelationBuilder
     *
     * @todo should be final

Comment refers to a TODO task

     */
    public function relations()
    {
        if ($this->relationBuilder === null) {
            $this->relationBuilder = new RelationBuilder();
            $this->buildRelations($this->relationBuilder);
        }

        return $this->relationBuilder;
    }

    /**
     * Build relations from this mapper.
     *
     * To overwrite.
     *
     * @param RelationBuilder $builder
     */
    public function buildRelations($builder)

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

Type hint "RelationBuilder" missing for $builder

    {
        // to overwrite

Inline comments must start with a capital letter

    }

    /**
     * Get all constraints
     * 
     * @return array
     */
    final public function constraints()
    {
        $constraints = $this->customConstraints();

        foreach ($this->behaviors() as $behavior) {
            $constraints += $behavior->constraints();
        }
        
        return $constraints;
    }

    /**
     * Register custom event on notifier
     *
     * To overwrite.
     * 
     * <code>
     * return [
     *     'attribute' => 'value'
     * ]
     * </code>
     * 
     * @return array
     */
    public function customConstraints()
    {
        return [];
    }

    /**
     * Clear dependencies for break cyclic references
     *
     * @internal
     */
    public function destroy()
    {
        $this->serviceLocator = null;
        $this->generator = null;
        $this->hydrator = null;
        $this->metadata = null;
    }
}