Bibliographic dataset class. More...

Inheritance diagram for ilBibliographicDataSet:

Collaboration diagram for ilBibliographicDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

	getXmlNamespace (string $a_entity, string $a_schema_version)

	readData (string $a_entity, string $a_version, array $a_ids)

	exportLibraryFile (int $a_id, string $absolute_export_dir)

	importLibraryFile (\ilImportMapping $a_mapping)

Public Member Functions inherited from ilDataSet
	__construct ()

	init (string $a_entity, string $a_schema_version)
	Init. More...

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	initByExporter (ilXmlExporter $xml_exporter)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...

	addRecordsXml (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...

	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getTypes (string $a_entity, string $a_version)
	Map XML attributes of entities to datatypes (text, integer...) More...

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Return dependencies form entities to other entities (in our case these are all the DB relations) More...

	_readData (string $a_entity, array $a_ids)
	Build data array, data is read from cache except bibl object itself. More...

Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getExportDirInContainer (string $exp_dir)

	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...

	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...

	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
	$storage

ilObjBibliographicStakeholder	$stakeholder

	$import_bib_object

	$user

array	$import_temp_refs = []

array	$import_temp_refs_props = []

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$component_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

ilExport	$export

Private Attributes
const	EXP_DIRECTORY = "/Modules/Bibliographic/set_1/expDir_1/"

const	EXP_DIRECTORY_NEW = "/components/ILIAS/Bibliographic/set_1/expDir_1/"

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

int	$dircnt = 0

Detailed Description

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

Definition at line 27 of file class.ilBibliographicDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilBibliographicDataSet::__construct ( )

Definition at line 48 of file class.ilBibliographicDataSet.php.

References $DIC, $ilDB, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilUser = $DIC['ilUser'];
         $IRSS = $DIC['resource_storage'];
         parent::__construct();
         $this->db = $ilDB;
         $this->user = $ilUser;
         $this->storage = $IRSS;
         $this->stakeholder = new ilObjBibliographicStakeholder();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _readData()

ilBibliographicDataSet::_readData	(	string	$a_entity,
		array	$a_ids
	)

protected

Build data array, data is read from cache except bibl object itself.

Definition at line 147 of file class.ilBibliographicDataSet.php.

References ilDataSet\$data, and ilObject\_lookupType().

Referenced by readData().

                                                                 : void
     {
         switch ($a_entity) {
             case 'bibl':
                 foreach ($a_ids as $bibl_id) {
                     if (ilObject::_lookupType($bibl_id) === 'bibl') {
                         $obj = new ilObjBibliographic($bibl_id);
                         $data = ['id' => $bibl_id, 'title' => $obj->getTitle(), 'description' => $obj->getDescription(), 'fileName' => $obj->getFilename()];
                         $this->data[] = $data;
                     }
                 }
                 break;
             default:
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportLibraryFile()

ilBibliographicDataSet::exportLibraryFile	(	int	$a_id,
		string	$absolute_export_dir
	)

Definition at line 164 of file class.ilBibliographicDataSet.php.

References ilFileUtils\makeDirParents().

                                                                              : void
     {
         $obj = new ilObjBibliographic($a_id);
         if (($rid = $obj->getResourceId()) === null) {
             return;
         }
         $fileAbsolutePath = $this->irss->consume()->stream($rid)->getStream()->getMetadata()['uri'] ?? null;
         ilFileUtils::makeDirParents($absolute_export_dir . self::EXP_DIRECTORY_NEW);
         copy($fileAbsolutePath, $absolute_export_dir . self::EXP_DIRECTORY_NEW . $obj->getFilename());
     }

Here is the call graph for this function:

◆ getDependencies()

ilBibliographicDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Return dependencies form entities to other entities (in our case these are all the DB relations)

Definition at line 124 of file class.ilBibliographicDataSet.php.

      : array {
         return [];
     }

◆ getSupportedVersions()

ilBibliographicDataSet::getSupportedVersions ( )

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

                                           : array
     {
         return ['4.5.0'];
     }

◆ getTypes()

ilBibliographicDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

Map XML attributes of entities to datatypes (text, integer...)

Definition at line 111 of file class.ilBibliographicDataSet.php.

                                                                     : array
     {
         return match ($a_entity) {
             'bibl' => ["id" => "integer", "title" => "text", "description" => "text", "filename" => "text"],
             default => [],
         };
     }

◆ getXmlNamespace()

ilBibliographicDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

Definition at line 69 of file class.ilBibliographicDataSet.php.

References ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), importLibraryFile(), and ilDataSet\importRecord().

                                                                                : string
     {
         return 'http://www.ilias.de/xml/Modules/Bibliographic/' . $a_entity;
     }

Here is the call graph for this function:

◆ importLibraryFile()

ilBibliographicDataSet::importLibraryFile ( \ilImportMapping $a_mapping )

Parameters

ilImportMapping $a_mapping (what's it for?)

Definition at line 179 of file class.ilBibliographicDataSet.php.

References $filename, and ilDataSet\getImportDirectory().

Referenced by getXmlNamespace().

                                                                   : void
     {
         $bib_id = $this->import_bib_object->getId();
         $filename = $this->import_bib_object->getFilename();
         $import_path_legacy = $this->getImportDirectory() . self::EXP_DIRECTORY . $filename;
         $import_path_new = $this->getImportDirectory() . self::EXP_DIRECTORY_NEW . $filename;
         if (file_exists($import_path_legacy)) {
             $import_path = $import_path_legacy;
         } elseif (file_exists($import_path_new)) {
             $import_path = $import_path_new;
         } else {
             return;
         }
 
         // create new resource from stream
         $resource = @fopen($import_path, 'rb');
 
         $stream = Streams::ofResource($resource);
         $identification = $this->storage->manage()->stream($stream, $this->stakeholder, $filename);
 
         // insert rid of the new resource into the data table
         $this->db->manipulateF(
             'UPDATE `il_bibl_data` SET `rid` = %s WHERE `id` = %s;',
             ['text', 'integer'],
             [
                 $identification->serialize(),
                 $bib_id,
             ]
         );
         $this->import_bib_object->setResourceId($identification);
         $this->import_bib_object->setMigrated(true);
         $this->import_bib_object->update();
         $this->import_bib_object->parseFileToDatabase();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readData()

ilBibliographicDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

Definition at line 134 of file class.ilBibliographicDataSet.php.

References _readData().

                                                                                : void
     {
         $this->data = [];
         if (!is_array($a_ids)) {
             $a_ids = [$a_ids];
         }
         $this->_readData($a_entity, $a_ids);
     }

Here is the call graph for this function:

Field Documentation

◆ $import_bib_object

ilBibliographicDataSet::$import_bib_object

protected

Definition at line 39 of file class.ilBibliographicDataSet.php.

◆ $import_temp_refs

array ilBibliographicDataSet::$import_temp_refs = []

protected

Definition at line 44 of file class.ilBibliographicDataSet.php.

◆ $import_temp_refs_props

array ilBibliographicDataSet::$import_temp_refs_props = []

protected

Definition at line 45 of file class.ilBibliographicDataSet.php.

◆ $stakeholder

ilObjBibliographicStakeholder ilBibliographicDataSet::$stakeholder

protected

Definition at line 35 of file class.ilBibliographicDataSet.php.

◆ $storage

ilBibliographicDataSet::$storage

protected

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

◆ $user

ilBibliographicDataSet::$user

protected

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

◆ EXP_DIRECTORY

const ilBibliographicDataSet::EXP_DIRECTORY = "/Modules/Bibliographic/set_1/expDir_1/"

private

Definition at line 29 of file class.ilBibliographicDataSet.php.

◆ EXP_DIRECTORY_NEW

const ilBibliographicDataSet::EXP_DIRECTORY_NEW = "/components/ILIAS/Bibliographic/set_1/expDir_1/"

private

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

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

components/ILIAS/Bibliographic/classes/class.ilBibliographicDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _readData()

◆ exportLibraryFile()

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importLibraryFile()

◆ readData()

Field Documentation

◆ $import_bib_object

◆ $import_temp_refs

◆ $import_temp_refs_props

◆ $stakeholder

◆ $storage

◆ $user

◆ EXP_DIRECTORY

◆ EXP_DIRECTORY_NEW