Metadata\MetadataFactory

Complexity

Total Complexity

33

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	13
Bugs	4	Features	3

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setIncludeInterfaces()	0	4	1
A	setCache()	0	4	1
A	addClassMetadata()	0	16	4
A	filterNullMetadata()	0	4	2
A	__construct()	0	6	1
C	getMetadataForClass()	0	60	16
A	getAllClassNames()	0	10	2
B	getClassHierarchy()	0	34	6

<?php

/*

Copyright notice too long

 * Copyright 2011 Johannes M. Schmitt <schmittjoh@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Metadata;

use Metadata\Driver\AdvancedDriverInterface;
use Metadata\Driver\DriverInterface;
use Metadata\Cache\CacheInterface;

class MetadataFactory implements AdvancedMetadataFactoryInterface

Missing class doc comment

{
    private $driver;

Tabs must be used to indent lines; spaces are not allowed

    private $cache;

Tabs must be used to indent lines; spaces are not allowed

    private $loadedMetadata = array();

Tabs must be used to indent lines; spaces are not allowed

    private $loadedClassMetadata = array();

Tabs must be used to indent lines; spaces are not allowed

    private $hierarchyMetadataClass;

Tabs must be used to indent lines; spaces are not allowed

    private $includeInterfaces = false;

Tabs must be used to indent lines; spaces are not allowed

    private $debug;

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param DriverInterface $driver

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     * @param string          $hierarchyMetadataClass

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     * @param boolean         $debug

Missing parameter comment

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

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function __construct(DriverInterface $driver, $hierarchyMetadataClass = 'Metadata\ClassHierarchyMetadata', $debug = false)

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $this->driver = $driver;

Tabs must be used to indent lines; spaces are not allowed

        $this->hierarchyMetadataClass = $hierarchyMetadataClass;

Tabs must be used to indent lines; spaces are not allowed

        $this->debug = (Boolean) $debug;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param boolean $include

Missing parameter comment

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

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    public function setIncludeInterfaces($include)

This function must always have a return value.

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $this->includeInterfaces = (Boolean) $include;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    public function setCache(CacheInterface $cache)

This function must always have a return value.

Missing function doc comment

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $this->cache = $cache;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param string $className

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return ClassHierarchyMetadata|MergeableClassMetadata|null

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function getMetadataForClass($className)

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        if (isset($this->loadedMetadata[$className])) {

Tabs must be used to indent lines; spaces are not allowed

            return $this->filterNullMetadata($this->loadedMetadata[$className]);

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        $metadata = null;

Tabs must be used to indent lines; spaces are not allowed

        foreach ($this->getClassHierarchy($className) as $class) {

Tabs must be used to indent lines; spaces are not allowed

            if (isset($this->loadedClassMetadata[$name = $class->getName()])) {

Tabs must be used to indent lines; spaces are not allowed

                if (null !== $classMetadata = $this->filterNullMetadata($this->loadedClassMetadata[$name])) {

Assignments in condition should be surrounded by the extra pair of brackets

Tabs must be used to indent lines; spaces are not allowed

                    $this->addClassMetadata($metadata, $classMetadata);

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

                continue;

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            // check the cache

Tabs must be used to indent lines; spaces are not allowed

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

Tabs must be used to indent lines; spaces are not allowed

                if (($classMetadata = $this->cache->loadClassMetadataFromCache($class)) instanceof NullMetadata) {

Tabs must be used to indent lines; spaces are not allowed

                    $this->loadedClassMetadata[$name] = $classMetadata;

Tabs must be used to indent lines; spaces are not allowed

                    continue;

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

                if (null !== $classMetadata) {

Tabs must be used to indent lines; spaces are not allowed

                    if ( ! $classMetadata instanceof ClassMetadata) {

Tabs must be used to indent lines; spaces are not allowed

                        throw new \LogicException(sprintf('The cache must return instances of ClassMetadata, but got %s.', var_export($classMetadata, true)));

Tabs must be used to indent lines; spaces are not allowed

                    }

Tabs must be used to indent lines; spaces are not allowed

                    if ($this->debug && !$classMetadata->isFresh()) {

Tabs must be used to indent lines; spaces are not allowed

                        $this->cache->evictClassMetadataFromCache($classMetadata->reflection);

Tabs must be used to indent lines; spaces are not allowed

                    } else {

Tabs must be used to indent lines; spaces are not allowed

                        $this->loadedClassMetadata[$name] = $classMetadata;

Tabs must be used to indent lines; spaces are not allowed

                        $this->addClassMetadata($metadata, $classMetadata);

Tabs must be used to indent lines; spaces are not allowed

                        continue;

Tabs must be used to indent lines; spaces are not allowed

                    }

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            // load from source

Tabs must be used to indent lines; spaces are not allowed

            if (null !== $classMetadata = $this->driver->loadMetadataForClass($class)) {

Assignments in condition should be surrounded by the extra pair of brackets

Tabs must be used to indent lines; spaces are not allowed

                $this->loadedClassMetadata[$name] = $classMetadata;

Tabs must be used to indent lines; spaces are not allowed

                $this->addClassMetadata($metadata, $classMetadata);

Tabs must be used to indent lines; spaces are not allowed

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

Tabs must be used to indent lines; spaces are not allowed

                    $this->cache->putClassMetadataInCache($classMetadata);

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

                continue;

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            if (null !== $this->cache && !$this->debug) {

Tabs must be used to indent lines; spaces are not allowed

                $this->cache->putClassMetadataInCache(new NullMetadata($class->getName()));

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        if (null === $metadata) {

Tabs must be used to indent lines; spaces are not allowed

            $metadata = new NullMetadata($className);

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        return $this->filterNullMetadata($this->loadedMetadata[$className] = $metadata);

$this->loadedMetadata[$className] = $metadata is of type object<Metadata\ClassMetadata>, but the function expects a object<Metadata\NullMetadata>|null.

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * {@inheritDoc}

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    public function getAllClassNames()

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        if (!$this->driver instanceof AdvancedDriverInterface) {

Tabs must be used to indent lines; spaces are not allowed

            throw new \RuntimeException(

Tabs must be used to indent lines; spaces are not allowed

                sprintf('Driver "%s" must be an instance of "AdvancedDriverInterface".', get_class($this->driver))

Tabs must be used to indent lines; spaces are not allowed

            );

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        return $this->driver->getAllClassNames();

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param ClassMetadata|null $metadata

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     * @param ClassMetadata      $toAdd

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    private function addClassMetadata(&$metadata, $toAdd)

Type hint "ClassMetadata" missing for $toAdd

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        if ($toAdd instanceof MergeableInterface) {

Tabs must be used to indent lines; spaces are not allowed

            if (null === $metadata) {

Tabs must be used to indent lines; spaces are not allowed

                $metadata = clone $toAdd;

Tabs must be used to indent lines; spaces are not allowed

            } else {

Tabs must be used to indent lines; spaces are not allowed

                $metadata->merge($toAdd);

It seems like you code against a specific sub-type and not the parent class Metadata\ClassMetadata as the method merge() does only exist in the following sub-classes of Metadata\ClassMetadata: Metadata\MergeableClassMetadata. Maybe you want to instanceof check for one of these explicitly?

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

        } else {

Tabs must be used to indent lines; spaces are not allowed

            if (null === $metadata) {

Tabs must be used to indent lines; spaces are not allowed

                $metadata = new $this->hierarchyMetadataClass;

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            $metadata->addClassMetadata($toAdd);

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param string $class

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     */

