ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilSoapInstallationInfoXMLWriter Class Reference
+ Inheritance diagram for ilSoapInstallationInfoXMLWriter:
+ Collaboration diagram for ilSoapInstallationInfoXMLWriter:

Public Member Functions

 ilSoapInstallationInfoXMLWriter ()
 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
 ilXmlWriter ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
 constructor More...
 
 _ilXmlWriter ()
 destructor @access public More...
 
 xmlSetDtdDef ($dtdDef)
 Sets dtd definition. More...
 
 xmlSetStSheet ($stSheet)
 Sets stylesheet. More...
 
 xmlSetGenCmt ($genCmt)
 Sets generated comment. More...
 
 _xmlEscapeData ($data)
 Escapes reserved characters. 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 @access 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 @access public More...
 

Private Member Functions

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

Private Attributes

 $exportAdvMDDefs = false
 
 $exportUDFDefs = false
 

Additional Inherited Members

- 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.

Member Function Documentation

◆ __buildClient()

ilSoapInstallationInfoXMLWriter::__buildClient (   $setting)
private

create client tag

Parameters
ilSetting$setting

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

87 {
88 // determine skins/styles
89 $skin_styles = array();
90 include_once("./Services/Style/classes/class.ilStyleDefinition.php");
91 $styleDefinition = new ilStyleDefinition();
92 include_once("./Services/Style/classes/class.ilObjStyleSettings.php");
93 $templates = $styleDefinition->getAllTemplates();
94
95 if (is_array($templates))
96 {
97
98 foreach($templates as $template)
99 {
100 // get styles information of template
101 $styleDef =& new ilStyleDefinition($template["id"]);
102 $styleDef->startParsing();
103 $styles = $styleDef->getStyles();
104
105 foreach($styles as $style)
106 {
107 if (!ilObjStyleSettings::_lookupActivatedStyle($template["id"],$style["id"]))
108 {
109 continue;
110 }
111 $skin_styles [] = $template["id"].":".$style["id"];
112 }
113 }
114 }
115 // timezones
116 include_once('Services/Calendar/classes/class.ilTimeZone.php');
117
118
119 $this->xmlStartTag("Client",
120 array(
121 "inst_id" => $setting->get("inst_id"),
122 "id" => $setting->clientid,
123 "enabled" => $setting->access == 1 ? "TRUE" : "FALSE",
124 "default_lang" => $setting->language,
125
126 ));
127 $this->xmlEndTag("Client");
128
129 return;
130
131
132 // END here due to security reasons.
133
134
135
136 $auth_modes = ilAuthUtils::_getActiveAuthModes();
137 $auth_mode_default = strtoupper(ilAuthUtils::_getAuthModeName(array_shift($auth_modes)));
138 $auth_mode_names = array();
139 foreach ($auth_modes as $mode) {
140 $auth_mode_names[] = strtoupper(ilAuthUtils::_getAuthModeName($mode));
141 }
142
143
144 $this->xmlElement ("Name", null, $setting->get("inst_name"));
145 $this->xmlElement ("Description", null, $setting->description);
146 $this->xmlElement ("Institution", null, $setting->get("inst_institution"));
147 $this->xmlStartTag("Responsible");
148 $this->xmlElement ("Firstname", null, $setting->get("admin_firstname"));
149 $this->xmlElement ("Lastname", null, $setting->get("admin_lastname"));
150 $this->xmlElement ("Title", null, $setting->get("admin_title"));
151 $this->xmlElement ("Institution", null, $setting->get("admin_institution"));
152 $this->xmlElement ("Position", null, $setting->get("admin_position"));
153 $this->xmlElement ("Email", null, $setting->get("admin_email"));
154 $this->xmlElement ("Street ", null, $setting->get("admin_street"));
155 $this->xmlElement ("ZipCode ", null, $setting->get("admin_zipcode"));
156 $this->xmlElement ("City", null, $setting->get("admin_city"));
157 $this->xmlElement ("Country", null, $setting->get("admin_country"));
158 $this->xmlElement ("Phone", null, $setting->get("admin_phone"));
159 $this->xmlEndTag("Responsible");
160 $this->xmlStartTag("Settings");
161 $this->xmlElement("Setting", array("key" => "error_recipient"), $setting->get("error_recipient"));
162 $this->xmlElement("Setting", array("key" => "feedback_recipient"), $setting->get("feedback_recipient"));
163 $this->xmlElement("Setting", array("key" => "session_expiration"), $setting->session);
164 $this->xmlElement("Setting", array("key" => "soap_enabled"), $setting->get("soap_user_administration"));
165 $this->xmlElement("Setting", array("key" => "authentication_methods"), join(",", $auth_mode_names));
166 $this->xmlElement("Setting", array("key" => "authentication_default_method"), $auth_mode_default);
167 $this->xmlElement("Setting", array("key" => "skins"), join(",", $skin_styles));
168 $this->xmlElement("Setting", array("key" => "default_skin"), $setting->default_skin_style);
169 $this->xmlElement("Setting", array("key" => "default_timezone"), ilTimeZone::_getDefaultTimeZone());
170 $this->xmlElement("Setting", array("key" => "default_hits_per_page"), $setting->default_hits_per_page);
171 $this->xmlElement("Setting", array("key" => "default_show_users_online"), $setting->default_show_users_online);
172 $this->xmlEndTag("Settings");
173
174 if ($this->exportAdvMDDefs)
175 {
176 // create advanced meta data record xml
177 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
178 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordXMLWriter.php';
179
180 $record_ids = array();
182
183 foreach($record_types as $type) {
185 foreach ($records as $record){
186 $record_ids [] = $record->getRecordId();
187 }
188 }
189 $record_ids = array_unique($record_ids);
190 $this->xmlStartTag('AdvancedMetaDataRecords');
191
192 if (count($record_ids) > 0)
193 {
194 foreach($record_ids as $record_id)
195 {
196 $record_obj = ilAdvancedMDRecord::_getInstanceByrecordId($record_id);
197 $record_obj->toXML($this);
198 }
199 }
200 $this->xmlEndTag('AdvancedMetaDataRecords');
201 }
202
203 if ($this->exportUDFDefs)
204 {
205 // create user defined fields record xml
206 include_once ("./Services/User/classes/class.ilUserDefinedFields.php");
207 $udf_data = & ilUserDefinedFields::_newInstance();
208 $udf_data->addToXML($this);
209 }
210
211
212 $this->xmlEndTag("Client");
213 }
static _getActivatedRecordsByObjectType($a_obj_type, $a_sub_type="", $a_only_optional=false)
Get activated records by object type.
static _getAssignableObjectTypes($a_include_text=false)
Get assignable object type.
static _getAuthModeName($a_auth_key)
_lookupActivatedStyle($a_skin, $a_style)
lookup if a style is activated
parses the template.xml that defines all styles of the current template
static _getDefaultTimeZone()
Calculate and set default time zone.
xmlEndTag($tag)
Writes an endtag.
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)
$style
Definition: example_012.php:70
$records
Definition: simple_test.php:17

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

