SerialiserVarShiftCode::serialise() - Code Metrics - Inspection of "Merge pull request #1 from graze/functioning-clien..." - graze/unicontroller-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 411d94...8fae9a )

by John

created 2016-11-16 22:49 UTC

SerialiserVarShiftCode::serialise() A

↳ Parent: SerialiserVarShiftCode

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
ccs	7
cts	7
cp	1
cc	1
eloc	7
nc	1
nop	1
crap	1

<?php
/**
 * This file is part of graze/unicontroller-client.
 *
 * Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://github.com/graze/unicontroller-client/blob/master/LICENSE.md
 * @link https://github.com/graze/unicontroller-client
 */
namespace Graze\UnicontrollerClient\Serialiser\Serialiser;

use Graze\UnicontrollerClient\Serialiser\Serialiser\AbstractSerialiser;
use Graze\UnicontrollerClient\Serialiser\Serialiser\SerialiserInterface;
use Graze\UnicontrollerClient\Entity\Entity\EntityInterface;

class SerialiserVarShiftCode extends AbstractSerialiser implements SerialiserInterface
{
    /**
     * @param EntityInterface $entity
     * @return string
     */
    public function serialise(EntityInterface $entity)
    {
        $properties = [];
        $properties[] = $this->stringEscaper->escape($entity->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.
    }
}
        $properties[] = $this->arraySerialiser->serialise($entity->getShiftArray(), 'ShiftDefinition');
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.
    }
}
        $properties[] = $entity->getcPadding();
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.
    }
}
        $properties[] = $entity->getLength();
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.
    }
}

        return implode(',', $properties);
    }
}


Push — master ( 411d94...8fae9a )

SerialiserVarShiftCode::serialise() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2		/**
3		* This file is part of graze/unicontroller-client.
4		*
5		* Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		* @license https://github.com/graze/unicontroller-client/blob/master/LICENSE.md
11		* @link https://github.com/graze/unicontroller-client
12		*/
13		namespace Graze\UnicontrollerClient\Serialiser\Serialiser;
14
15		use Graze\UnicontrollerClient\Serialiser\Serialiser\AbstractSerialiser;
16		use Graze\UnicontrollerClient\Serialiser\Serialiser\SerialiserInterface;
17		use Graze\UnicontrollerClient\Entity\Entity\EntityInterface;
18
19		class SerialiserVarShiftCode extends AbstractSerialiser implements SerialiserInterface
20		{
21		/**
22		* @param EntityInterface $entity
23		* @return string
24		*/
25	1	public function serialise(EntityInterface $entity)
26		{
27	1	$properties = [];
28	1	$properties[] = $this->stringEscaper->escape($entity->getName());
		0 ignored issues – show Bug introduced 2016-11-16 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Graze\UnicontrollerClien...\Entity\EntityInterface` as the method `getName()` does only exist in the following implementations of said interface: `Graze\UnicontrollerClien...Entity\EntityReadDesign`, `Graze\UnicontrollerClien...ntity\EntityVarDatabase`, `Graze\UnicontrollerClien...\EntityVarDatabaseField`, `Graze\UnicontrollerClien...tity\EntityVarMachineId`, `Graze\UnicontrollerClien...y\Entity\EntityVarMacro`, `Graze\UnicontrollerClien...ty\EntityVarMacroOutput`, `Graze\UnicontrollerClien...\Entity\EntityVarPrompt`, `Graze\UnicontrollerClien...ity\Entity\EntityVarRtc`, `Graze\UnicontrollerClien...ity\Entity\EntityVarSeq`, `Graze\UnicontrollerClien...\Entity\EntityVarSerial`, `Graze\UnicontrollerClien...tity\EntityVarShiftCode`, `Graze\UnicontrollerClien...\Entity\EntityVarUserId`. 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...
29	1	$properties[] = $this->arraySerialiser->serialise($entity->getShiftArray(), 'ShiftDefinition');
		0 ignored issues – show Bug introduced 2016-11-16 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Graze\UnicontrollerClien...\Entity\EntityInterface` as the method `getShiftArray()` does only exist in the following implementations of said interface: `Graze\UnicontrollerClien...tity\EntityVarShiftCode`. 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...
30	1	$properties[] = $entity->getcPadding();
		0 ignored issues – show Bug introduced 2016-11-16 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Graze\UnicontrollerClien...\Entity\EntityInterface` as the method `getcPadding()` does only exist in the following implementations of said interface: `Graze\UnicontrollerClien...ntity\EntityVarDatabase`, `Graze\UnicontrollerClien...\EntityVarDatabaseField`, `Graze\UnicontrollerClien...y\Entity\EntityVarMacro`, `Graze\UnicontrollerClien...ty\EntityVarMacroOutput`, `Graze\UnicontrollerClien...\Entity\EntityVarPrompt`, `Graze\UnicontrollerClien...ity\Entity\EntityVarRtc`, `Graze\UnicontrollerClien...\Entity\EntityVarSerial`, `Graze\UnicontrollerClien...tity\EntityVarShiftCode`. 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...
31	1	$properties[] = $entity->getLength();
		0 ignored issues – show Bug introduced 2016-11-16 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Graze\UnicontrollerClien...\Entity\EntityInterface` as the method `getLength()` does only exist in the following implementations of said interface: `Graze\UnicontrollerClien...\EntityVarDatabaseField`, `Graze\UnicontrollerClien...y\Entity\EntityVarMacro`, `Graze\UnicontrollerClien...ty\EntityVarMacroOutput`, `Graze\UnicontrollerClien...\Entity\EntityVarPrompt`, `Graze\UnicontrollerClien...ity\Entity\EntityVarRtc`, `Graze\UnicontrollerClien...ity\Entity\EntityVarSeq`, `Graze\UnicontrollerClien...\Entity\EntityVarSerial`, `Graze\UnicontrollerClien...tity\EntityVarShiftCode`. 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...
32
33	1	return implode(',', $properties);
34		}
35		}
36

graze / unicontroller-client

Push — master ( 411d94...8fae9a )

SerialiserVarShiftCode::serialise() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like