Thing::validatePropertyName() - Code Metrics - Inspection of "Added RDFa Lite element processor property registr..." - jkphl/rdfa-lite-microdata - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( da3279...199ae8 )

by Joschi

created 2017-02-14 00:46 UTC

Thing::validatePropertyName() A

↳ Parent: Thing

Complexity

Conditions	3
Paths	2

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	13
c	0
b	0
f	0
ccs	6
cts	6
cp	1
rs	9.4285
cc	3
eloc	6
nc	2
nop	1
crap	3

<?php

/**
 * rdfa-lite
 *
 * @category Jkphl
 * @package Jkphl\Rdfalite
 * @subpackage Jkphl\Rdfalite\Domain
 * @author Joschi Kuphal <[email protected]> / @jkphl
 * @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Rdfalite\Domain\Thing;

use Jkphl\Rdfalite\Domain\Exceptions\OutOfBoundsException;
use Jkphl\Rdfalite\Domain\Exceptions\RuntimeException;
use Jkphl\Rdfalite\Domain\Property\Property;
use Jkphl\Rdfalite\Domain\Property\PropertyInterface;
use Jkphl\Rdfalite\Domain\Vocabulary\VocabularyInterface;

/**
 * Thing
 *
 * @package Jkphl\Rdfalite
 * @subpackage Jkphl\Rdfalite\Domain
 */
class Thing implements ThingInterface
{
    /**
     * Resource type
     *
     * @var string
     */
    protected $type;
    /**
     * Resource vocabulary
     *
     * @var VocabularyInterface
     */
    protected $vocabulary;
    /**
     * Resource ID
     *
     * @var string|null
     */
    protected $resourceId = null;
    /**
     * Child things
     *
     * @var ThingInterface[]
     */
    protected $children = [];
    /**
     * Property
     *
     * @var array[]
     */
    protected $properties = [];

    /**
     * Thing constructor
     *
     * @param string $type Resource type
     * @param VocabularyInterface $vocabulary Vocabulary in use
     * @param null|string $resourceId Resource id
     */
    public function __construct($type, VocabularyInterface $vocabulary, $resourceId = null)
    {
        $type = trim($type);
        if (!strlen($type)) {
            throw new RuntimeException(
                sprintf(RuntimeException::INVALID_RESOURCE_TYPE_STR, $type, $vocabulary->getUri()),
                RuntimeException::INVALID_RESOURCE_TYPE
            );
        }

        $this->vocabulary = $vocabulary;
        $this->type = $this->vocabulary->expand($type);
        $this->resourceId = $resourceId;
    }

    /**
     * Return the resource type
     *
     * @return string Resource type
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Return the vocabulary in use
     *
     * @return VocabularyInterface Vocabulary
     */
    public function getVocabulary()
    {
        return $this->vocabulary;
    }

    /**
     * Return the resource ID
     *
     * @return null|string Resource ID
     */
    public function getResourceId()
    {
        return $this->resourceId;
    }

    /**
     * Add a property value
     *
     * @param PropertyInterface $property Property
     * @return Thing Self reference
     */
    public function addProperty(PropertyInterface $property)
    {
        // Create the property values list if necessary
        if (!array_key_exists($property->getName(), $this->properties)) {
            $this->properties[$property->getName()] = [];
        }

        // Register the property value
        $this->properties[$property->getName()][] = $property;

        return $this;
    }

    /**
     * Return all properties
     *
     * @return array[] Properties
     */
    public function getProperties()
    {
        return $this->properties;
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());
}
    }

    /**
     * Return the values of a single property
     *
     * @param string $name Property name
     * @return array Property values
     */
    public function getProperty($name)
    {
        $name = Property::validatePropertyName($name);

        // If the property name is unknown
        if (!array_key_exists($name, $this->properties)) {
            throw new OutOfBoundsException(
                sprintf(OutOfBoundsException::UNKNOWN_PROPERTY_NAME_STR, $name),
                OutOfBoundsException::UNKNOWN_PROPERTY_NAME
            );
        }

        return $this->properties[$name];
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());
}
    }

    /**
     * Add a child
     *
     * @param ThingInterface $child Child
     * @return Thing Self reference
     */
    public function addChild(ThingInterface $child)
    {
        $this->children[spl_object_hash($child)] = $child;
        return $this;
    }

    /**
     * Return all children
     *
     * @return ThingInterface[] Children
     */
    public function getChildren()
    {
        return array_values($this->children);
    }
}


