Media::createMediaElement() - Code Metrics - Inspection of "Add support for image property on FeedInterface Rs..." - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#230)

unknown

created 2019-10-05 04:04 UTC

Media::createMediaElement() A

↳ Parent: Media

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	6
cp	0
rs	9.9666
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	2

<?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;

use FeedIo\Feed\Item;
use FeedIo\Feed\Item\MediaInterface;
use FeedIo\Feed\ItemInterface;
use FeedIo\Feed\NodeInterface;
use FeedIo\RuleAbstract;

class Media extends RuleAbstract
{
    const NODE_NAME = 'enclosure';

    protected $urlAttributeName = 'url';

    /**
     * @return string
     */
    public function getUrlAttributeName() : string
    {
        return $this->urlAttributeName;
    }

    /**
     * @param  string $name
     */
    public function setUrlAttributeName(string $name) : void
    {
        $this->urlAttributeName = $name;
    }

    /**
     * @param  NodeInterface $node
     * @param  \DOMElement   $element
     */
    public function setProperty(NodeInterface $node, \DOMElement $element) : void
    {
        if ($node instanceof ItemInterface) {
            $media = $node->newMedia();
            $media->setNodeName($element->nodeName)
                ->setType($this->getAttributeValue($element, 'type'))
                ->setUrl($this->getAttributeValue($element, $this->getUrlAttributeName()))
                ->setLength($this->getAttributeValue($element, 'length'));

            $node->addMedia($media);
        }
    }

    /**
     * @param  \DomDocument   $document
     * @param  MediaInterface $media
     * @return \DomElement
     */
    public function createMediaElement(\DomDocument $document, MediaInterface $media) : \DOMElement
    {
        $element = $document->createElement($this->getNodeName());
        $element->setAttribute($this->getUrlAttributeName(), $media->getUrl());
        $element->setAttribute('type', $media->getType() ?? '');
        $element->setAttribute('length', $media->getLength() ?? '');

        return $element;
    }

    /**
     * @inheritDoc
     */
    protected function hasValue(NodeInterface $node) : bool
    {
        return $node instanceof ItemInterface && !! $node->getMedias();
    }

    /**
     * @inheritDoc
     */
    protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
    {
        foreach ($node->getMedias() as $media) {
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($this->createMediaElement($document, $media));
        }
    }
}


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;
12
13		use FeedIo\Feed\Item;
14		use FeedIo\Feed\Item\MediaInterface;
15		use FeedIo\Feed\ItemInterface;
16		use FeedIo\Feed\NodeInterface;
17		use FeedIo\RuleAbstract;
18
19		class Media extends RuleAbstract
20		{
21		const NODE_NAME = 'enclosure';
22
23		protected $urlAttributeName = 'url';
24
25		/**
26		* @return string
27		*/
28	2	public function getUrlAttributeName() : string
29		{
30	2	return $this->urlAttributeName;
31		}
32
33		/**
34		* @param string $name
35		*/
36	7	public function setUrlAttributeName(string $name) : void
37		{
38	7	$this->urlAttributeName = $name;
39	7	}
40
41		/**
42		* @param NodeInterface $node
43		* @param \DOMElement $element
44		*/
45	2	public function setProperty(NodeInterface $node, \DOMElement $element) : void
46		{
47	2	if ($node instanceof ItemInterface) {
48	2	$media = $node->newMedia();
49	2	$media->setNodeName($element->nodeName)
50	2	->setType($this->getAttributeValue($element, 'type'))
51	2	->setUrl($this->getAttributeValue($element, $this->getUrlAttributeName()))
52	2	->setLength($this->getAttributeValue($element, 'length'));
53
54	2	$node->addMedia($media);
55		}
56	2	}
57
58		/**
59		* @param \DomDocument $document
60		* @param MediaInterface $media
61		* @return \DomElement
62		*/
63		public function createMediaElement(\DomDocument $document, MediaInterface $media) : \DOMElement
64		{
65		$element = $document->createElement($this->getNodeName());
66		$element->setAttribute($this->getUrlAttributeName(), $media->getUrl());
67		$element->setAttribute('type', $media->getType() ?? '');
68		$element->setAttribute('length', $media->getLength() ?? '');
69
70		return $element;
71		}
72
73		/**
74		* @inheritDoc
75		*/
76		protected function hasValue(NodeInterface $node) : bool
77		{
78		return $node instanceof ItemInterface && !! $node->getMedias();
79		}
80
81		/**
82		* @inheritDoc
83		*/
84		protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
85		{
86		foreach ($node->getMedias() as $media) {
		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 `getMedias()` 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...
87		$rootElement->appendChild($this->createMediaElement($document, $media));
88		}
89		}
90		}
91

alexdebril / feed-io

Pull Request — master (#230)

Media::createMediaElement() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like