SecurityWithLabelPrivacy::guardLabel() - Code Metrics - Inspection of "Feature/III-1608 Make label behaviour of organizer..." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#239)

by Luc

created 2016-11-18 12:28 UTC

SecurityWithLabelPrivacy::guardLabel() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

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	3
eloc	6
nc	3
nop	1

<?php

namespace CultuurNet\UDB3\Offer\Security;

use CultuurNet\UDB3\Label\ReadModels\JSON\Repository\ReadRepositoryInterface;
use CultuurNet\UDB3\Offer\Commands\AuthorizableCommandInterface;
use CultuurNet\UDB3\Security\LabelSecurityInterface;
use CultuurNet\UDB3\Security\SecurityDecoratorBase;
use CultuurNet\UDB3\Security\SecurityInterface;
use CultuurNet\UDB3\Security\UserIdentificationInterface;
use ValueObjects\String\String as StringLiteral;

class SecurityWithLabelPrivacy extends SecurityDecoratorBase
{
    /**
     * @var UserIdentificationInterface
     */
    private $userIdentification;

    /**
     * @var ReadRepositoryInterface
     */
    private $labelReadRepository;

    /**
     * SecurityWithLabelPrivacy constructor.
     *
     * @param SecurityInterface $decoratee
     * @param UserIdentificationInterface $userIdentification
     * @param ReadRepositoryInterface $labelReadRepository
     */
    public function __construct(
        SecurityInterface $decoratee,
        UserIdentificationInterface $userIdentification,
        ReadRepositoryInterface $labelReadRepository
    ) {
        parent::__construct($decoratee);

        $this->userIdentification = $userIdentification;
        $this->labelReadRepository = $labelReadRepository;
    }


    /**
     * @inheritdoc
     */
    public function isAuthorized(AuthorizableCommandInterface $command)
    {
        if ($this->isLabelCommand($command)) {
            /** @var LabelSecurityInterface $command */
            return $this->canUseLabel($command);
        } else {
            return parent::isAuthorized($command);
        }
    }

    /**
     * @param AuthorizableCommandInterface $command
     * @return bool
     */
    private function isLabelCommand(AuthorizableCommandInterface $command)
    {
        return ($command instanceof LabelSecurityInterface);
    }

    /**
     * @param LabelSecurityInterface $command
     * @return bool
     * @throws \InvalidArgumentException
     */
    private function canUseLabel(LabelSecurityInterface $command)
    {
        if ($this->userIdentification->isGodUser()) {
            return true;
        } else {
            return $this->labelReadRepository->canUseLabel(
                $this->userIdentification->getId(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                $command->getName()
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            );
        }
    }
}


1			<?php
2
3			namespace CultuurNet\UDB3\Offer\Security;
4
5			use CultuurNet\UDB3\Label\ReadModels\JSON\Repository\ReadRepositoryInterface;
6			use CultuurNet\UDB3\Offer\Commands\AuthorizableCommandInterface;
7			use CultuurNet\UDB3\Security\LabelSecurityInterface;
8			use CultuurNet\UDB3\Security\SecurityDecoratorBase;
9			use CultuurNet\UDB3\Security\SecurityInterface;
10			use CultuurNet\UDB3\Security\UserIdentificationInterface;
11			use ValueObjects\String\String as StringLiteral;
12
13			class SecurityWithLabelPrivacy extends SecurityDecoratorBase
14			{
15			/**
16			* @var UserIdentificationInterface
17			*/
18			private $userIdentification;
19
20			/**
21			* @var ReadRepositoryInterface
22			*/
23			private $labelReadRepository;
24
25			/**
26			* SecurityWithLabelPrivacy constructor.
27			*
28			* @param SecurityInterface $decoratee
29			* @param UserIdentificationInterface $userIdentification
30			* @param ReadRepositoryInterface $labelReadRepository
31			*/
32			public function __construct(
33			SecurityInterface $decoratee,
34			UserIdentificationInterface $userIdentification,
35			ReadRepositoryInterface $labelReadRepository
36			) {
37			parent::__construct($decoratee);
38
39			$this->userIdentification = $userIdentification;
40			$this->labelReadRepository = $labelReadRepository;
41			}
42
43
44			/**
45			* @inheritdoc
46			*/
47			public function isAuthorized(AuthorizableCommandInterface $command)
48			{
49			if ($this->isLabelCommand($command)) {
50			/** @var LabelSecurityInterface $command */
51			return $this->canUseLabel($command);
52			} else {
53			return parent::isAuthorized($command);
54			}
55			}
56
57			/**
58			* @param AuthorizableCommandInterface $command
59			* @return bool
60			*/
61			private function isLabelCommand(AuthorizableCommandInterface $command)
62			{
63			return ($command instanceof LabelSecurityInterface);
64			}
65
66			/**
67			* @param LabelSecurityInterface $command
68			* @return bool
69			* @throws \InvalidArgumentException
70			*/
71			private function canUseLabel(LabelSecurityInterface $command)
72			{
73			if ($this->userIdentification->isGodUser()) {
74			return true;
75			} else {
76			return $this->labelReadRepository->canUseLabel(
77			$this->userIdentification->getId(),
			0 ignored issues – show Bug introduced 2016-09-12 12:30 UTC by Report Bug Copy Issue Report It seems like `$this->userIdentification->getId()` can be `null`; however, `canUseLabel()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
78			$command->getName()
			0 ignored issues – show Bug introduced 2016-11-17 08:13 UTC by Report Bug Copy Issue Report It seems like `$command->getName()` can be `null`; however, `canUseLabel()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
79			);
80			}
81			}
82			}
83

cultuurnet / udb3-php

Pull Request — master (#239)

SecurityWithLabelPrivacy::guardLabel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like