ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
class.ilSoapInstallationInfoXMLWriter.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
4
5
6include_once "./Services/Xml/classes/class.ilXmlWriter.php";
7
9{
10 private $exportAdvMDDefs = false;
11 private $exportUDFDefs = false;
12
20 function __construct()
21 {
22 parent::__construct();
23 }
24
30 public function setSettings($settings) {
31 $this->settings = $settings;
32 }
33
34 public function start()
35 {
36 $this->__buildHeader();
38 $this->xmlStartTag("Clients");
39 }
40
41 public function addClient ($client) {
42 if (is_object($client))
43 {
44 $this->__buildClient ($client);
45 }
46
47 }
48
49 public function end() {
50 $this->xmlEndTag("Clients");
51 $this->__buildFooter();
52
53 }
54
55 public function getXML()
56 {
57 return $this->xmlDumpMem(FALSE);
58 }
59
60 private function __buildHeader()
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 }
75
76 private function __buildFooter()
77 {
78 $this->xmlEndTag('Installation');
79 }
80
86 private function __buildClient($setting)
87 {
88 // determine skins/styles
89 $skin_styles = array();
90 include_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
91 $skins = ilStyleDefinition::getAllSkins();
92
93 if (is_array($skins))
94 {
95
96 foreach($skins as $skin)
97 {
98 foreach($skin->getStyles() as $style)
99 {
100 include_once("./Services/Style/System/classes/class.ilSystemStyleSettings.php");
101 if (!ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(),$style->getId()))
102 {
103 continue;
104 }
105 $skin_styles [] = $skin->getId().":".$style->getId();
106 }
107 }
108 }
109
110 // timezones
111 include_once('Services/Calendar/classes/class.ilTimeZone.php');
112
113
114 $this->xmlStartTag("Client",
115 array(
116 "inst_id" => $setting->get("inst_id"),
117 "id" => $setting->clientid,
118 "enabled" => $setting->access == 1 ? "TRUE" : "FALSE",
119 "default_lang" => $setting->language,
120
121 ));
122 $this->xmlEndTag("Client");
123
124 return;
125
126
127 // END here due to security reasons.
128
129
130
131 $auth_modes = ilAuthUtils::_getActiveAuthModes();
132 $auth_mode_default = strtoupper(ilAuthUtils::_getAuthModeName(array_shift($auth_modes)));
133 $auth_mode_names = array();
134 foreach ($auth_modes as $mode) {
135 $auth_mode_names[] = strtoupper(ilAuthUtils::_getAuthModeName($mode));
136 }
137
138
139 $this->xmlElement ("Name", null, $setting->get("inst_name"));
140 $this->xmlElement ("Description", null, $setting->description);
141 $this->xmlElement ("Institution", null, $setting->get("inst_institution"));
142 $this->xmlStartTag("Responsible");
143 $this->xmlElement ("Firstname", null, $setting->get("admin_firstname"));
144 $this->xmlElement ("Lastname", null, $setting->get("admin_lastname"));
145 $this->xmlElement ("Title", null, $setting->get("admin_title"));
146 $this->xmlElement ("Institution", null, $setting->get("admin_institution"));
147 $this->xmlElement ("Position", null, $setting->get("admin_position"));
148 $this->xmlElement ("Email", null, $setting->get("admin_email"));
149 $this->xmlElement ("Street ", null, $setting->get("admin_street"));
150 $this->xmlElement ("ZipCode ", null, $setting->get("admin_zipcode"));
151 $this->xmlElement ("City", null, $setting->get("admin_city"));
152 $this->xmlElement ("Country", null, $setting->get("admin_country"));
153 $this->xmlElement ("Phone", null, $setting->get("admin_phone"));
154 $this->xmlEndTag("Responsible");
155 $this->xmlStartTag("Settings");
156 $this->xmlElement("Setting", array("key" => "error_recipient"), $setting->get("error_recipient"));
157 $this->xmlElement("Setting", array("key" => "feedback_recipient"), $setting->get("feedback_recipient"));
158 $this->xmlElement("Setting", array("key" => "session_expiration"), $setting->session);
159 $this->xmlElement("Setting", array("key" => "soap_enabled"), $setting->get("soap_user_administration"));
160 $this->xmlElement("Setting", array("key" => "authentication_methods"), join(",", $auth_mode_names));
161 $this->xmlElement("Setting", array("key" => "authentication_default_method"), $auth_mode_default);
162 $this->xmlElement("Setting", array("key" => "skins"), join(",", $skin_styles));
163 $this->xmlElement("Setting", array("key" => "default_skin"), $setting->default_skin_style);
164 $this->xmlElement("Setting", array("key" => "default_timezone"), ilTimeZone::_getDefaultTimeZone());
165 $this->xmlElement("Setting", array("key" => "default_hits_per_page"), $setting->default_hits_per_page);
166 $this->xmlElement("Setting", array("key" => "default_show_users_online"), $setting->default_show_users_online);
167 $this->xmlEndTag("Settings");
168
169 if ($this->exportAdvMDDefs)
170 {
171 // create advanced meta data record xml
172 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
173 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordXMLWriter.php';
174
175 $record_ids = array();
177
178 foreach($record_types as $type_info) {
179 $type = $type_info['obj_type'];
181 foreach ($records as $record){
182 $record_ids [] = $record->getRecordId();
183 }
184 }
185 $record_ids = array_unique($record_ids);
186 $this->xmlStartTag('AdvancedMetaDataRecords');
187
188 if (count($record_ids) > 0)
189 {
190 foreach($record_ids as $record_id)
191 {
192 $record_obj = ilAdvancedMDRecord::_getInstanceByrecordId($record_id);
193 $record_obj->toXML($this);
194 }
195 }
196 $this->xmlEndTag('AdvancedMetaDataRecords');
197 }
198
199 if ($this->exportUDFDefs)
200 {
201 // create user defined fields record xml
202 include_once ("./Services/User/classes/class.ilUserDefinedFields.php");
203 $udf_data = & ilUserDefinedFields::_newInstance();
204 $udf_data->addToXML($this);
205 }
206
207
208 $this->xmlEndTag("Client");
209 }
210
211 private function __buildInstallationInfo()
212 {
213 $this->xmlStartTag("Settings");
214 $this->xmlElement("Setting", array("key" => "default_client"), $GLOBALS['ilIliasIniFile']->readVariable("clients","default"));
215 #$this->xmlElement("Setting", array("key" => "post_max_size"), ilSoapAdministration::return_bytes(ini_get("post_max_size")));
216 #$this->xmlElement("Setting", array("key" => "upload_max_filesize"), ilSoapAdministration::return_bytes(ini_get("upload_max_filesize")));
217 $this->xmlEndTag("Settings");
218 }
219
225 public function setExportAdvancedMetaDataDefinitions ($value) {
226 $this->exportAdvMDDefs = $value ? true : false;
227 }
228
229
235 public function setExportUDFDefinitions ($value)
236 {
237 $this->exportUDFDefs = $value ? true: false;
238 }
239
240}
241
242?>
An exception for terminatinating execution or to throw for unit testing.
readVariable($a_group, $a_var_name)
reads a single variable from a group @access public
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 _getActiveAuthModes()
static _getAuthModeName($a_auth_key)
static buildHTTPPath()
builds http path if no client is available
setExportAdvancedMetaDataDefinitions($value)
write access, if set to true advanced meta data definitions will be exported s well
setSettings($settings)
write access to property settings
setExportUDFDefinitions($value)
write access, if set to true, user defined field definitions will be exported as well
static _lookupActivatedStyle($a_skin, $a_style)
lookup if a style is activated
static _getDefaultTimeZone()
Calculate and set default time zone.
XML writer class.
xmlEndTag($tag)
Writes an endtag.
xmlDumpMem($format=TRUE)
Returns xml document from memory.
xmlSetGenCmt($genCmt)
Sets generated comment.
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.
xmlHeader()
Writes xml header @access public.
xmlSetDtdDef($dtdDef)
Sets dtd definition.
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)
$client
$style
Definition: example_012.php:70
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
const ILIAS_VERSION
$records
Definition: simple_test.php:22
settings()
Definition: settings.php:2