1		<?php
2
3		/**
4		* rdfa-lite
5		*
6		* @category Jkphl
7		* @package Jkphl\Rdfalite
8		* @subpackage Jkphl\Rdfalite\Domain
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Rdfalite\Domain\Thing;
38
39		use Jkphl\Rdfalite\Domain\Exceptions\OutOfBoundsException;
40		use Jkphl\Rdfalite\Domain\Exceptions\RuntimeException;
41		use Jkphl\Rdfalite\Domain\Property\Property;
42		use Jkphl\Rdfalite\Domain\Property\PropertyInterface;
43		use Jkphl\Rdfalite\Domain\Vocabulary\VocabularyInterface;
44
45		/**
46		* Thing
47		*
48		* @package Jkphl\Rdfalite
49		* @subpackage Jkphl\Rdfalite\Domain
50		*/
51		class Thing implements ThingInterface
52		{
53		/**
54		* Resource type
55		*
56		* @var string
57		*/
58		protected $type;
59		/**
60		* Resource vocabulary
61		*
62		* @var VocabularyInterface
63		*/
64		protected $vocabulary;
65		/**
66		* Resource ID
67		*
68		* @var string\|null
69		*/
70		protected $resourceId = null;
71		/**
72		* Child things
73		*
74		* @var ThingInterface[]
75		*/
76		protected $children = [];
77		/**
78		* Property
79		*
80		* @var array[]
81		*/
82		protected $properties = [];
83
84		/**
85		* Thing constructor
86		*
87		* @param string $type Resource type
88		* @param VocabularyInterface $vocabulary Vocabulary in use
89		* @param null\|string $resourceId Resource id
90		*/
91	8	public function __construct($type, VocabularyInterface $vocabulary, $resourceId = null)
92		{
93	8	$type = trim($type);
94	8	if (!strlen($type)) {
95	1	throw new RuntimeException(
96	1	sprintf(RuntimeException::INVALID_RESOURCE_TYPE_STR, $type, $vocabulary->getUri()),
97		RuntimeException::INVALID_RESOURCE_TYPE
98	1	);
99		}
100
101	7	$this->vocabulary = $vocabulary;
102	7	$this->type = $this->vocabulary->expand($type);
103	7	$this->resourceId = $resourceId;
104	7	}
105
106		/**
107		* Return the resource type
108		*
109		* @return string Resource type
110		*/
111	1	public function getType()
112		{
113	1	return $this->type;
114		}
115
116		/**
117		* Return the vocabulary in use
118		*
119		* @return VocabularyInterface Vocabulary
120		*/
121	1	public function getVocabulary()
122		{
123	1	return $this->vocabulary;
124		}
125
126		/**
127		* Return the resource ID
128		*
129		* @return null\|string Resource ID
130		*/
131	2	public function getResourceId()
132		{
133	2	return $this->resourceId;
134		}
135
136		/**
137		* Add a property value
138		*
139		* @param PropertyInterface $property Property
140		* @return Thing Self reference
141		*/
142	1	public function addProperty(PropertyInterface $property)
143		{
144		// Create the property values list if necessary
145	1	if (!array_key_exists($property->getName(), $this->properties)) {
146	1	$this->properties[$property->getName()] = [];
147	1	}
148
149		// Register the property value
150	1	$this->properties[$property->getName()][] = $property;
151
152	1	return $this;
153		}
154
155		/**
156		* Return all properties
157		*
158		* @return array[] Properties
159		*/
160	2	public function getProperties()
161		{
162	2	return $this->properties;
		0 ignored issues – show Bug Best Practice introduced 2017-02-14 00:49 UTC by Report Bug Copy Issue Report The return type of `return $this->properties;` (`array[]`) is incompatible with the return type declared by the interface `Jkphl\Rdfalite\Domain\Th...nterface::getProperties` of type `Jkphl\Rdfalite\Domain\Property\PropertyInterface[]`. 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...
163		}
164
165		/**
166		* Return the values of a single property
167		*
168		* @param string $name Property name
169		* @return array Property values
170		*/
171	2	public function getProperty($name)
172		{
173	2	$name = Property::validatePropertyName($name);
174
175		// If the property name is unknown
176	2	if (!array_key_exists($name, $this->properties)) {
177	1	throw new OutOfBoundsException(
178	1	sprintf(OutOfBoundsException::UNKNOWN_PROPERTY_NAME_STR, $name),
179		OutOfBoundsException::UNKNOWN_PROPERTY_NAME
180	1	);
181		}
182
183	1	return $this->properties[$name];
		0 ignored issues – show Bug Best Practice introduced 2017-02-14 00:49 UTC by Report Bug Copy Issue Report The return type of `return $this->properties[$name];` (`array`) is incompatible with the return type declared by the interface `Jkphl\Rdfalite\Domain\Th...gInterface::getProperty` of type `Jkphl\Rdfalite\Domain\Property\PropertyInterface`. 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...
184		}
185
186		/**
187		* Add a child
188		*
189		* @param ThingInterface $child Child
190		* @return Thing Self reference
191		*/
192	2	public function addChild(ThingInterface $child)
193		{
194	2	$this->children[spl_object_hash($child)] = $child;
195	2	return $this;
196		}
197
198		/**
199		* Return all children
200		*
201		* @return ThingInterface[] Children
202		*/
203	3	public function getChildren()
204		{
205	3	return array_values($this->children);
206		}
207		}
208

jkphl / rdfa-lite-microdata

Push — master ( da3279...199ae8 )

Thing::validatePropertyName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like