Request::getProviderName() - Code Metrics - Inspection of "Add some more elements for the ecp-namespace" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#341)

by Tim
created 2023-06-03 15:40 UTC
Request::getProviderName() A

↳ Parent: Request
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\ecp;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\SAML2\Exception\ProtocolViolationException;
use SimpleSAML\SAML2\XML\saml\Issuer;
use SimpleSAML\SAML2\XML\samlp\IDPList;
use SimpleSAML\SOAP\Constants as C;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\Exception\MissingAttributeException;
use SimpleSAML\XML\Exception\TooManyElementsException;
use SimpleSAML\XML\Exception\SchemaViolationException;

use function boolval;
use function intval;
use function is_null;
use function is_numeric;
use function strval;

/**
 * Class representing the ECP Request element.
 *
 * @package simplesamlphp/saml2
 */
final class Request extends AbstractEcpElement
{
    /**
     * Create a ECP Request element.
     *
     * @param bool $mustUnderstand
     * @param \SimpleSAML\SAML2\XML\saml\Issuer $issuer
     * @param \SimpleSAML\SAML2\XML\samlp\IDPList|null $idpList
     * @param string|null $providerName
     * @param bool|null $isPassive
     */
    public function __construct(
        protected bool $mustUnderstand,
        protected Issuer $issuer,
        protected ?IDPList $idpList = null,
        protected ?string $providerName = null,
        protected ?bool $isPassive = null,
    ) {
    }


    /**
     * Collect the value of the mustUnderstand-property
     *
     * @return bool
     */
    public function getMustUnderstand(): bool
    {
        return $this->mustUnderstand;
    }


    /**
     * Collect the value of the isPassive-property
     *
     * @return bool
     */
    public function getIsPassive(): bool
    {
        return $this->isPassive;

    }


    /**
     * Collect the value of the providerName-property
     *
     * @return string
     */
    public function getProviderName(): string
    {
        return $this->providerName;

    }


    /**
     * Collect the value of the issuer-property
     *
     * @return \SimpleSAML\SAML2\XML\saml\Issuer
     */
    public function getIssuer(): Issuer
    {
        return $this->issuer;
    }
    /**
     * Collect the value of the idpList-property
     *
     * @return \SimpleSAML\SAML2\XML\samlp\IDPList|null
     */
    public function getIDPList(): ?IDPList
    {
        return $this->idpList;
    }


    /**
     * Convert XML into a Request
     *
     * @param \DOMElement $xml The XML element we should load
     * @return static
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     * @throws \SimpleSAML\XML\Exception\MissingAttributeException
     *   if the supplied element is missing any of the mandatory attributes
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'Request', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, Request::NS, InvalidDOMElementException::class);

        // Assert required attributes
        Assert::true(
            $xml->hasAttributeNS(C::NS_SOAP_ENV_11, 'actor'),
            'Missing env:actor attribute in <ecp:Request>.',
            MissingAttributeException::class,
        );
        Assert::true(
            $xml->hasAttributeNS(C::NS_SOAP_ENV_11, 'mustUnderstand'),
            'Missing env:mustUnderstand attribute in <ecp:Request>.',
            MissingAttributeException::class,
        );

        $mustUnderstand = $xml->getAttributeNS(C::NS_SOAP_ENV_11, 'mustUnderstand');
        $mustUnderstand = ($mustUnderstand === '') ? null : boolval(intval($mustUnderstand));
        Assert::nullOrBoolean(
            $mustUnderstand,
            'Invalid value of env:mustUnderstand attribute in <ecp:Request>.',
            ProtocolViolationException::class,
        );

        $actor = $xml->getAttributeNS(C::NS_SOAP_ENV_11, 'actor');
        Assert::same(
            $actor,
            C::SOAP_ACTOR_NEXT,
            'Invalid value of env:actor attribute in <ecp:Request>.',
            ProtocolViolationException::class,
        );

        $issuer = Issuer::getChildrenOfClass($xml);
        Assert::count(
            $issuer,
            1,
            'More than one <saml:Issuer> in <ecp:Request>.',
            TooManyElementsException::class,
        );

        $idpList = IDPList::getChildrenOfClass($xml);

        return new static(
            $mustUnderstand,
            /** @scrutinizer ignore-type */ $mustUnderstand,
            array_pop($issuer),
            array_pop($idpList),
            self::getOptionalAttribute($xml, 'ProviderName', null),
            self::getOptionalBooleanAttribute($xml, 'IsPassive', null),
        );
    }


    /**
     * Convert this ECP SubjectConfirmation to XML.
     *
     * @param \DOMElement|null $parent The element we should append this element to.
     * @return \DOMElement
     */
    public function toXML(DOMElement $parent = null): DOMElement
    {
        $e = $this->instantiateParentElement($parent);
        $e->setAttributeNS(C::NS_SOAP_ENV_11, 'env:mustUnderstand', strval(intval($this->getMustUnderstand())));
        $e->setAttributeNS(C::NS_SOAP_ENV_11, 'env:actor', C::SOAP_ACTOR_NEXT);

        if ($this->getProviderName() !== null) {

            $e->setAttribute('ProviderName', $this->getProviderName());
        }

        if ($this->getIsPassive() !== null) {

            $e->setAttribute('IsPassive', strval(intval($this->getIsPassive())));
        }

        $this->getIssuer()->toXML($e);
        $this->getIDPList()?->toXML($e);

        return $e;
    }
}

simplesamlphp / saml2

Pull Request — master (#341)

Request::getProviderName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
