Inheritance diagram for ilBiblFileReaderBase:

Collaboration diagram for ilBiblFileReaderBase:

Public Member Functions
	__construct (ilBiblEntryFactoryInterface $entry_factory, ilBiblFieldFactoryInterface $field_factory, ilBiblAttributeFactoryInterface $attribute_factory)
	ilBiblFileReaderBase constructor. More...

	readContent (ResourceIdentification $identification)

	getFileContent ()

	setFileContent (string $file_content)

	parseContent ()

	parseContentToEntries (ilObjBibliographic $bib)

	getEntryFactory ()

	getFieldFactory ()

	getAttributeFactory ()

Data Fields
const	ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH = 4000

const	ENCODING_UTF_8 = 'UTF-8'

const	ENCODING_ASCII = 'ASCII'

const	ENCODING_ISO_8859_1 = 'ISO-8859-1'

Protected Member Functions
	convertStringToUTF8 (string $string)

Protected Attributes
string	$file_content = ''

string	$path_to_file = ''

ilBiblEntryFactoryInterface	$entry_factory

ilBiblFieldFactoryInterface	$field_factory

ilBiblAttributeFactoryInterface	$attribute_factory

ILIAS ResourceStorage Services	$storage

Private Attributes
ILIAS Refinery Factory	$refinery

Detailed Description

Class ilBiblFileReaderBase.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 25 of file class.ilBiblFileReaderBase.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblFileReaderBase::__construct	(	ilBiblEntryFactoryInterface	$entry_factory,
		ilBiblFieldFactoryInterface	$field_factory,
		ilBiblAttributeFactoryInterface	$attribute_factory
	)

ilBiblFileReaderBase constructor.

Definition at line 49 of file class.ilBiblFileReaderBase.php.

References $attribute_factory, $DIC, $entry_factory, $field_factory, and ILIAS\Repository\refinery().

       {
         global $DIC;
 
         $this->entry_factory = $entry_factory;
         $this->refinery = $DIC->refinery();
         $this->field_factory = $field_factory;
         $this->attribute_factory = $attribute_factory;
         $this->storage = $DIC["resource_storage"];
     }

Here is the call graph for this function:

Member Function Documentation

◆ convertStringToUTF8()

ilBiblFileReaderBase::convertStringToUTF8 ( string $string )

protected

Definition at line 72 of file class.ilBiblFileReaderBase.php.

References ILIAS\Repository\refinery().

                                                           : string
     {
         return $this->refinery->string()
                               ->encoding()
                               ->latin1ToUtf8()
                               ->transform($string);
     }

Here is the call graph for this function:

◆ getAttributeFactory()

ilBiblFileReaderBase::getAttributeFactory ( )

Implements ilBiblFileReaderInterface.

Definition at line 174 of file class.ilBiblFileReaderBase.php.

References $attribute_factory.

Referenced by parseContentToEntries().

                                          : ilBiblAttributeFactoryInterface
     {
         return $this->attribute_factory;
     }

Here is the caller graph for this function:

◆ getEntryFactory()

ilBiblFileReaderBase::getEntryFactory ( )

Implements ilBiblFileReaderInterface.

Definition at line 158 of file class.ilBiblFileReaderBase.php.

References $entry_factory.

Referenced by parseContentToEntries().

                                      : ilBiblEntryFactoryInterface
     {
         return $this->entry_factory;
     }

Here is the caller graph for this function:

◆ getFieldFactory()

ilBiblFileReaderBase::getFieldFactory ( )

Implements ilBiblFileReaderInterface.

Definition at line 166 of file class.ilBiblFileReaderBase.php.

References $field_factory.

                                      : ilBiblFieldFactoryInterface
     {
         return $this->field_factory;
     }

◆ getFileContent()

ilBiblFileReaderBase::getFileContent ( )

Definition at line 80 of file class.ilBiblFileReaderBase.php.

References $file_content.

Referenced by ilBiblTexFileReader\convertBibSpecialChars(), ilBiblTexFileReader\normalizeContent(), and ilBiblTexFileReader\parseContent().

                                     : string
     {
         return $this->file_content;
     }

Here is the caller graph for this function:

◆ parseContent()

ilBiblFileReaderBase::parseContent ( )

abstract

Referenced by parseContentToEntries(), and setFileContent().

Here is the caller graph for this function:

◆ parseContentToEntries()

ilBiblFileReaderBase::parseContentToEntries ( ilObjBibliographic $bib )

Implements ilBiblFileReaderInterface.

Definition at line 95 of file class.ilBiblFileReaderBase.php.

