ilBibliographicExporter 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 ilBibliographicExporter:

Collaboration diagram for ilBibliographicExporter:

Public Member Functions
	init ()
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. 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)

Protected Attributes
ilBibliographicDataSet	$ds = null
	$db
Protected Attributes inherited from ilXmlExporter
ilExport	$exp

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="")

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 Bibliographic class

Author

Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

Id

\

Definition at line 28 of file class.ilBibliographicExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilBibliographicExporter::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.ilBibliographicExporter.php.

                                                            : array
    {
        return ['4.5.0' => ['namespace' => 'http://www.ilias.de/Modules/DataCollection/dcl/4_5', 'xsd_file" => "ilias_dcl_4_5.xsd', 'uses_dataset' => true, 'min' => '4.5.0', 'max' => '']];
    }

getXmlExportTailDependencies()

ilBibliographicExporter::getXmlExportTailDependencies	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get tail dependencies.

Returns

array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

Definition at line 63 of file class.ilBibliographicExporter.php.

     : array {
        $res = [];
        if ($a_entity === "bibl") {
            $res[] = [
                "component" => "components/ILIAS/ILIASObject",
                "entity" => "common",
                "ids" => $a_ids
            ];
        }
        return $res;
    }

References $res.

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

Definition at line 53 of file class.ilBibliographicExporter.php.

                                                                                                  : string
    {
        ilFileUtils::makeDirParents($this->getAbsoluteExportDirectory());
        $this->ds->initByExporter($this);
        $this->ds->exportLibraryFile($a_id, $this->getAbsoluteExportDirectory());
 
        return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], '', true, true);
    }

References ilXmlExporter\getAbsoluteExportDirectory(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

init()

ilBibliographicExporter::init

(

)

Reimplemented from ilXmlExporter.

Definition at line 37 of file class.ilBibliographicExporter.php.

                          : void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $this->ds = new ilBibliographicDataSet();
        $this->ds->setDSPrefix('ds');
        $this->db = $ilDB;
    }

References $DIC, and $ilDB.

Field Documentation

$db

ilBibliographicExporter::$db

protected

Definition at line 34 of file class.ilBibliographicExporter.php.

$ds

ilBibliographicDataSet ilBibliographicExporter::$ds = null

protected

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

---

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

• components/ILIAS/Bibliographic/classes/class.ilBibliographicExporter.php