Item::firstOf() - Code Metrics - Inspection of "Finished property getters" - jkphl/micrometa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v2 ( 7442ee...58f91a )

by Joschi

created 2017-04-12 18:49 UTC

Item::firstOf() A

↳ Parent: Item::getFirstProperty()

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php

/**
 * micrometa
 *
 * @category Jkphl
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 * @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\Micrometa\Ports\Item;

use Jkphl\Micrometa\Application\Item\ItemInterface as ApplicationItemInterface;
use Jkphl\Micrometa\Domain\Exceptions\OutOfBoundsException as DomainOutOfBoundsException;
use Jkphl\Micrometa\Infrastructure\Factory\ProfiledNamesFactory;
use Jkphl\Micrometa\Infrastructure\Parser\ProfiledNamesList;
use Jkphl\Micrometa\Ports\Exceptions\InvalidArgumentException;
use Jkphl\Micrometa\Ports\Exceptions\OutOfBoundsException;

/**
 * Micro information item
 *
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 */
class Item implements ItemInterface
{
    /**
     * Application item
     *
     * @var ApplicationItemInterface
     */
    protected $item;

    /**
     * Item constructor
     *
     * @param ApplicationItemInterface $item Application item
     */
    public function __construct(ApplicationItemInterface $item)
    {
        $this->item = $item;
    }

