SimpleSAML\SAML2\XML\samlp\AbstractStatusResponse

Complexity

Total Complexity

8

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getInResponseTo()	0	3	1
A	isSuccess()	0	3	1
A	__construct()	0	15	1
A	setStatus()	0	3	1
A	getStatus()	0	3	1
A	setInResponseTo()	0	6	1
A	toUnsignedXML()	0	11	2

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\samlp;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\SAML2\Constants;
use SimpleSAML\SAML2\XML\ExtensionsTrait;
use SimpleSAML\SAML2\XML\saml\Issuer;

/**
 * Base class for all SAML 2 response messages.
 *
 * Implements samlp:StatusResponseType. All of the elements in that type is
 * stored in the \SimpleSAML\SAML2\Message class, and this class is therefore more
 * or less empty. It is included mainly to make it easy to separate requests from
 * responses.
 *
 * @package simplesamlphp/saml2
 */
abstract class AbstractStatusResponse extends AbstractMessage
{
    use ExtensionsTrait;

    /**
     * The ID of the request this is a response to, or null if this is an unsolicited response.
     *
     * @var string|null
     */
    protected ?string $inResponseTo;


    /**
     * The status code of the response.
     *
     * @var \SimpleSAML\SAML2\XML\samlp\Status
     */
    protected Status $status;


    /**
     * Constructor for SAML 2 response messages.
     *
     * @param \SimpleSAML\SAML2\XML\samlp\Status $status
     * @param \SimpleSAML\SAML2\XML\saml\Issuer|null $issuer
     * @param string|null $id
     * @param int|null $issueInstant
     * @param string|null $inResponseTo
     * @param string|null $destination
     * @param string|null $consent
     * @param \SimpleSAML\SAML2\XML\samlp\Extensions|null $extensions
     * @param string|null $relayState
     *
     * @throws \Exception
     */
    protected function __construct(
        Status $status,
        ?Issuer $issuer = null,
        ?string $id = null,
        ?int $issueInstant = null,
        ?string $inResponseTo = null,
        ?string $destination = null,
        ?string $consent = null,
        ?Extensions $extensions = null,
        ?string $relayState = null
    ) {
        parent::__construct($issuer, $id, $issueInstant, $destination, $consent, $extensions, $relayState);

The call to SimpleSAML\SAML2\XML\ExtensionsTrait::__construct() has too many arguments starting with $id.

$issuer of type SimpleSAML\SAML2\XML\saml\Issuer|null is incompatible with the type array expected by parameter $extensions of SimpleSAML\SAML2\XML\ExtensionsTrait::__construct().

        $this->setStatus($status);
        $this->setInResponseTo($inResponseTo);
    }


    /**
     * Determine whether this is a successful response.
     *
     * @return bool true if the status code is success, false if not.
     */
    public function isSuccess(): bool
    {
        return $this->status->getStatusCode()->getValue() === Constants::STATUS_SUCCESS;
    }


    /**
     * Retrieve the ID of the request this is a response to.
     *
     * @return string|null The ID of the request.
     */
    public function getInResponseTo(): ?string
    {
        return $this->inResponseTo;
    }


    /**
     * Set the ID of the request this is a response to.
     *
     * @param string|null $inResponseTo The ID of the request.
     */
    protected function setInResponseTo(?string $inResponseTo): void
    {
        Assert::nullOrNotWhitespaceOnly($inResponseTo);
        Assert::nullOrNotContains($inResponseTo, ':');

        $this->inResponseTo = $inResponseTo;
    }


    /**
     * Retrieve the status code.
     *
     * @return \SimpleSAML\SAML2\XML\samlp\Status The status code.
     */
    public function getStatus(): Status
    {
        return $this->status;
    }


    /**
     * Set the status code.
     *
     * @param \SimpleSAML\SAML2\XML\samlp\Status $status The status code.
     */
    protected function setStatus(Status $status): void
    {
        $this->status = $status;
    }


    /**
     * Convert this message to an unsigned XML document.
     * This method does not sign the resulting XML document.
     *
     * @return \DOMElement The root element of the DOM tree
     */
    protected function toUnsignedXML(?DOMElement $parent = null): DOMElement
    {
        $e = parent::toUnsignedXML($parent);

        if ($this->inResponseTo !== null) {
            $e->setAttribute('InResponseTo', $this->inResponseTo);
        }

        $this->status->toXML($e);

        return $e;
    }
}