ILIAS\AuthSOAP\ConnectionTester Class Reference

Collaboration diagram for ILIAS\AuthSOAP\ConnectionTester:

Public Member Functions
	__construct (private \ilSetting $settings, private Factory $ui_factory, private ilLogger $logger,)
	testConnection (string $ext_uid, string $soap_pw, bool $new_user)

Private Member Functions
	renderXmlBlock (string $xml)
	formatXmlForDisplay (string $xml)
	prettyPrintXml (string $xml)

Detailed Description

Definition at line 27 of file ConnectionTester.php.

Constructor & Destructor Documentation

__construct()

ILIAS\AuthSOAP\ConnectionTester::__construct	(	private \ilSetting	$settings,
		private Factory	$ui_factory,
		private ilLogger	$logger
	)

Definition at line 29 of file ConnectionTester.php.

      {
    }

Member Function Documentation

formatXmlForDisplay()

ILIAS\AuthSOAP\ConnectionTester::formatXmlForDisplay ( string  $xml )

private

Definition at line 82 of file ConnectionTester.php.

                                                     : string
    {
        if (trim($xml) === '') {
            return '(no XML captured)';
        }
 
        $formatted = $this->prettyPrintXml($xml);
        $escaped = htmlspecialchars($formatted, ENT_QUOTES);
        $escaped = str_replace(' ', ' ', $escaped);
 
        return nl2br($escaped, false);
    }

References ILIAS\AuthSOAP\ConnectionTester\prettyPrintXml().

Referenced by ILIAS\AuthSOAP\ConnectionTester\renderXmlBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

prettyPrintXml()

ILIAS\AuthSOAP\ConnectionTester::prettyPrintXml ( string  $xml )

private

Definition at line 95 of file ConnectionTester.php.

                                                : string
    {
        if (trim($xml) === '') {
            return '';
        }
 
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->preserveWhiteSpace = false;
        $dom->formatOutput = true;
 
        if (@$dom->loadXML($xml) === false) {
            return str_replace(['>', '" '], [">\n", "\"\n "], $xml);
        }
 
        return (string) $dom->saveXML();
    }

Referenced by ILIAS\AuthSOAP\ConnectionTester\formatXmlForDisplay().

Here is the caller graph for this function:

renderXmlBlock()

ILIAS\AuthSOAP\ConnectionTester::renderXmlBlock ( string  $xml )

private

Definition at line 75 of file ConnectionTester.php.

                                                : Component
    {
        return $this->ui_factory->legacy()->content(
            $this->formatXmlForDisplay($xml)
        );
    }

References ILIAS\AuthSOAP\ConnectionTester\formatXmlForDisplay().

Referenced by ILIAS\AuthSOAP\ConnectionTester\testConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

testConnection()

ILIAS\AuthSOAP\ConnectionTester::testConnection	(	string	$ext_uid,
		string	$soap_pw,
		bool	$new_user
	)

Returns

list<Component>

Definition at line 39 of file ConnectionTester.php.

                                                                                    : array
    {
        $client = (new SoapAuthEndpoint($this->settings))->createValidationClient();
 
        try {
            $result = $client->validateSession($ext_uid, $soap_pw, $new_user);
        } catch (\SoapFault $e) {
            $this->logger->error('SOAP auth connection test failed: ' . $e->getMessage());
            $this->logger->error($e->getTraceAsString());
 
            return [
                $this->ui_factory->messageBox()->failure(
                    'SOAP Authentication Call Error: ' . $e->getMessage()
                )
            ];
        }
 
        $validation = $result->validation;
        $is_valid = (bool) ($validation['valid'] ?? false);
        $status = $is_valid
            ? $this->ui_factory->messageBox()->success('SOAP authentication succeeded.')
            : $this->ui_factory->messageBox()->info('SOAP authentication returned invalid credentials.');
 
        return [
            $status,
            $this->ui_factory->listing()->descriptive([
                'Valid' => $is_valid ? 'true' : 'false',
                'First Name' => (string) ($validation['firstname'] ?? ''),
                'Last Name' => (string) ($validation['lastname'] ?? ''),
                'Email' => (string) ($validation['email'] ?? ''),
                'Request XML' => $this->renderXmlBlock($result->request),
                'Response XML' => $this->renderXmlBlock($result->response),
            ]),
        ];
    }

References $client, Vendor\Package\$e, $ext_uid, $new_user, $soap_pw, ILIAS\Repository\logger(), ILIAS\AuthSOAP\ConnectionTester\renderXmlBlock(), and ILIAS\Repository\settings().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/AuthSOAP/src/ConnectionTester.php