    /**
     * Return whether the item is of a particular type (or contained in a list of types)
     *
     * The item type(s) can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
     *
     * @param string $name Name
     * @param string|null $profile Profile
     * @return boolean Item type is contained in the list of types
     */
    public function isOfType($name, $profile = null)
    {
        /** @var ProfiledNamesList $types */
        $types = ProfiledNamesFactory::createFromArguments(func_get_args());

        // Run through all item types
        /** @var \stdClass $itemType */
        foreach ($this->item->getType() as $itemType) {
            // Run through all query types
            /** @var \stdClass $queryType */
            foreach ($types as $queryType) {
                if (($queryType->name == $itemType->name) &&
                    (($queryType->profile === null) ? true : ($queryType->profile == $itemType->profile))
                ) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * Get the first value of an item property
     *
     * @param string $name Item property name
     * @return string First value of an item property
     */
    public function __get($name)
    {
        return $this->getProperty($name, null, 0);
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());
}
    }

    /**
     * Get a single property (value)
     *
     * @param string $name Property name
     * @param string $profile Property profile
     * @param int $index Property value index
     * @return array|string|ItemInterface Property value(s)
     * @throws OutOfBoundsException If the property name is unknown
     * @throws OutOfBoundsException If the property value index is out of bounds
     */
    public function getProperty($name, $profile = null, $index = null)
    {
        try {
            $propertyValues = $this->item->getProperty($name, $profile);
        } catch (DomainOutOfBoundsException $e) {
            throw new OutOfBoundsException($e->getMessage(), $e->getCode());
        }

        // If all property values should be returned
        if ($index === null) {
            return $propertyValues;
        }

        // If the property value index is out of bounds
        if (!isset($propertyValues[$index])) {
            throw new OutOfBoundsException(
                sprintf(OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX_STR, $index),
                OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX
            );
        }

        return $propertyValues[$index];
    }

    /**
     * Get all values of the first available property in a stack
     *
     * The property stack can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
     *
     * @param string $name Name
     * @param string $profile Profile
     * @return array Property values
     * @throws InvalidArgumentException If no property name was given
     * @throws OutOfBoundsException If none of the requested properties is known
     */
    public function getFirstProperty($name, $profile = null)
    {
        /** @var ProfiledNamesList $properties */
        $properties = ProfiledNamesFactory::createFromArguments(func_get_args());

        // Prepare a default exception
        $e = new OutOfBoundsException(
            OutOfBoundsException::NONMATCHING_PROPERTY_STACK_STR,
            OutOfBoundsException::NONMATCHING_PROPERTY_STACK
        );

        // Run through all properties
        foreach ($properties as $property) {
            try {
                return $this->getProperty($property->name, $property->profile);
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 (OutOfBoundsException $e) {
                continue;
            }
        }

        throw $e;
    }
}


1		<?php
2
3		/**
4		* micrometa
5		*
6		* @category Jkphl
7		* @package Jkphl\Micrometa
8		* @subpackage Jkphl\Micrometa\Ports
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\Micrometa\Ports\Item;
38
39		use Jkphl\Micrometa\Application\Item\ItemInterface as ApplicationItemInterface;
40		use Jkphl\Micrometa\Domain\Exceptions\OutOfBoundsException as DomainOutOfBoundsException;
41		use Jkphl\Micrometa\Infrastructure\Factory\ProfiledNamesFactory;
42		use Jkphl\Micrometa\Infrastructure\Parser\ProfiledNamesList;
43		use Jkphl\Micrometa\Ports\Exceptions\InvalidArgumentException;
44		use Jkphl\Micrometa\Ports\Exceptions\OutOfBoundsException;
45
46		/**
47		* Micro information item
48		*
49		* @package Jkphl\Micrometa
50		* @subpackage Jkphl\Micrometa\Ports
51		*/
52		class Item implements ItemInterface
53		{
54		/**
55		* Application item
56		*
57		* @var ApplicationItemInterface
58		*/
59		protected $item;
60
61		/**
62		* Item constructor
63		*
64		* @param ApplicationItemInterface $item Application item
65		*/
66	6	public function __construct(ApplicationItemInterface $item)
67		{
68	6	$this->item = $item;
69	6	}
70
71		/**
72		* Return whether the item is of a particular type (or contained in a list of types)
73		*
74		* The item type(s) can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
75		*
76		* @param string $name Name
77		* @param string\|null $profile Profile
78		* @return boolean Item type is contained in the list of types
79		*/
80	1	public function isOfType($name, $profile = null)
81		{
82		/** @var ProfiledNamesList $types */
83	1	$types = ProfiledNamesFactory::createFromArguments(func_get_args());
84
85		// Run through all item types
86		/** @var \stdClass $itemType */
87	1	foreach ($this->item->getType() as $itemType) {
88		// Run through all query types
89		/** @var \stdClass $queryType */
90	1	foreach ($types as $queryType) {
91	1	if (($queryType->name == $itemType->name) &&
92	1	(($queryType->profile === null) ? true : ($queryType->profile == $itemType->profile))
93		) {
94	1	return true;
95		}
96		}
97		}
98
99		return false;
100		}
101
102		/**
103		* Get the first value of an item property
104		*
105		* @param string $name Item property name
106		* @return string First value of an item property
107		*/
108	1	public function __get($name)
109		{
110	1	return $this->getProperty($name, null, 0);
		0 ignored issues – show Bug Best Practice introduced 2017-04-12 18:53 UTC by Report Bug Copy Issue Report The return type of `return $this->getProperty($name, null, 0);` (`array\|string\|Jkphl\Micro...orts\Item\ItemInterface`) is incompatible with the return type declared by the interface `Jkphl\Micrometa\Ports\Item\ItemInterface::__get` of type `string`. 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...
111		}
112
113		/**
114		* Get a single property (value)
115		*
116		* @param string $name Property name
117		* @param string $profile Property profile
118		* @param int $index Property value index
119		* @return array\|string\|ItemInterface Property value(s)
120		* @throws OutOfBoundsException If the property name is unknown
121		* @throws OutOfBoundsException If the property value index is out of bounds
122		*/
123	4	public function getProperty($name, $profile = null, $index = null)
124		{
125		try {
126	4	$propertyValues = $this->item->getProperty($name, $profile);
127	4	} catch (DomainOutOfBoundsException $e) {
128	4	throw new OutOfBoundsException($e->getMessage(), $e->getCode());
129		}
130
131		// If all property values should be returned
132	4	if ($index === null) {
133	4	return $propertyValues;
134		}
135
136		// If the property value index is out of bounds
137	3	if (!isset($propertyValues[$index])) {
138		throw new OutOfBoundsException(
139		sprintf(OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX_STR, $index),
140		OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX
141		);
142		}
143
144	3	return $propertyValues[$index];
145		}
146
147		/**
148		* Get all values of the first available property in a stack
149		*
150		* The property stack can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
151		*
152		* @param string $name Name
153		* @param string $profile Profile
154		* @return array Property values
155		* @throws InvalidArgumentException If no property name was given
156		* @throws OutOfBoundsException If none of the requested properties is known
157		*/
158	1	public function getFirstProperty($name, $profile = null)
159		{
160		/** @var ProfiledNamesList $properties */
161	1	$properties = ProfiledNamesFactory::createFromArguments(func_get_args());
162
163		// Prepare a default exception
164	1	$e = new OutOfBoundsException(
165	1	OutOfBoundsException::NONMATCHING_PROPERTY_STACK_STR,
166	1	OutOfBoundsException::NONMATCHING_PROPERTY_STACK
167		);
168
169		// Run through all properties
170	1	foreach ($properties as $property) {
171		try {
172	1	return $this->getProperty($property->name, $property->profile);
		0 ignored issues – show Bug Best Practice introduced 2017-04-12 18:53 UTC by Report Bug Copy Issue Report The return type of `return $this->getPropert...e, $property->profile);` (`array\|string\|Jkphl\Micro...orts\Item\ItemInterface`) is incompatible with the return type declared by the interface `Jkphl\Micrometa\Ports\It...rface::getFirstProperty` 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...
173	1	} catch (OutOfBoundsException $e) {
174	1	continue;
175		}
176		}
177
178	1	throw $e;
179		}
180		}
181

jkphl / micrometa

Push — v2 ( 7442ee...58f91a )

Item::firstOf() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like