LogoutRequest::create() - Code Metrics - flipboxfactory/saml-core - Measure and Improve Code Quality continuously with Scrutinizer

LogoutRequest::create() B
last analyzed 2021-04-19 18:56 UTC

↳ Parent: LogoutRequest

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	83
rs	8.3709
c	0
b	0
f	0
cc	3
nc	2
nop	4

How to fix Long Method

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 */

namespace flipbox\saml\core\services\messages;

use craft\base\Component;
use flipbox\saml\core\models\SettingsInterface;
use flipbox\saml\core\records\AbstractProvider;
use flipbox\saml\core\records\AbstractProviderIdentity;
use SAML2\Constants;
use SAML2\HTTPRedirect;
use SAML2\LogoutRequest as SamlLogoutRequest;
use SAML2\XML\saml\Issuer;
use SAML2\XML\saml\NameID;
use yii\base\Event;

/**
 * Class LogoutRequest
 * @package flipbox\saml\core\services\messages
 */
class LogoutRequest extends Component
{


    const EVENT_AFTER_MESSAGE_CREATED = 'eventAfterMessageCreated';

    /**
     * @param AbstractProvider $theirProvider
     * @param AbstractProvider $ourProvider
     * @param AbstractProviderIdentity $identity
     * @return SamlLogoutRequest
     * @throws \Exception
     */
    public function create(
        AbstractProvider $theirProvider,
        AbstractProvider $ourProvider,
        AbstractProviderIdentity $identity,
        string $relayState = null
    ) {

        $logout = new SamlLogoutRequest();

        /**
         * Set remote destination
         */
        $logout->setDestination(
            $theirProvider->getType() === SettingsInterface::SP ?
                $theirProvider->firstSpSloService()->getLocation() :
                $theirProvider->firstIdpSloService()->getLocation()
        );

        /**
         * Set session id
         */
        $logout->setSessionIndex($identity->sessionId);

        $logout->setNotOnOrAfter(
            (new \DateTime('+5 minutes'))->getTimestamp()
        );
        $logout->setIssueInstant(
            (new \DateTime())->getTimestamp()
        );
        $logout->setConsent(
            Constants::CONSENT_UNSPECIFIED
        );

        $logout->setRelayState(
            $relayState
        );

        /**
         * Set NameId
         */
        $logout->setNameID(
            $nameId = new NameID()
        );

        $nameId->setValue($identity->nameId);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $nameId->setFormat(Constants::NAMEID_EMAIL_ADDRESS);

        /**
         * Set issuer
         */
        $logout->setIssuer(
            $issuer = new Issuer()
        );
        $issuer->setValue(
            $ourProvider->getEntityId()
        );

        /**
         * Sign the message
         */
        if ($ourProvider->keychain) {
            $logout->setSignatureKey(
                $ourProvider->keychainPrivateXmlSecurityKey()
            );

            $logout->setCertificates([
                $ourProvider->keychain->certificate
            ]);
        }

        /**
         * Kick off event here so people can manipulate this object if needed
         */
        $event = new Event();

        /**
         * response
         */
        $event->data = $logout;
        $this->trigger(static::EVENT_AFTER_MESSAGE_CREATED, $event);

        return $logout;
    }

    public function createRedirectUrl(
        AbstractProvider $theirProvider,
        AbstractProvider $ourProvider,
        AbstractProviderIdentity $identity,
        string $relayState = null
    ) {
        return (new HTTPRedirect())->getRedirectURL(
            $this->create(
                $theirProvider,
                $ourProvider,
                $identity,
                $relayState
            )
        );
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			*/
6
7			namespace flipbox\saml\core\services\messages;
8
9			use craft\base\Component;
10			use flipbox\saml\core\models\SettingsInterface;
11			use flipbox\saml\core\records\AbstractProvider;
12			use flipbox\saml\core\records\AbstractProviderIdentity;
13			use SAML2\Constants;
14			use SAML2\HTTPRedirect;
15			use SAML2\LogoutRequest as SamlLogoutRequest;
16			use SAML2\XML\saml\Issuer;
17			use SAML2\XML\saml\NameID;
18			use yii\base\Event;
19
20			/**
21			* Class LogoutRequest
22			* @package flipbox\saml\core\services\messages
23			*/
24			class LogoutRequest extends Component
25			{
26
27
28			const EVENT_AFTER_MESSAGE_CREATED = 'eventAfterMessageCreated';
29
30			/**
31			* @param AbstractProvider $theirProvider
32			* @param AbstractProvider $ourProvider
33			* @param AbstractProviderIdentity $identity
34			* @return SamlLogoutRequest
35			* @throws \Exception
36			*/
37			public function create(
38			AbstractProvider $theirProvider,
39			AbstractProvider $ourProvider,
40			AbstractProviderIdentity $identity,
41			string $relayState = null
42			) {
43
44			$logout = new SamlLogoutRequest();
45
46			/**
47			* Set remote destination
48			*/
49			$logout->setDestination(
50			$theirProvider->getType() === SettingsInterface::SP ?
51			$theirProvider->firstSpSloService()->getLocation() :
52			$theirProvider->firstIdpSloService()->getLocation()
53			);
54
55			/**
56			* Set session id
57			*/
58			$logout->setSessionIndex($identity->sessionId);
59
60			$logout->setNotOnOrAfter(
61			(new \DateTime('+5 minutes'))->getTimestamp()
62			);
63			$logout->setIssueInstant(
64			(new \DateTime())->getTimestamp()
65			);
66			$logout->setConsent(
67			Constants::CONSENT_UNSPECIFIED
68			);
69
70			$logout->setRelayState(
71			$relayState
72			);
73
74			/**
75			* Set NameId
76			*/
77			$logout->setNameID(
78			$nameId = new NameID()
79			);
80
81			$nameId->setValue($identity->nameId);
			0 ignored issues – show Documentation introduced 2019-05-09 20:04 UTC by Report Bug Copy Issue Report The property `nameId` does not exist on `object<flipbox\saml\core...stractProviderIdentity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
82			$nameId->setFormat(Constants::NAMEID_EMAIL_ADDRESS);
83
84			/**
85			* Set issuer
86			*/
87			$logout->setIssuer(
88			$issuer = new Issuer()
89			);
90			$issuer->setValue(
91			$ourProvider->getEntityId()
92			);
93
94			/**
95			* Sign the message
96			*/
97			if ($ourProvider->keychain) {
98			$logout->setSignatureKey(
99			$ourProvider->keychainPrivateXmlSecurityKey()
100			);
101
102			$logout->setCertificates([
103			$ourProvider->keychain->certificate
104			]);
105			}
106
107			/**
108			* Kick off event here so people can manipulate this object if needed
109			*/
110			$event = new Event();
111
112			/**
113			* response
114			*/
115			$event->data = $logout;
116			$this->trigger(static::EVENT_AFTER_MESSAGE_CREATED, $event);
117
118			return $logout;
119			}
120
121			public function createRedirectUrl(
122			AbstractProvider $theirProvider,
123			AbstractProvider $ourProvider,
124			AbstractProviderIdentity $identity,
125			string $relayState = null
126			) {
127			return (new HTTPRedirect())->getRedirectURL(
128			$this->create(
129			$theirProvider,
130			$ourProvider,
131			$identity,
132			$relayState
133			)
134			);
135			}
136			}
137

flipboxfactory / saml-core

LogoutRequest::create() B last analyzed 2021-04-19 18:56 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

LogoutRequest::create() B
last analyzed 2021-04-19 18:56 UTC