Missing @return tag in function comment

Tabs must be used to indent lines; spaces are not allowed

    private function getClassHierarchy($class)

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        $classes = array();

Tabs must be used to indent lines; spaces are not allowed

        $refl = new \ReflectionClass($class);

Tabs must be used to indent lines; spaces are not allowed

        do {

Tabs must be used to indent lines; spaces are not allowed

            $classes[] = $refl;

Tabs must be used to indent lines; spaces are not allowed

            $refl = $refl->getParentClass();

Tabs must be used to indent lines; spaces are not allowed

        } while (false !== $refl);

Tabs must be used to indent lines; spaces are not allowed

        $classes = array_reverse($classes, false);

Tabs must be used to indent lines; spaces are not allowed

        if (!$this->includeInterfaces) {

Tabs must be used to indent lines; spaces are not allowed

            return $classes;

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        $addedInterfaces = array();

Tabs must be used to indent lines; spaces are not allowed

        $newHierarchy = array();

Tabs must be used to indent lines; spaces are not allowed

        foreach ($classes as $class) {

Tabs must be used to indent lines; spaces are not allowed

            foreach ($class->getInterfaces() as $interface) {

Tabs must be used to indent lines; spaces are not allowed

                if (isset($addedInterfaces[$interface->getName()])) {

Tabs must be used to indent lines; spaces are not allowed

                    continue;

Tabs must be used to indent lines; spaces are not allowed

                }

Tabs must be used to indent lines; spaces are not allowed

                $addedInterfaces[$interface->getName()] = true;

Tabs must be used to indent lines; spaces are not allowed

                $newHierarchy[] = $interface;

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            $newHierarchy[] = $class;

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        return $newHierarchy;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Missing short description in doc comment

Tabs must be used to indent lines; spaces are not allowed

     * @param NullMetadata|null $metadata

Missing parameter comment

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return ClassMetadata|null

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    private function filterNullMetadata($metadata = null)

Tabs must be used to indent lines; spaces are not allowed

    {

Tabs must be used to indent lines; spaces are not allowed

        return !$metadata instanceof NullMetadata ? $metadata : null;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

}