XmlParser::checkBodyStructure() - Code Metrics - Inspection of "added JSONFeed in the list" - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a775f9...497487 )

by Alex

created 2017-06-20 15:31 UTC

XmlParser::checkBodyStructure() A

↳ Parent: XmlParser

Complexity

Conditions	4
Paths	6

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.2
c	0
b	0
f	0
cc	4
eloc	12
nc	6
nop	2

<?php
/*
 * 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\Parser;


use FeedIo\Parser;
use FeedIo\RuleSet;
use FeedIo\FeedInterface;
use FeedIo\Feed\NodeInterface;
use FeedIo\ParserAbstract;
use FeedIo\Reader\Document;
use FeedIo\Parser\MissingFieldsException;
use FeedIo\Parser\UnsupportedFormatException;

/**
 * Parses a DOM document if its format matches the parser's standard
 *
 * Depends on :
 *  - FeedIo\StandardAbstract
 *  - Psr\Log\LoggerInterface
 *
 */
class XmlParser extends ParserAbstract
{

    /**
     * @param $tagName
     * @return bool
     */
    public function isItem($tagName)
    {
        return (strtolower($this->standard->getItemNodeName()) === strtolower($tagName));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
    }

    /**
     * @param  Document                       $document
     * @param  FeedInterface                  $feed
     * @return \FeedIo\FeedInterface
     * @throws Parser\MissingFieldsException
     * @throws Parser\UnsupportedFormatException
     */
    public function parseContent(Document $document, FeedInterface $feed)
    {
        $element = $this->standard->getMainElement($document->getDOMDocument());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}

        $this->parseNode($feed, $element, $this->standard->getFeedRuleSet());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}

        return $feed;
    }

    /**
     * @param  Document            $document
     * @param  array                  $mandatoryFields
     * @return $this
     * @throws MissingFieldsException
     */
    public function checkBodyStructure(Document $document, array $mandatoryFields)
    {
        $errors = array();

        $element = $document->getDOMDocument()->documentElement;
        foreach ($mandatoryFields as $field) {
            $list = $element->getElementsByTagName($field);
            if (0 === $list->length) {
                $errors[] = $field;
            }
        }

        if (!empty($errors)) {
            $message = "missing mandatory field(s) : ".implode(',', $errors);
            $this->logger->warning($message);
            throw new MissingFieldsException($message);
        }

        return $this;
    }

    /**
     * @param  NodeInterface $item
     * @param  \DOMElement   $element
     * @param  RuleSet       $ruleSet
     * @return NodeInterface
     */
    public function parseNode(NodeInterface $item, \DOMElement $element, RuleSet $ruleSet)
    {
        foreach ($element->childNodes as $node) {
            if ($node instanceof \DOMElement) {
                $this->handleNode($item, $node, $ruleSet);
            }
        }

        return $item;
    }

    /**
     * @param NodeInterface $item
     * @param \DOMElement $node
     * @param RuleSet $ruleSet
     * @return $this
     */
    protected function handleNode(NodeInterface $item, \DOMElement $node, RuleSet $ruleSet)
    {
        if ($this->isItem($node->tagName) && $item instanceof FeedInterface) {
            $newItem = $this->parseNode($item->newItem(), $node, $this->standard->getItemRuleSet());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->addValidItem($item, $newItem);
        } else {
            $rule = $ruleSet->get($node->tagName);
            $rule->setProperty($item, $node);
        }

        return $this;
    }


}