References Vendor\Package\$a, ILIAS\LTI\ToolProvider\$key, getAttributeFactory(), getEntryFactory(), ilObject\getId(), parseContent(), ilStr\strLen(), and ilStr\subStr().

                                                                   : array
     {
         $this->entry_factory->deleteEntriesById($bib->getId());
 
         $entries_from_file = $this->parseContent();
         $entry_instances = [];
         //fill each entry into a ilBibliographicEntry object and then write it to DB by executing doCreate()
 
         foreach ($entries_from_file as $file_entry) {
             $type = null;
             $x = 0;
             $parsed_entry = array();
             foreach ($file_entry as $key => $attribute) {
                 $key = $this->secure($key);
                 if (is_string($attribute)) {
                     $attribute = $this->secure($attribute);
                 }
                 // if the attribute is an array, make a comma separated string out of it
                 if (is_array($attribute)) {
                     $attribute = array_map(function (string $a): string {
                         return $this->secure($a);
                     }, $attribute);
                     $attribute = implode(", ", $attribute);
                 }
                 // reduce the attribute strings to a maximum of 4000 (ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH) characters, in order to fit in the database
                 //if (mb_strlen($attribute, 'UTF-8') > self::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH) {
                 if (ilStr::strLen($attribute) > self::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH) {
                     // $attribute = mb_substr($attribute, 0, self::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH - 3, 'UTF-8') . '...';
                     $attribute = ilStr::subStr($attribute, 0, self::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH - 3) . '...';
                 }
                 // ty (RIS) or entryType (BIB) is the type and is treated seperately
                 if (strtolower($key) === 'ty' || strtolower($key) === 'entrytype') {
                     $type = $attribute;
                     continue;
                 }
                 //TODO - Refactoring for ILIAS 4.5 - get rid off array restructuring
                 //change array structure (name not as the key, but under the key "name")
                 $parsed_entry[$x]['name'] = $key;
                 $parsed_entry[$x]['value'] = $attribute;
                 $x++;
             }
 
             if ($type === null) {
                 continue;
             }
             //create the entry and fill data into database by executing doCreate()
             $entry_factory = $this->getEntryFactory();
             $entry_model = $entry_factory->getEmptyInstance();
             $entry_model->setType($type);
             $entry_model->setDataId($bib->getId());
             $entry_model->store();
             foreach ($parsed_entry as $entry) {
                 $this->getAttributeFactory()->createAttribute($entry['name'], $entry['value'], $entry_model->getId());
             }
             $entry_instances[] = $entry_model;
         }
 
         return $entry_instances;
     }

Here is the call graph for this function:

◆ readContent()

ilBiblFileReaderBase::readContent ( ResourceIdentification $identification )

Implements ilBiblFileReaderInterface.

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

References setFileContent().

                                                                        : bool
     {
         $stream = $this->storage->consume()->stream($identification)->getStream();
         $this->setFileContent($stream->getContents());
 
         return true;
     }

Here is the call graph for this function:

◆ setFileContent()

ilBiblFileReaderBase::setFileContent ( string $file_content )

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

References $file_content, and parseContent().

Referenced by ilBiblTexFileReader\convertBibSpecialChars(), ilBiblTexFileReader\normalizeContent(), and readContent().

                                                         : void
     {
         $this->file_content = $file_content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $attribute_factory

ilBiblAttributeFactoryInterface ilBiblFileReaderBase::$attribute_factory

protected

Definition at line 41 of file class.ilBiblFileReaderBase.php.

Referenced by __construct(), and getAttributeFactory().

◆ $entry_factory

ilBiblEntryFactoryInterface ilBiblFileReaderBase::$entry_factory

protected

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

Referenced by __construct(), and getEntryFactory().

◆ $field_factory

ilBiblFieldFactoryInterface ilBiblFileReaderBase::$field_factory

protected

Definition at line 40 of file class.ilBiblFileReaderBase.php.

Referenced by __construct(), and getFieldFactory().

◆ $file_content

string ilBiblFileReaderBase::$file_content = ''

protected

Definition at line 36 of file class.ilBiblFileReaderBase.php.

Referenced by getFileContent(), and setFileContent().

◆ $path_to_file

string ilBiblFileReaderBase::$path_to_file = ''

protected

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

◆ $refinery

ILIAS Refinery Factory ilBiblFileReaderBase::$refinery

private

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

◆ $storage

ILIAS ResourceStorage Services ilBiblFileReaderBase::$storage

protected

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

◆ ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH

const ilBiblFileReaderBase::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH = 4000

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

◆ ENCODING_ASCII

const ilBiblFileReaderBase::ENCODING_ASCII = 'ASCII'

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

◆ ENCODING_ISO_8859_1

const ilBiblFileReaderBase::ENCODING_ISO_8859_1 = 'ISO-8859-1'

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

◆ ENCODING_UTF_8

const ilBiblFileReaderBase::ENCODING_UTF_8 = 'UTF-8'

Definition at line 33 of file class.ilBiblFileReaderBase.php.

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

Modules/Bibliographic/classes/FileReader/class.ilBiblFileReaderBase.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertStringToUTF8()

◆ getAttributeFactory()

◆ getEntryFactory()

◆ getFieldFactory()

◆ getFileContent()

◆ parseContent()

◆ parseContentToEntries()

◆ readContent()

◆ setFileContent()

Field Documentation

◆ $attribute_factory

◆ $entry_factory

◆ $field_factory

◆ $file_content

◆ $path_to_file

◆ $refinery

◆ $storage

◆ ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH

◆ ENCODING_ASCII

◆ ENCODING_ISO_8859_1

◆ ENCODING_UTF_8