StatusResponse.php

Go to the documentation of this file.

<?php

namespace SAML2;

abstract class StatusResponse extends Message
{
    private $inResponseTo;


    private $status;


    protected function __construct($tagName, \DOMElement $xml = null)
    {
        parent::__construct($tagName, $xml);

        $this->status = array(
            'Code' => Constants::STATUS_SUCCESS,
            'SubCode' => null,
            'Message' => null,
            );

        if ($xml === null) {
            return;
        }

        if ($xml->hasAttribute('InResponseTo')) {
            $this->inResponseTo = $xml->getAttribute('InResponseTo');
        }

        $status = Utils::xpQuery($xml, './saml_protocol:Status');
        if (empty($status)) {
            throw new \Exception('Missing status code on response.');
        }
        $status = $status[0];

        $statusCode = Utils::xpQuery($status, './saml_protocol:StatusCode');
        if (empty($statusCode)) {
            throw new \Exception('Missing status code in status element.');
        }
        $statusCode = $statusCode[0];

        $this->status['Code'] = $statusCode->getAttribute('Value');

        $subCode = Utils::xpQuery($statusCode, './saml_protocol:StatusCode');
        if (!empty($subCode)) {
            $this->status['SubCode'] = $subCode[0]->getAttribute('Value');
        }

        $message = Utils::xpQuery($status, './saml_protocol:StatusMessage');
        if (!empty($message)) {
            $this->status['Message'] = trim($message[0]->textContent);
        }
    }


    public function isSuccess()
    {
        assert(array_key_exists("Code", $this->status));

        if ($this->status['Code'] === Constants::STATUS_SUCCESS) {
            return true;
        }

        return false;
    }


    public function getInResponseTo()
    {
        return $this->inResponseTo;
    }


    public function setInResponseTo($inResponseTo)
    {
        assert(is_string($inResponseTo) || is_null($inResponseTo));

        $this->inResponseTo = $inResponseTo;
    }


    public function getStatus()
    {
        return $this->status;
    }


    public function setStatus(array $status)
    {
        assert(array_key_exists("Code", $status));

        $this->status = $status;
        if (!array_key_exists('SubCode', $status)) {
            $this->status['SubCode'] = null;
        }
        if (!array_key_exists('Message', $status)) {
            $this->status['Message'] = null;
        }
    }


    public function toUnsignedXML()
    {
        $root = parent::toUnsignedXML();

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

        $status = $this->document->createElementNS(Constants::NS_SAMLP, 'Status');
        $root->appendChild($status);

        $statusCode = $this->document->createElementNS(Constants::NS_SAMLP, 'StatusCode');
        $statusCode->setAttribute('Value', $this->status['Code']);
        $status->appendChild($statusCode);

        if (!is_null($this->status['SubCode'])) {
            $subStatusCode = $this->document->createElementNS(Constants::NS_SAMLP, 'StatusCode');
            $subStatusCode->setAttribute('Value', $this->status['SubCode']);
            $statusCode->appendChild($subStatusCode);
        }

        if (!is_null($this->status['Message'])) {
            Utils::addString($status, Constants::NS_SAMLP, 'StatusMessage', $this->status['Message']);
        }

        return $root;
    }
}