ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilNotesExporter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilNotesExporter:
+ Collaboration diagram for ilNotesExporter:

Public Member Functions

 init ()
 Initialisation. More...
 
 getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
 
 getValidSchemaVersions (string $a_entity)
 Returns schema versions that the component can export to. More...
 
- Public Member Functions inherited from ilXmlExporter
 __construct ()
 
 setExport (ilExport $a_exp)
 
 getExport ()
 
 getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
 
 init ()
 
 setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
 
 getRelativeExportDirectory ()
 
 getAbsoluteExportDirectory ()
 
 getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
 Get head dependencies. More...
 
 getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
 Get tail dependencies. More...
 
 getValidSchemaVersions (string $a_entity)
 Returns schema versions that the component can export to. More...
 
 determineSchemaVersion (string $a_entity, string $a_target_release)
 

Private Attributes

ilNotesDataSet $ds
 

Additional Inherited Members

- Static Public Member Functions inherited from ilXmlExporter
static lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")
 
- Protected Attributes inherited from ilXmlExporter
ilExport $exp
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Exporter class for notes data (xml)

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ getValidSchemaVersions()

ilNotesExporter::getValidSchemaVersions ( string  $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. Example: return array ( "4.1.0" => array( "namespace" => "http://www.ilias.de/Services/MetaData/md/4_1", "xsd_file" => "ilias_md_4_1.xsd", "min" => "4.1.0", "max" => "") );

Reimplemented from ilXmlExporter.

Definition at line 47 of file class.ilNotesExporter.php.

49 : array {
50 return array(
51 "10.0" => array(
52 "namespace" => "https://www.ilias.de/Services/Notes/note/10",
53 "xsd_file" => "ilias_notes_10.xsd",
54 "uses_dataset" => true,
55 "min" => "10.0",
56 "max" => ""),
57 "4.3.0" => array(
58 "namespace" => "https://www.ilias.de/Services/Notes/note/4_3",
59 "xsd_file" => "ilias_usr_4_3.xsd",
60 "uses_dataset" => true,
61 "min" => "4.3.0",
62 "max" => "9.99")
63 );
64 }

◆ getXmlRepresentation()

ilNotesExporter::getXmlRepresentation ( string  $a_entity,
string  $a_schema_version,
string  $a_id 
)

Reimplemented from ilXmlExporter.

Definition at line 38 of file class.ilNotesExporter.php.

42 : string {
43 $this->ds->initByExporter($this);
44 return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], "", true, true);
45 }

◆ init()

ilNotesExporter::init ( )

Initialisation.

Reimplemented from ilXmlExporter.

Definition at line 31 of file class.ilNotesExporter.php.

31 : void
32 {
33 $this->ds = new ilNotesDataSet();
34 $this->ds->initByExporter($this);
35 $this->ds->setDSPrefix("ds");
36 }
Notes Data set class.

Field Documentation

◆ $ds

ilNotesDataSet ilNotesExporter::$ds
private

Definition at line 26 of file class.ilNotesExporter.php.


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