ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilWebResourceExporter Class Reference

Booking definition. More...

+ Inheritance diagram for ilWebResourceExporter:
+ Collaboration diagram for ilWebResourceExporter:

Public Member Functions

 __construct ()
 Constructor. More...
 
 init ()
 Init export. More...
 
 getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
 Get xml. More...
 
 getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
 Get tail dependencies. More...
 
 getValidSchemaVersions ($a_entity)
 Returns schema versions that the component can export to. More...
 
- Public Member Functions inherited from ilXmlExporter
 __construct ()
 Constructor. More...
 
 setExport (ilExport $a_exp)
 Set export object. More...
 
 getExport ()
 Get export. More...
 
 getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
 Get xml representation. More...
 
 init ()
 
 setExportDirectories ($a_dir_relative, $a_dir_absolute)
 Export directories. More...
 
 getRelativeExportDirectory ()
 Get relative export directory. More...
 
 getAbsoluteExportDirectory ()
 Get absolute export directory. More...
 
 getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
 Get head dependencies. More...
 
 getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
 Get tail dependencies. More...
 
 getValidSchemaVersions ($a_entity)
 Returns schema versions that the component can export to. More...
 
 determineSchemaVersion ($a_entity, $a_target_release)
 Determine schema version. More...
 

Private Attributes

 $writer = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilXmlExporter
static lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
 export directory lookup More...
 
- Protected Attributes inherited from ilXmlExporter
 $dir_relative
 
 $dir_absolute
 
 $exp
 

Detailed Description

Booking definition.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 17 of file class.ilWebResourceExporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebResourceExporter::__construct ( )

Constructor.

Definition at line 24 of file class.ilWebResourceExporter.php.

25  {
26  }

Member Function Documentation

◆ getValidSchemaVersions()

ilWebResourceExporter::getValidSchemaVersions (   $a_entity)

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top.

Returns

Definition at line 85 of file class.ilWebResourceExporter.php.

86  {
87  return array(
88  "4.1.0" => array(
89  "namespace" => "http://www.ilias.de/Modules/WebResource/webr/4_1",
90  "xsd_file" => "ilias_webr_4_1.xsd",
91  "uses_dataset" => false,
92  "min" => "4.1.0",
93  "max" => "")
94  );
95  }

◆ getXmlExportTailDependencies()

ilWebResourceExporter::getXmlExportTailDependencies (   $a_entity,
  $a_target_release,
  $a_ids 
)

Get tail dependencies.

Parameters
stringentity
stringtarget release
arrayids
Returns
array array of array with keys "component", entity", "ids"

Definition at line 64 of file class.ilWebResourceExporter.php.

65  {
66  $deps = [];
67 
68  // service settings
69  $deps[] = [
70  "component" => "Services/Object",
71  "entity" => "common",
72  "ids" => $a_ids
73  ];
74 
75  return $deps;
76  }

◆ getXmlRepresentation()

ilWebResourceExporter::getXmlRepresentation (   $a_entity,
  $a_schema_version,
  $a_id 
)

Get xml.

Parameters
object$a_entity
object$a_schema_version
object$a_id
Returns

Definition at line 43 of file class.ilWebResourceExporter.php.

References $GLOBALS.

44  {
45  try {
46  $this->writer = new ilWebLinkXmlWriter(false);
47  $this->writer->setObjId($a_id);
48  $this->writer->write();
49  return $this->writer->xmlDumpMem(false);
50  } catch (UnexpectedValueException $e) {
51  $GLOBALS['DIC']->logger()->webr()->warning("Caught error: " . $e->getMessage());
52  return '';
53  }
54  }
XML writer for weblinks.
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.

◆ init()

ilWebResourceExporter::init ( )

Init export.

Returns

Definition at line 32 of file class.ilWebResourceExporter.php.

33  {
34  }

Field Documentation

◆ $writer

ilWebResourceExporter::$writer = null
private

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


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