Urlset::appendSubelementAttribute() - Code Metrics - Inspection of "Write any remaining attributes to the urlset eleme..." - ThePixelDeveloper/Sitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#34)

unknown

created 2016-12-09 18:40 UTC

Urlset::appendSubelementAttribute() A

↳ Parent: Urlset

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	11
rs	9.4285
cc	2
eloc	6
nc	2
nop	2

<?php

namespace Thepixeldeveloper\Sitemap;

use XMLWriter;

/**
 * Class Urlset
 *
 * @package Thepixeldeveloper\Sitemap
 */
class Urlset implements OutputInterface
{
    /**
     * Array of URL objects.
     *
     * @var OutputInterface[]
     */
    protected $urls = [];

    /**
     * Sub-elements that have been appended to the collection attributes.
     *
     * @var AppendAttributeInterface[]
     */
    protected $appendedSubelements = [];

    /**
     * Add a new URL object.
     *
     * @param OutputInterface $url
     *
     * @return $this
     */
    public function addUrl(OutputInterface $url)
    {
        $this->urls[] = $url;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function generateXML(XMLWriter $XMLWriter)
    {
        $XMLWriter->startElement('urlset');

        $XMLWriter->writeAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');

        $XMLWriter->writeAttribute('xsi:schemaLocation',
            'http://www.sitemaps.org/schemas/sitemap/0.9 ' .
            'http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd');

        $XMLWriter->writeAttribute('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');

        foreach ($this->getUrls() as $url) {
            foreach ($url->getSubelementsThatAppend() as $subelement) {
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.
    }
}
                $this->appendSubelementAttribute($XMLWriter, $subelement);
            }
        }

        foreach ($this->getUrls() as $url) {
            $url->generateXML($XMLWriter);
        }

        $XMLWriter->endElement();
    }

    /**
     * Get array of URL objects.
     * 
     * @return OutputInterface[]
     */
    public function getUrls()
    {
        return $this->urls;
    }

    /**
     * Appends the sub-element to the collection attributes if it has yet to be visited.
     *
     * @param XMLWriter $XMLWriter
     * @param OutputInterface $subelement
     *
     * @return boolean
     */
    public function appendSubelementAttribute(XMLWriter $XMLWriter, OutputInterface $subelement)
    {
        if (array_key_exists(get_class($subelement), $this->appendedSubelements)) {
            return false;
        }

        $subelement->appendAttributeToCollectionXML($XMLWriter);
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.
    }
}
        $this->appendedSubelements[get_class($subelement)] = $subelement;

        return true;
    }
}


1			<?php
2
3			namespace Thepixeldeveloper\Sitemap;
4
5			use XMLWriter;
6
7			/**
8			* Class Urlset
9			*
10			* @package Thepixeldeveloper\Sitemap
11			*/
12			class Urlset implements OutputInterface
13			{
14			/**
15			* Array of URL objects.
16			*
17			* @var OutputInterface[]
18			*/
19			protected $urls = [];
20
21			/**
22			* Sub-elements that have been appended to the collection attributes.
23			*
24			* @var AppendAttributeInterface[]
25			*/
26			protected $appendedSubelements = [];
27
28			/**
29			* Add a new URL object.
30			*
31			* @param OutputInterface $url
32			*
33			* @return $this
34			*/
35			public function addUrl(OutputInterface $url)
36			{
37			$this->urls[] = $url;
38
39			return $this;
40			}
41
42			/**
43			* {@inheritdoc}
44			*/
45			public function generateXML(XMLWriter $XMLWriter)
46			{
47			$XMLWriter->startElement('urlset');
48
49			$XMLWriter->writeAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
50
51			$XMLWriter->writeAttribute('xsi:schemaLocation',
52			'http://www.sitemaps.org/schemas/sitemap/0.9 ' .
53			'http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd');
54
55			$XMLWriter->writeAttribute('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');
56
57			foreach ($this->getUrls() as $url) {
58			foreach ($url->getSubelementsThatAppend() as $subelement) {
			0 ignored issues – show Bug introduced 2016-12-09 16:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Thepixeldeveloper\Sitemap\OutputInterface` as the method `getSubelementsThatAppend()` does only exist in the following implementations of said interface: `Thepixeldeveloper\Sitemap\Url`. 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...
59			$this->appendSubelementAttribute($XMLWriter, $subelement);
60			}
61			}
62
63			foreach ($this->getUrls() as $url) {
64			$url->generateXML($XMLWriter);
65			}
66
67			$XMLWriter->endElement();
68			}
69
70			/**
71			* Get array of URL objects.
72			*
73			* @return OutputInterface[]
74			*/
75			public function getUrls()
76			{
77			return $this->urls;
78			}
79
80			/**
81			* Appends the sub-element to the collection attributes if it has yet to be visited.
82			*
83			* @param XMLWriter $XMLWriter
84			* @param OutputInterface $subelement
85			*
86			* @return boolean
87			*/
88			public function appendSubelementAttribute(XMLWriter $XMLWriter, OutputInterface $subelement)
89			{
90			if (array_key_exists(get_class($subelement), $this->appendedSubelements)) {
91			return false;
92			}
93
94			$subelement->appendAttributeToCollectionXML($XMLWriter);
			0 ignored issues – show Bug introduced 2016-12-09 18:41 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Thepixeldeveloper\Sitemap\OutputInterface` as the method `appendAttributeToCollectionXML()` does only exist in the following implementations of said interface: `Thepixeldeveloper\Sitemap\Subelements\Image`, `Thepixeldeveloper\Sitemap\Subelements\Link`, `Thepixeldeveloper\Sitemap\Subelements\Mobile`, `Thepixeldeveloper\Sitemap\Subelements\News`, `Thepixeldeveloper\Sitemap\Subelements\Video`. 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...
95			$this->appendedSubelements[get_class($subelement)] = $subelement;
96
97			return true;
98			}
99			}
100

ThePixelDeveloper / Sitemap

Pull Request — master (#34)

Urlset::appendSubelementAttribute() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like