MPNS - Code Metrics - Inspection of "Payload creation rules moved to separated classes" - zbox/UnifiedPush - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (9c9abb)

by Alexander

created 2016-03-19 12:04 UTC

MPNS A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	11
c	1
b	0
f	0
lcom	1
cbo	4
dl	0
loc	113
rs	10

6 Methods

Rating	Name	Size	Complexity
A	isSupported()	4	1
B	createPayload()	24	3
A	packPayload()	4	1
A	getCustomNotificationData()	9	1
A	completeDocumentBody()	18	3
A	completeRawDocumentBody()	10	2

<?php

/*
 * (c) Alexander Zhukov <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zbox\UnifiedPush\Notification\PayloadHandler;

use Zbox\UnifiedPush\Message\MessageInterface;
use Zbox\UnifiedPush\Notification\PayloadHandler;
use Zbox\UnifiedPush\Message\Type\MPNSBase as MPNSMessage;
use Zbox\UnifiedPush\Message\Type\MPNSRaw;

/**
 * Class MPNS
 * @package Zbox\UnifiedPush\Notification\PayloadHandler
 */
class MPNS extends PayloadHandler
{
    /**
     * The maximum size allowed for MPNS message payload is 3K bytes
     */
    const PAYLOAD_MAX_LENGTH = 3072;

    /**
     * Notification delivery interval
     *
     * @var int
     */
    protected $delayInterval;

    /**
     * @param MessageInterface $message
     * @return bool
     */
    public function isSupported(MessageInterface $message)
    {
        return $message instanceof MPNSMessage;
    }

    /**
     * @return \DOMDocument
     */
    public function createPayload()
    {
        /** @var MPNSMessage $message */
        $message = $this->message;

        $messageType = ucfirst($message->getMPNSType());

        $document      = new \DOMDocument("1.0", "utf-8");
        $baseElement  = $document->createElement("wp:Notification");
        $baseElement->setAttribute("xmlns:wp", "WPNotification");
        $document->appendChild($baseElement);

        $elementName = $message instanceof MPNSRaw ? 'root' : "wp:" . $messageType;
        $rootElement = $document->createElement($elementName);
        $baseElement->appendChild($rootElement);

        if ($message instanceof MPNSRaw) {
            $this->completeRawDocumentBody($document, $rootElement, $message);
        } else {
            $this->completeDocumentBody($document, $rootElement, $message);
        }

        return $document;
    }

    /**
     * @param \DOMDocument $payload
     * @return string
     */
    public function packPayload($payload)
    {
        return $payload->saveXML();
    }

    /**
     * @return array
     */
    public function getCustomNotificationData()
    {
        return
            array(
                'message_id'        => $this->message->getMessageIdentifier(),
                'delay_interval'    => $this->message->getDelayInterval(),
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.
    }
}
                'message_type'      => $this->message->getMPNSType()
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.
    }
}
            );
    }

    /**
     * @param \DOMDocument $document
     * @param \DOMElement $rootElement
     * @param MPNSMessage $message
     */
    protected function completeDocumentBody(
        \DOMDocument $document,
        \DOMElement $rootElement,
        MPNSMessage $message
    ) {
        foreach ($message->getPropertiesList() as $property)
        {
            $propertyName   = ucfirst($property->getName());
            $getterName     = 'get' . $propertyName;
            $value          = $this->$getterName();

            if ($value) {
                $name    = "wp:" . $propertyName;
                $element = $document->createElement($name, $value);
                $rootElement->appendChild($element);
            }
        }
    }

    /**
     * @param \DOMDocument $document
     * @param \DOMElement $rootElement
     * @param MPNSRaw $message
     */
    protected function completeRawDocumentBody(
        \DOMDocument $document,
        \DOMElement $rootElement,
        MPNSRaw $message
    ) {
        foreach ($message->getRawPayload() as $key => $value) {
            $element = $document->createElement($key, $value);
            $rootElement->appendChild($element);
        }
    }
}


