Author::addElement() - Code Metrics - Inspection of "Merge pull request #147 from alexdebril/project/ph..." - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4c7da2...64af60 )

by Alex

created 2017-10-04 12:43 UTC

Author::addElement() A

↳ Parent: Author

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
ccs	7
cts	7
cp	1
rs	9.6666
cc	1
eloc	6
nc	1
nop	3
crap	1

<?php declare(strict_types=1);
/*
 * This file is part of the feed-io package.
 *
 * (c) Alexandre Debril <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FeedIo\Rule\Atom;

use FeedIo\Feed\ItemInterface;
use FeedIo\Feed\NodeInterface;
use FeedIo\Rule\Author as BaseAuthor;

class Author extends BaseAuthor
{
    const NODE_NAME = 'author';

    /**
     * @param  NodeInterface $node
     * @param  \DOMElement   $element
     * @return mixed
     */
    public function setProperty(NodeInterface $node, \DOMElement $element) : void
    {
        if ($node instanceof ItemInterface) {
            $author = $node->newAuthor();
            $author->setName($this->getChildValue($element, 'name'));
            $author->setUri($this->getChildValue($element, 'uri'));
            $author->setEmail($this->getChildValue($element, 'email'));
            $node->setAuthor($author);
        }
    }

    /**
     * @inheritDoc
     */
    protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
    {
        $element = $document->createElement(static::NODE_NAME);
        $element->appendChild($document->createElement('name', $node->getAuthor()->getName()));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $element->appendChild($document->createElement('uri', $node->getAuthor()->getUri()));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $element->appendChild($document->createElement('email', $node->getAuthor()->getEmail()));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $rootElement->appendChild($element);
    }
}


Push — master ( 4c7da2...64af60 )

Author::addElement() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

1		<?php declare(strict_types=1);
2		/*
3		* This file is part of the feed-io package.
4		*
5		* (c) Alexandre Debril <[email protected]>
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 FeedIo\Rule\Atom;
12
13		use FeedIo\Feed\ItemInterface;
14		use FeedIo\Feed\NodeInterface;
15		use FeedIo\Rule\Author as BaseAuthor;
16
17		class Author extends BaseAuthor
18		{
19		const NODE_NAME = 'author';
20
21		/**
22		* @param NodeInterface $node
23		* @param \DOMElement $element
24		* @return mixed
25		*/
26	3	public function setProperty(NodeInterface $node, \DOMElement $element) : void
27		{
28	3	if ($node instanceof ItemInterface) {
29	3	$author = $node->newAuthor();
30	3	$author->setName($this->getChildValue($element, 'name'));
31	3	$author->setUri($this->getChildValue($element, 'uri'));
32	3	$author->setEmail($this->getChildValue($element, 'email'));
33	3	$node->setAuthor($author);
34		}
35	3	}
36
37		/**
38		* @inheritDoc
39		*/
40	1	protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
41		{
42	1	$element = $document->createElement(static::NODE_NAME);
43	1	$element->appendChild($document->createElement('name', $node->getAuthor()->getName()));
		0 ignored issues – show Bug introduced 2017-08-01 15:46 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `FeedIo\Feed\NodeInterface` as the method `getAuthor()` does only exist in the following implementations of said interface: `FeedIo\Feed\Item`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
44	1	$element->appendChild($document->createElement('uri', $node->getAuthor()->getUri()));
		0 ignored issues – show Bug introduced 2017-08-01 15:46 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `FeedIo\Feed\NodeInterface` as the method `getAuthor()` does only exist in the following implementations of said interface: `FeedIo\Feed\Item`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45	1	$element->appendChild($document->createElement('email', $node->getAuthor()->getEmail()));
		0 ignored issues – show Bug introduced 2017-08-01 15:46 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `FeedIo\Feed\NodeInterface` as the method `getAuthor()` does only exist in the following implementations of said interface: `FeedIo\Feed\Item`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
46
47	1	$rootElement->appendChild($element);
48	1	}
49		}
50

alexdebril / feed-io

Push — master ( 4c7da2...64af60 )

Author::addElement() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like