1			<?php
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\Parser;
12
13
14			use FeedIo\Parser;
15			use FeedIo\RuleSet;
16			use FeedIo\FeedInterface;
17			use FeedIo\Feed\NodeInterface;
18			use FeedIo\ParserAbstract;
19			use FeedIo\Reader\Document;
20			use FeedIo\Parser\MissingFieldsException;
21			use FeedIo\Parser\UnsupportedFormatException;
22
23			/**
24			* Parses a DOM document if its format matches the parser's standard
25			*
26			* Depends on :
27			* - FeedIo\StandardAbstract
28			* - Psr\Log\LoggerInterface
29			*
30			*/
31			class XmlParser extends ParserAbstract
32			{
33
34			/**
35			* @param $tagName
36			* @return bool
37			*/
38			public function isItem($tagName)
39			{
40			return (strtolower($this->standard->getItemNodeName()) === strtolower($tagName));
			0 ignored issues – show Bug introduced 2017-06-16 20:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `FeedIo\StandardAbstract` as the method `getItemNodeName()` does only exist in the following sub-classes of `FeedIo\StandardAbstract`: `FeedIo\Standard\Atom`, `FeedIo\Standard\Rdf`, `FeedIo\Standard\Rss`, `FeedIo\Standard\XmlAbstract`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
41			}
42
43			/**
44			* @param Document $document
45			* @param FeedInterface $feed
46			* @return \FeedIo\FeedInterface
47			* @throws Parser\MissingFieldsException
48			* @throws Parser\UnsupportedFormatException
49			*/
50			public function parseContent(Document $document, FeedInterface $feed)
51			{
52			$element = $this->standard->getMainElement($document->getDOMDocument());
			0 ignored issues – show Bug introduced 2017-06-16 20:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `FeedIo\StandardAbstract` as the method `getMainElement()` does only exist in the following sub-classes of `FeedIo\StandardAbstract`: `FeedIo\Standard\Atom`, `FeedIo\Standard\Rdf`, `FeedIo\Standard\Rss`, `FeedIo\Standard\XmlAbstract`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
53
54			$this->parseNode($feed, $element, $this->standard->getFeedRuleSet());
			0 ignored issues – show Bug introduced 2017-06-16 20:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `FeedIo\StandardAbstract` as the method `getFeedRuleSet()` does only exist in the following sub-classes of `FeedIo\StandardAbstract`: `FeedIo\Standard\Atom`, `FeedIo\Standard\Rdf`, `FeedIo\Standard\Rss`, `FeedIo\Standard\XmlAbstract`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
55
56			return $feed;
57			}
58
59			/**
60			* @param Document $document
61			* @param array $mandatoryFields
62			* @return $this
63			* @throws MissingFieldsException
64			*/
65			public function checkBodyStructure(Document $document, array $mandatoryFields)
66			{
67			$errors = array();
68
69			$element = $document->getDOMDocument()->documentElement;
70			foreach ($mandatoryFields as $field) {
71			$list = $element->getElementsByTagName($field);
72			if (0 === $list->length) {
73			$errors[] = $field;
74			}
75			}
76
77			if (!empty($errors)) {
78			$message = "missing mandatory field(s) : ".implode(',', $errors);
79			$this->logger->warning($message);
80			throw new MissingFieldsException($message);
81			}
82
83			return $this;
84			}
85
86			/**
87			* @param NodeInterface $item
88			* @param \DOMElement $element
89			* @param RuleSet $ruleSet
90			* @return NodeInterface
91			*/
92			public function parseNode(NodeInterface $item, \DOMElement $element, RuleSet $ruleSet)
93			{
94			foreach ($element->childNodes as $node) {
95			if ($node instanceof \DOMElement) {
96			$this->handleNode($item, $node, $ruleSet);
97			}
98			}
99
100			return $item;
101			}
102
103			/**
104			* @param NodeInterface $item
105			* @param \DOMElement $node
106			* @param RuleSet $ruleSet
107			* @return $this
108			*/
109			protected function handleNode(NodeInterface $item, \DOMElement $node, RuleSet $ruleSet)
110			{
111			if ($this->isItem($node->tagName) && $item instanceof FeedInterface) {
112			$newItem = $this->parseNode($item->newItem(), $node, $this->standard->getItemRuleSet());
			0 ignored issues – show Bug introduced 2017-06-16 20:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `FeedIo\StandardAbstract` as the method `getItemRuleSet()` does only exist in the following sub-classes of `FeedIo\StandardAbstract`: `FeedIo\Standard\Atom`, `FeedIo\Standard\Rdf`, `FeedIo\Standard\Rss`, `FeedIo\Standard\XmlAbstract`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
113			$this->addValidItem($item, $newItem);
114			} else {
115			$rule = $ruleSet->get($node->tagName);
116			$rule->setProperty($item, $node);
117			}
118
119			return $this;
120			}
121
122
123			}
124

alexdebril / feed-io

Push — master ( a775f9...497487 )

XmlParser::checkBodyStructure() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like