This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSoapInstallationInfoXMLWriter:

Collaboration diagram for ilSoapInstallationInfoXMLWriter:

Public Member Functions
	setSettings (array $settings)

	start ()

	addClient (string $client_directory)

	end ()

	getXML ()

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Protected Attributes
array	$settings = []

Private Member Functions
	buildHeader ()

	buildFooter ()

	buildClient (string $client_directory)

	buildInstallationInfo ()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 of file class.ilSoapInstallationInfoXMLWriter.php.

Member Function Documentation

◆ addClient()

ilSoapInstallationInfoXMLWriter::addClient ( string $client_directory )

Definition at line 35 of file class.ilSoapInstallationInfoXMLWriter.php.

References buildClient().

                                                        : bool
     {
         return $this->buildClient($client_directory);
     }

Here is the call graph for this function:

◆ buildClient()

ilSoapInstallationInfoXMLWriter::buildClient ( string $client_directory )

private

Definition at line 72 of file class.ilSoapInstallationInfoXMLWriter.php.

References $client_id, $DIC, $ilDB, $settings, ilDBWrapperFactory\getWrapper(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by addClient().

                                                           : bool
     {
         global $DIC;
 
         $ini_file = "./" . $client_directory . "/client.ini.php";
 
         // get settings from ini file
 
         $ilClientIniFile = new ilIniFile($ini_file);
         $ilClientIniFile->read();
         if ($ilClientIniFile->ERROR !== "") {
             return false;
         }
         $client_id = $ilClientIniFile->readVariable('client', 'name');
         if ($ilClientIniFile->variableExists('client', 'expose')) {
             $client_expose = $ilClientIniFile->readVariable('client', 'expose');
             if ($client_expose === "0") {
                 return false;
             }
         }
 
         // build dsn of database connection and connect
         $ilDB = ilDBWrapperFactory::getWrapper(
             $ilClientIniFile->readVariable("db", "type")
         );
         $ilDB->initFromIniFile($ilClientIniFile);
         if ($ilDB->connect(true)) {
             unset($DIC['ilDB']);
             $DIC['ilDB'] = $ilDB;
 
 
             $settings = new ilSetting();
             unset($DIC["ilSetting"]);
             $DIC["ilSetting"] = $settings;
 
             // workaround to determine http path of client
             define("IL_INST_ID", (int) $settings->get("inst_id", '0'));
 
             $this->xmlStartTag(
                 "Client",
                 [
                     "inst_id" => $settings->get("inst_id"),
                     "id" => basename($client_directory),
                     'enabled' =>  $ilClientIniFile->readVariable("client", "access") ? "TRUE" : "FALSE",
                     "default_lang" => $ilClientIniFile->readVariable("language", "default")
                 ]
             );
             $this->xmlEndTag("Client");
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFooter()

ilSoapInstallationInfoXMLWriter::buildFooter ( )

private

Definition at line 67 of file class.ilSoapInstallationInfoXMLWriter.php.

References ilXmlWriter\xmlEndTag().

Referenced by end().

                                   : void
     {
         $this->xmlEndTag('Installation');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeader()

ilSoapInstallationInfoXMLWriter::buildHeader ( )

private

Definition at line 51 of file class.ilSoapInstallationInfoXMLWriter.php.

References ilSoapFunctions\buildHTTPPath(), ILIAS_VERSION, ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), ilXmlWriter\xmlSetGenCmt(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                   : void
     {
         // we have to build the http path here since this request is client independent!
         $httpPath = ilSoapFunctions::buildHTTPPath();
         $this->xmlSetDtdDef("<!DOCTYPE Installation PUBLIC \"-//ILIAS//DTD InstallationInfo//EN\" \"" . $httpPath . "/components/ILIAS/Export/xml/ilias_installation_info_5_3.dtd\">");
         $this->xmlSetGenCmt("Export of ILIAS clients.");
         $this->xmlHeader();
         $this->xmlStartTag(
             "Installation",
             array(
                 "version" => ILIAS_VERSION,
                 "path" => $httpPath,
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildInstallationInfo()

ilSoapInstallationInfoXMLWriter::buildInstallationInfo ( )

private

Definition at line 124 of file class.ilSoapInstallationInfoXMLWriter.php.

References $GLOBALS, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                             : void
     {
         $this->xmlStartTag("Settings");
         $this->xmlElement(
             "Setting",
             array("key" => "default_client"),
             $GLOBALS['DIC']['ilIliasIniFile']->readVariable("clients", "default")
         );
         $this->xmlEndTag("Settings");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end()

ilSoapInstallationInfoXMLWriter::end ( )

Definition at line 40 of file class.ilSoapInstallationInfoXMLWriter.php.

References buildFooter(), and ilXmlWriter\xmlEndTag().

                          : void
     {
         $this->xmlEndTag("Clients");
         $this->buildFooter();
     }

Here is the call graph for this function:

◆ getXML()

ilSoapInstallationInfoXMLWriter::getXML ( )

Definition at line 46 of file class.ilSoapInstallationInfoXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

                             : string
     {
         return $this->xmlDumpMem(false);
     }

Here is the call graph for this function:

◆ setSettings()

ilSoapInstallationInfoXMLWriter::setSettings ( array $settings )

Definition at line 23 of file class.ilSoapInstallationInfoXMLWriter.php.

References $settings, and ILIAS\Repository\settings().

                                                 : void
     {
         $this->settings = $settings;
     }

Here is the call graph for this function:

◆ start()

ilSoapInstallationInfoXMLWriter::start ( )

Definition at line 28 of file class.ilSoapInstallationInfoXMLWriter.php.

References buildHeader(), buildInstallationInfo(), and ilXmlWriter\xmlStartTag().

                            : void
     {
         $this->buildHeader();
         $this->buildInstallationInfo();
         $this->xmlStartTag("Clients");
     }