AbstractYamlDriver::loadMetadataFromFile() - Code Metrics - cubiche/metadata - Measure and Improve Code Quality continuously with Scrutinizer

AbstractYamlDriver::loadMetadataFromFile() A
last analyzed 2017-10-05 09:27 UTC

↳ Parent: AbstractYamlDriver

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	9

Duplication

Lines	15
Ratio	100 %

Importance

Changes

Metric	Value
dl	15
loc	15
c	0
b	0
f	0
rs	9.4285
cc	2
eloc	9
nc	2
nop	2

<?php
/**
 * This file is part of the Cubiche package.
 *
 * Copyright (c) Cubiche
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cubiche\Core\Metadata\Driver;

use Cubiche\Core\Metadata\ClassMetadata;
use Cubiche\Core\Metadata\ClassMetadataInterface;
use Cubiche\Core\Metadata\Exception\MappingException;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;

/**
 * AbstractYamlDriver class.
 *
 * @author Ivannis Suárez Jerez <[email protected]>
 */
abstract class AbstractYamlDriver extends AbstractFileDriver
{
    /**
     * @var string
     */
    protected $className;

    /**
     * {@inheritdoc}
     */
    protected function loadMetadataFromFile($className, $file)

    {
        $this->className = $className;
        $config = $this->getElement($className, $file);

        try {
            $classMetadata = new ClassMetadata($className);
        } catch (\ReflectionException $e) {
            throw MappingException::classNotFound($className);
        }

        $this->addMetadataFor($config, $classMetadata);

        return $classMetadata;
    }

    /**
     * {@inheritdoc}
     */
    protected function loadMappingFile($file)
    {
        try {
            return Yaml::parse(file_get_contents($file));
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        } catch (ParseException $e) {
            throw MappingException::invalidMapping($this->className, $file);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function getExtension()
    {
        return '.yml';
    }

    /**
     * @param array                  $config
     * @param ClassMetadataInterface $classMetadata
     */
    abstract protected function addMetadataFor(array $config, ClassMetadataInterface $classMetadata);
}


1		<?php
2		/**
3		* This file is part of the Cubiche package.
4		*
5		* Copyright (c) Cubiche
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace Cubiche\Core\Metadata\Driver;
12
13		use Cubiche\Core\Metadata\ClassMetadata;
14		use Cubiche\Core\Metadata\ClassMetadataInterface;
15		use Cubiche\Core\Metadata\Exception\MappingException;
16		use Symfony\Component\Yaml\Exception\ParseException;
17		use Symfony\Component\Yaml\Yaml;
18
19		/**
20		* AbstractYamlDriver class.
21		*
22		* @author Ivannis Suárez Jerez <[email protected]>
23		*/
24		abstract class AbstractYamlDriver extends AbstractFileDriver
25		{
26		/**
27		* @var string
28		*/
29		protected $className;
30
31		/**
32		* {@inheritdoc}
33		*/
34	View Code Duplication	protected function loadMetadataFromFile($className, $file)
		0 ignored issues – show Duplication introduced 2017-10-05 09:26 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
35		{
36		$this->className = $className;
37		$config = $this->getElement($className, $file);
38
39		try {
40		$classMetadata = new ClassMetadata($className);
41		} catch (\ReflectionException $e) {
42		throw MappingException::classNotFound($className);
43		}
44
45		$this->addMetadataFor($config, $classMetadata);
46
47		return $classMetadata;
48		}
49
50		/**
51		* {@inheritdoc}
52		*/
53		protected function loadMappingFile($file)
54		{
55		try {
56		return Yaml::parse(file_get_contents($file));
		0 ignored issues – show Bug Best Practice introduced 2017-05-24 18:06 UTC by Report Bug Copy Issue Report The return type of `return \Symfony\Componen...e_get_contents($file));` (`null\|Symfony\Component\Y...e\|string\|array\|stdClass`) is incompatible with the return type declared by the abstract method `Cubiche\Core\Metadata\Dr...Driver::loadMappingFile` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
57		} catch (ParseException $e) {
58		throw MappingException::invalidMapping($this->className, $file);
59		}
60		}
61
62		/**
63		* {@inheritdoc}
64		*/
65		protected function getExtension()
66		{
67		return '.yml';
68		}
69
70		/**
71		* @param array $config
72		* @param ClassMetadataInterface $classMetadata
73		*/
74		abstract protected function addMetadataFor(array $config, ClassMetadataInterface $classMetadata);
75		}
76

cubiche / metadata

AbstractYamlDriver::loadMetadataFromFile() A last analyzed 2017-10-05 09:27 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractYamlDriver::loadMetadataFromFile() A
last analyzed 2017-10-05 09:27 UTC