1			<?php
2
3			/*
4			* (c) Alexander Zhukov <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace Zbox\UnifiedPush\Notification\PayloadHandler;
11
12			use Zbox\UnifiedPush\Message\MessageInterface;
13			use Zbox\UnifiedPush\Notification\PayloadHandler;
14			use Zbox\UnifiedPush\Message\Type\MPNSBase as MPNSMessage;
15			use Zbox\UnifiedPush\Message\Type\MPNSRaw;
16
17			/**
18			* Class MPNS
19			* @package Zbox\UnifiedPush\Notification\PayloadHandler
20			*/
21			class MPNS extends PayloadHandler
22			{
23			/**
24			* The maximum size allowed for MPNS message payload is 3K bytes
25			*/
26			const PAYLOAD_MAX_LENGTH = 3072;
27
28			/**
29			* Notification delivery interval
30			*
31			* @var int
32			*/
33			protected $delayInterval;
34
35			/**
36			* @param MessageInterface $message
37			* @return bool
38			*/
39			public function isSupported(MessageInterface $message)
40			{
41			return $message instanceof MPNSMessage;
42			}
43
44			/**
45			* @return \DOMDocument
46			*/
47			public function createPayload()
48			{
49			/** @var MPNSMessage $message */
50			$message = $this->message;
51
52			$messageType = ucfirst($message->getMPNSType());
53
54			$document = new \DOMDocument("1.0", "utf-8");
55			$baseElement = $document->createElement("wp:Notification");
56			$baseElement->setAttribute("xmlns:wp", "WPNotification");
57			$document->appendChild($baseElement);
58
59			$elementName = $message instanceof MPNSRaw ? 'root' : "wp:" . $messageType;
60			$rootElement = $document->createElement($elementName);
61			$baseElement->appendChild($rootElement);
62
63			if ($message instanceof MPNSRaw) {
64			$this->completeRawDocumentBody($document, $rootElement, $message);
65			} else {
66			$this->completeDocumentBody($document, $rootElement, $message);
67			}
68
69			return $document;
70			}
71
72			/**
73			* @param \DOMDocument $payload
74			* @return string
75			*/
76			public function packPayload($payload)
77			{
78			return $payload->saveXML();
79			}
80
81			/**
82			* @return array
83			*/
84			public function getCustomNotificationData()
85			{
86			return
87			array(
88			'message_id' => $this->message->getMessageIdentifier(),
89			'delay_interval' => $this->message->getDelayInterval(),
			0 ignored issues – show Bug introduced 2016-03-19 12:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zbox\UnifiedPush\Message\MessageInterface` as the method `getDelayInterval()` does only exist in the following implementations of said interface: `Zbox\UnifiedPush\Message\Type\MPNSBase`, `Zbox\UnifiedPush\Message\Type\MPNSRaw`, `Zbox\UnifiedPush\Message\Type\MPNSTile`, `Zbox\UnifiedPush\Message\Type\MPNSToast`. 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...
90			'message_type' => $this->message->getMPNSType()
			0 ignored issues – show Bug introduced 2016-03-19 12:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zbox\UnifiedPush\Message\MessageInterface` as the method `getMPNSType()` does only exist in the following implementations of said interface: `Zbox\UnifiedPush\Message\Type\MPNSBase`, `Zbox\UnifiedPush\Message\Type\MPNSRaw`, `Zbox\UnifiedPush\Message\Type\MPNSTile`, `Zbox\UnifiedPush\Message\Type\MPNSToast`. 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...
91			);
92			}
93
94			/**
95			* @param \DOMDocument $document
96			* @param \DOMElement $rootElement
97			* @param MPNSMessage $message
98			*/
99			protected function completeDocumentBody(
100			\DOMDocument $document,
101			\DOMElement $rootElement,
102			MPNSMessage $message
103			) {
104			foreach ($message->getPropertiesList() as $property)
105			{
106			$propertyName = ucfirst($property->getName());
107			$getterName = 'get' . $propertyName;
108			$value = $this->$getterName();
109
110			if ($value) {
111			$name = "wp:" . $propertyName;
112			$element = $document->createElement($name, $value);
113			$rootElement->appendChild($element);
114			}
115			}
116			}
117
118			/**
119			* @param \DOMDocument $document
120			* @param \DOMElement $rootElement
121			* @param MPNSRaw $message
122			*/
123			protected function completeRawDocumentBody(
124			\DOMDocument $document,
125			\DOMElement $rootElement,
126			MPNSRaw $message
127			) {
128			foreach ($message->getRawPayload() as $key => $value) {
129			$element = $document->createElement($key, $value);
130			$rootElement->appendChild($element);
131			}
132			}
133			}
134

zbox / UnifiedPush

GitHub Access Token became invalid

Branch — master (9c9abb)

MPNS A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like