ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
class.ilMDGeneral.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2001 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
24
32include_once 'class.ilMDBase.php';
33
34class ilMDGeneral extends ilMDBase
35{
36 public function getPossibleSubelements()
37 {
38 $subs['Keyword'] = 'meta_keyword';
39 $subs['Language'] = 'meta_language';
40 $subs['Identifier'] = 'meta_identifier';
41 $subs['Description'] = 'meta_description';
42
43 return $subs;
44 }
45
46
47 // Subelements (Identifier, Language, Description, Keyword)
48 public function &getIdentifierIds()
49 {
50 include_once 'Services/MetaData/classes/class.ilMDIdentifier.php';
51
52 return ilMDIdentifier::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_general');
53 }
54 public function &getIdentifier($a_identifier_id)
55 {
56 include_once 'Services/MetaData/classes/class.ilMDIdentifier.php';
57
58 if (!$a_identifier_id) {
59 return false;
60 }
61 $ide = new ilMDIdentifier();
62 $ide->setMetaId($a_identifier_id);
63
64 return $ide;
65 }
66 public function &addIdentifier()
67 {
68 include_once 'Services/MetaData/classes/class.ilMDIdentifier.php';
69
70 $ide = new ilMDIdentifier($this->getRBACId(), $this->getObjId(), $this->getObjType());
71 $ide->setParentId($this->getMetaId());
72 $ide->setParentType('meta_general');
73
74 return $ide;
75 }
76 public function &getLanguageIds()
77 {
78 include_once 'Services/MetaData/classes/class.ilMDLanguage.php';
79
80 return ilMDLanguage::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_general');
81 }
82 public function &getLanguage($a_language_id)
83 {
84 include_once 'Services/MetaData/classes/class.ilMDLanguage.php';
85
86 if (!$a_language_id) {
87 return false;
88 }
89 $lan = new ilMDLanguage();
90 $lan->setMetaId($a_language_id);
91
92 return $lan;
93 }
94 public function &addLanguage()
95 {
96 include_once 'Services/MetaData/classes/class.ilMDLanguage.php';
97
98 $lan = new ilMDLanguage($this->getRBACId(), $this->getObjId(), $this->getObjType());
99 $lan->setParentId($this->getMetaId());
100 $lan->setParentType('meta_general');
101
102 return $lan;
103 }
104 public function &getDescriptionIds()
105 {
106 include_once 'Services/MetaData/classes/class.ilMDDescription.php';
107
108 return ilMDDescription::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_general');
109 }
110 public function &getDescription($a_description_id)
111 {
112 include_once 'Services/MetaData/classes/class.ilMDDescription.php';
113
114
115 if (!$a_description_id) {
116 return false;
117 }
118 $des = new ilMDDescription();
119 $des->setMetaId($a_description_id);
120
121 return $des;
122 }
123 public function &addDescription()
124 {
125 include_once 'Services/MetaData/classes/class.ilMDDescription.php';
126
127 $des = new ilMDDescription($this->getRBACId(), $this->getObjId(), $this->getObjType());
128 $des->setParentId($this->getMetaId());
129 $des->setParentType('meta_general');
130
131 return $des;
132 }
133 public function &getKeywordIds()
134 {
135 include_once 'Services/MetaData/classes/class.ilMDKeyword.php';
136
137 return ilMDKeyword::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_general');
138 }
139 public function &getKeyword($a_keyword_id)
140 {
141 include_once 'Services/MetaData/classes/class.ilMDKeyword.php';
142
143 if (!$a_keyword_id) {
144 return false;
145 }
146 $key = new ilMDKeyword();
147 $key->setMetaId($a_keyword_id);
148
149 return $key;
150 }
151 public function &addKeyword()
152 {
153 include_once 'Services/MetaData/classes/class.ilMDKeyword.php';
154
155 $key = new ilMDKeyword($this->getRBACId(), $this->getObjId(), $this->getObjType());
156 $key->setParentId($this->getMetaId());
157 $key->setParentType('meta_general');
158
159 return $key;
160 }
161
162
163
164 // SET/GET
165 public function setStructure($a_structure)
166 {
167 switch ($a_structure) {
168 case 'Atomic':
169 case 'Collection':
170 case 'Networked':
171 case 'Hierarchical':
172 case 'Linear':
173 $this->structure = $a_structure;
174 return true;
175
176 default:
177 return false;
178 }
179 }
180 public function getStructure()
181 {
182 return $this->structure;
183 }
184 public function setTitle($a_title)
185 {
186 $this->title = $a_title;
187 }
188 public function getTitle()
189 {
190 return $this->title;
191 }
192 public function setTitleLanguage(&$lng_obj)
193 {
194 if (is_object($lng_obj)) {
195 $this->title_language = $lng_obj;
196 }
197 }
198 public function &getTitleLanguage()
199 {
200 return is_object($this->title_language) ? $this->title_language : false;
201 }
202 public function getTitleLanguageCode()
203 {
204 return is_object($this->title_language) ? $this->title_language->getLanguageCode() : false;
205 }
206
207 public function setCoverage($a_coverage)
208 {
209 $this->coverage = $a_coverage;
210 }
211 public function getCoverage()
212 {
213 return $this->coverage;
214 }
215
216 public function setCoverageLanguage(&$lng_obj)
217 {
218 if (is_object($lng_obj)) {
219 $this->coverage_language = $lng_obj;
220 }
221 }
222 public function &getCoverageLanguage()
223 {
224 return is_object($this->coverage_language) ? $this->coverage_language : false;
225 }
226 public function getCoverageLanguageCode()
227 {
228 return is_object($this->coverage_language) ? $this->coverage_language->getLanguageCode() : false;
229 }
230
231
232 public function save()
233 {
234 global $ilDB;
235
236 $fields = $this->__getFields();
237 $fields['meta_general_id'] = array('integer',$next_id = $ilDB->nextId('il_meta_general'));
238
239 //$this->log->debug("Insert General ".print_r($fields, true));
240 //ilUtil::printBacktrace(10);
241
242 if ($this->db->insert('il_meta_general', $fields)) {
243 $this->setMetaId($next_id);
244 return $this->getMetaId();
245 }
246 return false;
247 }
248
249 public function update()
250 {
251 global $ilDB;
252
253 if ($this->getMetaId()) {
254 if ($this->db->update(
255 'il_meta_general',
256 $this->__getFields(),
257 array("meta_general_id" => array('integer',$this->getMetaId()))
258 )) {
259 return true;
260 }
261 }
262 return false;
263 }
264
265 public function delete()
266 {
267 global $ilDB;
268
269 if (!$this->getMetaId()) {
270 return false;
271 }
272 // Identifier
273 foreach ($this->getIdentifierIds() as $id) {
274 $ide = $this->getIdentifier($id);
275 $ide->delete();
276 }
277
278 // Language
279 foreach ($this->getLanguageIds() as $id) {
280 $lan = $this->getLanguage($id);
281 $lan->delete();
282 }
283
284 // Description
285 foreach ($this->getDescriptionIds() as $id) {
286 $des = $this->getDescription($id);
287 $des->delete();
288 }
289
290 // Keyword
291 foreach ($this->getKeywordIds() as $id) {
292 $key = $this->getKeyword($id);
293 $key->delete();
294 }
295
296 if ($this->getMetaId()) {
297 $query = "DELETE FROM il_meta_general " .
298 "WHERE meta_general_id = " . $ilDB->quote($this->getMetaId(), 'integer');
299 $res = $ilDB->manipulate($query);
300 return true;
301 }
302
303
304 return false;
305 }
306
307
308 public function __getFields()
309 {
310 return array('rbac_id' => array('integer',$this->getRBACId()),
311 'obj_id' => array('integer',$this->getObjId()),
312 'obj_type' => array('text',$this->getObjType()),
313 'general_structure' => array('text',$this->getStructure()),
314 'title' => array('text',$this->getTitle()),
315 'title_language' => array('text',$this->getTitleLanguageCode()),
316 'coverage' => array('text',$this->getCoverage()),
317 'coverage_language' => array('text',$this->getCoverageLanguageCode()));
318 }
319
320 public function read()
321 {
322 global $ilDB;
323
324 include_once 'Services/MetaData/classes/class.ilMDLanguageItem.php';
325
326 if ($this->getMetaId()) {
327 $query = "SELECT * FROM il_meta_general " .
328 "WHERE meta_general_id = " . $ilDB->quote($this->getMetaId(), 'integer');
329
330 $res = $this->db->query($query);
331 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
332 $this->setRBACId($row->rbac_id);
333 $this->setObjId($row->obj_id);
334 $this->setObjType($row->obj_type);
335 $this->setStructure($row->general_structure);
336 $this->setTitle($row->title);
337 $this->setTitleLanguage(new ilMDLanguageItem($row->title_language));
338 $this->setCoverage($row->coverage);
339 $this->setCoverageLanguage(new ilMDLanguageItem($row->coverage_language));
340 }
341 }
342 return true;
343 }
344
345 /*
346 * XML Export of all meta data
347 * @param object (xml writer) see class.ilMD2XML.php
348 *
349 */
350 public function toXML(&$writer)
351 {
352 $writer->xmlStartTag('General', array('Structure' => $this->getStructure() ?
353 $this->getStructure() :
354 'Atomic'));
355
356
357 // Identifier
358 $first = true;
359 $identifiers = array();
360 $identifiers = $this->getIdentifierIds();
361 foreach ($identifiers as $id) {
362 $ide =&$this->getIdentifier($id);
363 $ide->setExportMode($this->getExportMode());
364 $ide->toXML($writer);
365 $first = false;
366 }
367 if (!count($identifiers)) {
368 include_once 'Services/MetaData/classes/class.ilMDIdentifier.php';
369 $ide = new ilMDIdentifier(
370 $this->getRBACId(),
371 $this->getObjId(),
372 $this->getObjType()
373 ); // added type, alex, 31 Oct 2007
374 $ide->setExportMode(true);
375 $ide->toXML($writer, true);
376 }
377
378 // Title
379 $writer->xmlElement(
380 'Title',
381 array('Language' => $this->getTitleLanguageCode() ?
382 $this->getTitleLanguageCode() :
383 'en'),
384 $this->getTitle()
385 );
386
387 // Language
388 $languages = $this->getLanguageIds();
389 foreach ($languages as $id) {
390 $lan =&$this->getLanguage($id);
391 $lan->toXML($writer);
392 }
393 if (!count($languages)) {
394 // Default
395 include_once 'Services/MetaData/classes/class.ilMDLanguage.php';
396 $lan = new ilMDLanguage($this->getRBACId(), $this->getObjId());
397 $lan->toXML($writer);
398 }
399
400 // Description
401 $descriptions = $this->getDescriptionIds();
402 foreach ($descriptions as $id) {
403 $des =&$this->getDescription($id);
404 $des->toXML($writer);
405 }
406 if (!count($descriptions)) {
407 // Default
408 include_once 'Services/MetaData/classes/class.ilMDDescription.php';
409 $des = new ilMDDescription($this->getRBACId(), $this->getObjId());
410 $des->toXML($writer);
411 }
412
413
414 // Keyword
415 $keywords = $this->getKeywordIds();
416 foreach ($keywords as $id) {
417 $key =&$this->getKeyword($id);
418 $key->toXML($writer);
419 }
420 if (!count($keywords)) {
421 // Default
422 include_once 'Services/MetaData/classes/class.ilMDKeyword.php';
423 $key = new ilMDKeyword($this->getRBACId(), $this->getObjId());
424 $key->toXML($writer);
425 }
426
427 // Copverage
428 if (strlen($this->getCoverage())) {
429 $writer->xmlElement(
430 'Coverage',
431 array('Language' => $this->getCoverageLanguageCode() ?
432 $this->getCoverageLanguageCode() :
433 'en'),
434 $this->getCoverage()
435 );
436 }
437 $writer->xmlEndTag('General');
438 }
439
440
441
442 // STATIC
443 public static function _getId($a_rbac_id, $a_obj_id)
444 {
445 global $ilDB;
446
447 $query = "SELECT meta_general_id FROM il_meta_general " .
448 "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
449 "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
450
451
452 $res = $ilDB->query($query);
453 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
454 return $row->meta_general_id;
455 }
456 return false;
457 }
458}
An exception for terminatinating execution or to throw for unit testing.
setObjId($a_id)
setMetaId($a_meta_id, $a_read_data=true)
setObjType($a_type)
setRBACId($a_id)
static _getIds($a_rbac_id, $a_obj_id, $a_parent_id, $a_parent_type)
& getDescription($a_description_id)
setStructure($a_structure)
setCoverage($a_coverage)
static _getId($a_rbac_id, $a_obj_id)
& getIdentifier($a_identifier_id)
& getKeyword($a_keyword_id)
setTitle($a_title)
setCoverageLanguage(&$lng_obj)
& getLanguage($a_language_id)
setTitleLanguage(&$lng_obj)
static _getIds($a_rbac_id, $a_obj_id, $a_parent_id, $a_parent_type)
static _getIds($a_rbac_id, $a_obj_id, $a_parent_id, $a_parent_type)
static _getIds($a_rbac_id, $a_obj_id, $a_parent_id, $a_parent_type)
$key
Definition: croninfo.php:18
if(!array_key_exists('StateId', $_REQUEST)) $id
$query
foreach($_POST as $key=> $value) $res
global $ilDB