ilSoapInstallationInfoXMLWriter Class Reference

Inheritance diagram for ilSoapInstallationInfoXMLWriter:

Collaboration diagram for ilSoapInstallationInfoXMLWriter:

Public Member Functions
	__construct ()
	constructor More...
	setSettings ($settings)
	write access to property settings More...
	start ()
	addClient ($client)
	end ()
	getXML ()
	setExportAdvancedMetaDataDefinitions ($value)
	write access, if set to true advanced meta data definitions will be exported s well More...
	setExportUDFDefinitions ($value)
	write access, if set to true, user defined field definitions will be exported as well More...
Public Member Functions inherited from ilXmlWriter
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...
	_ilXmlWriter ()
	destructor public More...
	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...
	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...
	xmlSetGenCmt ($genCmt)
	Sets generated comment. More...
	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...
	xmlFormatData ($data)
	Indents text for better reading. More...
	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...
	xmlHeader ()
	Writes xml header public. More...
	xmlStartTag ($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
	Writes a starttag. More...
	xmlEndTag ($tag)
	Writes an endtag. More...
	xmlComment ($comment)
	Writes a comment. More...
	xmlData ($data, $encode=true, $escape=true)
	Writes data. More...
	xmlElement ($tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile ($file, $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem ($format=true)
	Returns xml document from memory. More...
	appendXML ($a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr public More...

Private Member Functions
	__buildHeader ()
	__buildFooter ()
	__buildClient ($setting)
	create client tag More...
	__buildInstallationInfo ()

Private Attributes
	$exportAdvMDDefs = false
	$exportUDFDefs = false

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...
Data Fields inherited from ilXmlWriter
	$xmlStr
	$version
	$outEnc
	$inEnc
	$dtdDef = ""
	$stSheet = ""
	$genCmt = "Generated by ILIAS XmlWriter"

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSoapInstallationInfoXMLWriter::__construct

(

)

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

    {
        parent::__construct();
    }

Member Function Documentation

__buildClient()

ilSoapInstallationInfoXMLWriter::__buildClient (   $setting )

private

create client tag

Parameters

ilSetting

$setting

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

References $records, $style, $type, ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), ilAuthUtils\_getActiveAuthModes(), ilAdvancedMDRecord\_getAssignableObjectTypes(), ilAuthUtils\_getAuthModeName(), ilTimeZone\_getDefaultTimeZone(), ilSystemStyleSettings\_lookupActivatedStyle(), ilUserDefinedFields\_newInstance(), array, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by addClient().

    {
        // determine skins/styles
        $skin_styles = array();
        include_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
        $skins = ilStyleDefinition::getAllSkins();

        if (is_array($skins)) {
            foreach ($skins as $skin) {
                foreach ($skin->getStyles() as $style) {
                    include_once("./Services/Style/System/classes/class.ilSystemStyleSettings.php");
                    if (!ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(), $style->getId())) {
                        continue;
                    }
                    $skin_styles [] = $skin->getId() . ":" . $style->getId();
                }
            }
        }

        // timezones
        include_once('Services/Calendar/classes/class.ilTimeZone.php');
        
        
        $this->xmlStartTag(
            "Client",
            array(
                "inst_id" => $setting->get("inst_id"),
                "id" => $setting->clientid,
                "enabled" => $setting->access == 1 ? "TRUE" : "FALSE",
                "default_lang" => $setting->language,
                
            )
        );
        $this->xmlEndTag("Client");
        
        return;
        
        
        // END here due to security reasons.

        
        
        $auth_modes = ilAuthUtils::_getActiveAuthModes();
        $auth_mode_default =  strtoupper(ilAuthUtils::_getAuthModeName(array_shift($auth_modes)));
        $auth_mode_names = array();
        foreach ($auth_modes as $mode) {
            $auth_mode_names[] = strtoupper(ilAuthUtils::_getAuthModeName($mode));
        }
        

        $this->xmlElement("Name", null, $setting->get("inst_name"));
        $this->xmlElement("Description", null, $setting->description);
        $this->xmlElement("Institution", null, $setting->get("inst_institution"));
        $this->xmlStartTag("Responsible");
        $this->xmlElement("Firstname", null, $setting->get("admin_firstname"));
        $this->xmlElement("Lastname", null, $setting->get("admin_lastname"));
        $this->xmlElement("Title", null, $setting->get("admin_title"));
        $this->xmlElement("Institution", null, $setting->get("admin_institution"));
        $this->xmlElement("Position", null, $setting->get("admin_position"));
        $this->xmlElement("Email", null, $setting->get("admin_email"));
        $this->xmlElement("Street ", null, $setting->get("admin_street"));
        $this->xmlElement("ZipCode ", null, $setting->get("admin_zipcode"));
        $this->xmlElement("City", null, $setting->get("admin_city"));
        $this->xmlElement("Country", null, $setting->get("admin_country"));
        $this->xmlElement("Phone", null, $setting->get("admin_phone"));
        $this->xmlEndTag("Responsible");
        $this->xmlStartTag("Settings");
        $this->xmlElement("Setting", array("key" => "error_recipient"), $setting->get("error_recipient"));
        $this->xmlElement("Setting", array("key" => "feedback_recipient"), $setting->get("feedback_recipient"));
        $this->xmlElement("Setting", array("key" => "session_expiration"), $setting->session);
        $this->xmlElement("Setting", array("key" => "soap_enabled"), $setting->get("soap_user_administration"));
        $this->xmlElement("Setting", array("key" => "authentication_methods"), join(",", $auth_mode_names));
        $this->xmlElement("Setting", array("key" => "authentication_default_method"), $auth_mode_default);
        $this->xmlElement("Setting", array("key" => "skins"), join(",", $skin_styles));
        $this->xmlElement("Setting", array("key" => "default_skin"), $setting->default_skin_style);
        $this->xmlElement("Setting", array("key" => "default_timezone"), ilTimeZone::_getDefaultTimeZone());
        $this->xmlElement("Setting", array("key" => "default_hits_per_page"), $setting->default_hits_per_page);
        $this->xmlElement("Setting", array("key" => "default_show_users_online"), $setting->default_show_users_online);
        $this->xmlEndTag("Settings");
        
        if ($this->exportAdvMDDefs) {
            // create advanced meta data record xml
            include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
            include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordXMLWriter.php';
            
            $record_ids = array();
            $record_types = ilAdvancedMDRecord::_getAssignableObjectTypes();
            
            foreach ($record_types as $type_info) {
                $type = $type_info['obj_type'];
                $records = ilAdvancedMDRecord::_getActivatedRecordsByObjectType($type);
                foreach ($records as $record) {
                    $record_ids [] = $record->getRecordId();
                }
            }
            $record_ids = array_unique($record_ids);
            $this->xmlStartTag('AdvancedMetaDataRecords');
        
            if (count($record_ids) > 0) {
                foreach ($record_ids as $record_id) {
                    $record_obj = ilAdvancedMDRecord::_getInstanceByrecordId($record_id);
                    $record_obj->toXML($this);
                }
            }
            $this->xmlEndTag('AdvancedMetaDataRecords');
        }
        
        if ($this->exportUDFDefs) {
            // create user defined fields record xml
            include_once("./Services/User/classes/class.ilUserDefinedFields.php");
            $udf_data = &ilUserDefinedFields::_newInstance();
            $udf_data->addToXML($this);
        }
                

        $this->xmlEndTag("Client");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildFooter()

ilSoapInstallationInfoXMLWriter::__buildFooter ( )

private

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

References ilXmlWriter\xmlEndTag().

Referenced by end().

    {
        $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 60 of file class.ilSoapInstallationInfoXMLWriter.php.

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

Referenced by start().

    {
        // 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 . "/xml/ilias_installation_info_5_3.dtd\">");
        $this->xmlSetGenCmt("Export of ILIAS clients.");
        $this->xmlHeader();
        $this->xmlStartTag(
            "Installation",
            array(
                "version" => ILIAS_VERSION,
                "path" => $httpPath,
            )
        );
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildInstallationInfo()

ilSoapInstallationInfoXMLWriter::__buildInstallationInfo ( )

private

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

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

Referenced by start().

    {
        $this->xmlStartTag("Settings");
        $this->xmlElement("Setting", array("key" => "default_client"), $GLOBALS['ilIliasIniFile']->readVariable("clients", "default"));
        #$this->xmlElement("Setting", array("key" => "post_max_size"), ilSoapAdministration::return_bytes(ini_get("post_max_size")));
        #$this->xmlElement("Setting", array("key" => "upload_max_filesize"), ilSoapAdministration::return_bytes(ini_get("upload_max_filesize")));
        $this->xmlEndTag("Settings");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addClient()

ilSoapInstallationInfoXMLWriter::addClient

(

$client

)

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

References $client, and __buildClient().

    {
        if (is_object($client)) {
            $this->__buildClient($client);
        }
    }

Here is the call graph for this function:

end()

ilSoapInstallationInfoXMLWriter::end

(

)

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

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

    {
        $this->xmlEndTag("Clients");
        $this->__buildFooter();
    }

Here is the call graph for this function:

getXML()

ilSoapInstallationInfoXMLWriter::getXML

(

)

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

setExportAdvancedMetaDataDefinitions()

ilSoapInstallationInfoXMLWriter::setExportAdvancedMetaDataDefinitions

(

$value

)

write access, if set to true advanced meta data definitions will be exported s well

Parameters

boolean

$value

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

    {
        $this->exportAdvMDDefs = $value ? true : false;
    }

setExportUDFDefinitions()

ilSoapInstallationInfoXMLWriter::setExportUDFDefinitions

(

$value

)

write access, if set to true, user defined field definitions will be exported as well

Parameters

boolean

$value

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

    {
        $this->exportUDFDefs = $value ? true: false;
    }

setSettings()

ilSoapInstallationInfoXMLWriter::setSettings

(

$settings

)

write access to property settings

Parameters

array

$settings

is an array of ilSetting Objects

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

References settings().

    {
        $this->settings = $settings;
    }

Here is the call graph for this function:

start()

ilSoapInstallationInfoXMLWriter::start

(

)

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

References __buildHeader(), __buildInstallationInfo(), and ilXmlWriter\xmlStartTag().

    {
        $this->__buildHeader();
        $this->__buildInstallationInfo();
        $this->xmlStartTag("Clients");
    }

Here is the call graph for this function:

Field Documentation

$exportAdvMDDefs

ilSoapInstallationInfoXMLWriter::$exportAdvMDDefs = false

private

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

$exportUDFDefs

ilSoapInstallationInfoXMLWriter::$exportUDFDefs = false

private

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

---

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

• webservice/soap/classes/class.ilSoapInstallationInfoXMLWriter.php