Referenced by addClient().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __buildFooter()

ilSoapInstallationInfoXMLWriter::__buildFooter ( )
private

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

77 {
78 $this->xmlEndTag('Installation');
79 }

References ilXmlWriter\xmlEndTag().

Referenced by end().

+ 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.

61 {
62 // we have to build the http path here since this request is client independent!
63 $httpPath = ilSoapFunctions::buildHTTPPath();
64 $this->xmlSetDtdDef("<!DOCTYPE Installation PUBLIC \"-//ILIAS//DTD Group//EN\" \"".$httpPath ."/xml/ilias_client_3_10.dtd\">");
65 $this->xmlSetGenCmt("Export of ILIAS clients.");
66 $this->xmlHeader();
67 $this->xmlStartTag("Installation",
68 array (
69 "version" => ILIAS_VERSION,
70 "path" => $httpPath,
71 ));
72
73 return true;
74 }
static buildHTTPPath()
builds http path if no client is available
xmlSetGenCmt($genCmt)
Sets generated comment.
xmlHeader()
Writes xml header @access public.
xmlSetDtdDef($dtdDef)
Sets dtd definition.
const ILIAS_VERSION

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

Referenced by start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __buildInstallationInfo()

ilSoapInstallationInfoXMLWriter::__buildInstallationInfo ( )
private

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

216 {
217 $this->xmlStartTag("Settings");
218 $this->xmlElement("Setting", array("key" => "default_client"), $GLOBALS['ilIliasIniFile']->readVariable("clients","default"));
219 #$this->xmlElement("Setting", array("key" => "post_max_size"), ilSoapAdministration::return_bytes(ini_get("post_max_size")));
220 #$this->xmlElement("Setting", array("key" => "upload_max_filesize"), ilSoapAdministration::return_bytes(ini_get("upload_max_filesize")));
221 $this->xmlEndTag("Settings");
222 }
readVariable($a_group, $a_var_name)
reads a single variable from a group @access public
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276

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

Referenced by start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addClient()

ilSoapInstallationInfoXMLWriter::addClient (   $client)

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

41 {
42 if (is_object($client))
43 {
44 $this->__buildClient ($client);
45 }
46
47 }

References $client, and __buildClient().

+ Here is the call graph for this function:

◆ end()

ilSoapInstallationInfoXMLWriter::end ( )

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

49 {
50 $this->xmlEndTag("Clients");
51 $this->__buildFooter();
52
53 }

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

+ Here is the call graph for this function:

◆ getXML()

ilSoapInstallationInfoXMLWriter::getXML ( )

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

56 {
57 return $this->xmlDumpMem(FALSE);
58 }
xmlDumpMem($format=TRUE)
Returns xml document from memory.

References ilXmlWriter\xmlDumpMem().

+ Here is the call graph for this function:

◆ ilSoapInstallationInfoXMLWriter()

ilSoapInstallationInfoXMLWriter::ilSoapInstallationInfoXMLWriter ( )

constructor

Parameters
stringxml version
stringoutput encoding
stringinput encoding @access public

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

21 {
22 parent::ilXmlWriter();
23 }

◆ 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 229 of file class.ilSoapInstallationInfoXMLWriter.php.

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

◆ 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 239 of file class.ilSoapInstallationInfoXMLWriter.php.

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

◆ setSettings()

ilSoapInstallationInfoXMLWriter::setSettings (   $settings)

write access to property settings

Parameters
array$settingsis an array of ilSetting Objects

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

30 {
31 $this->settings = $settings;
32 }

◆ start()

ilSoapInstallationInfoXMLWriter::start ( )

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: