ilObjBibliographic Class Reference

Class ilObjBibliographic. More...

Inheritance diagram for ilObjBibliographic:

Collaboration diagram for ilObjBibliographic:

Public Member Functions
	__construct (int $existant_bibl_id=0)
	If bibliographic object exists, read it's data from database, otherwise create it. More...
	getFileDirectory ()
	getFilePath (bool $without_filename=false)
	setFilename (string $filename)
	getFilename ()
	getFileAbsolutePath ()
	getLegacyAbsolutePath ()
	getFileTypeAsString ()
	getFileType ()
	cloneStructure (int $original_id)
	Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id)) More...
	parseFileToDatabase ()
	Reads out the source file and writes all entries to the database. More...
	setFileType (int $file_type)
	setResourceId (ResourceIdentification $identification)
	getResourceId ()
	getStorageId ()
	isMigrated ()
	setMigrated (bool $migrated)
	determineFileTypeByFileName (string $filename)
Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...
	read ()
	create (bool $a_clone_mode=false)
	update ()
	delete ()
	cloneMetaData (ilObject $target_obj)
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Protected Member Functions
	initType ()
	doCreate (bool $clone_mode=false)
	Create object. More...
	doUpdate ()
	doDelete (bool $leave_out_il_bibl_data=false, bool $leave_out_delete_file=false)
	deleteFile ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate (bool $clone_mode=false)
	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...
	doUpdate ()
	beforeUpdate ()
	doDelete ()
	beforeDelete ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
	beforeCloneObject ()
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
Filesystem	$filesystem
FileUpload	$upload_service
ilBiblFileReaderFactory	$bib_filereader_factory
ilBiblTypeFactory	$bib_type_factory
ilBiblEntryFactory	$bib_entry_factory
ilBiblFieldFactory	$bib_field_factory
ilBiblDataFactoryInterface	$bib_data_factory
ilBiblOverviewModelFactory	$bib_overview_factory
ilBiblAttributeFactory	$bib_attribute_factory
Services	$storage
ilObjBibliographicStakeholder	$stakeholder
string	$filename = null
array	$entries = []
int	$file_type = 0
ResourceIdentification	$resource_id = null
bool	$is_migrated = false
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Member Functions
	handleUpload ()
	handles a FileUpload and returns an IRSS identification string. More...
	copyFile (string $file_to_copy)

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Detailed Description

Class ilObjBibliographic.

Author

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch, Gabriel Comte gc@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Version

Id

class.ilObjBibliographic.php 2012-01-11 10:37:11Z otruffer

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

Constructor & Destructor Documentation

__construct()

ilObjBibliographic::__construct

(

int

$existant_bibl_id = 0

)

If bibliographic object exists, read it's data from database, otherwise create it.

Parameters

int

$existant_bibl_id

is not set when object is getting created

Definition at line 62 of file class.ilObjBibliographic.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilObject2\doRead(), ILIAS\Repository\filesystem(), and ilObject\setId().

    {
        global $DIC;

        $this->storage = $DIC->resourceStorage();
        $this->upload_service = $DIC->upload();
        $this->stakeholder = new ilObjBibliographicStakeholder();
        $this->filesystem = $DIC->filesystem()->storage();

        if ($existant_bibl_id !== 0) {
            $this->setId($existant_bibl_id);
            $this->doRead();
        }
        parent::__construct($existant_bibl_id, false);

        $this->bib_type_factory = new ilBiblTypeFactory();
        $this->bib_field_factory = new ilBiblFieldFactory($this->bib_type_factory->getInstanceForType($this->getFileType()));
        $this->bib_overview_factory = new ilBiblOverviewModelFactory();
        $this->bib_entry_factory = new ilBiblEntryFactory(
            $this->bib_field_factory,
            $this->bib_type_factory->getInstanceForType($this->getFileType()),
            $this->bib_overview_factory
        );
        $this->bib_filereader_factory = new ilBiblFileReaderFactory();
        $this->bib_attribute_factory = new ilBiblAttributeFactory($this->bib_field_factory);
    }

Here is the call graph for this function:

Member Function Documentation

cloneStructure()

ilObjBibliographic::cloneStructure

(

int

$original_id

)

Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id))

Parameters

int

$original_id

The original ID of the dataselection you want to clone it's structure

Definition at line 332 of file class.ilObjBibliographic.php.

References copyFile(), doUpdate(), ilObject\getId(), parseFileToDatabase(), ilObject\setDescription(), setFilename(), setMigrated(), setResourceId(), ilObject\setTitle(), and ilObject\setType().

                                                    : void
    {
        $original = new ilObjBibliographic($original_id);
        $this->setFilename($original->getFilename());
        $this->setDescription($original->getDescription());
        $this->setTitle($original->getTitle());
        $this->setType($original->getType());
        $identification = $original->getResourceId();
        if ($identification instanceof ResourceIdentification) {
            $new_identification = $this->storage->manage()->clone($identification);
            $this->setResourceId($new_identification);
        } else {
            $this->copyFile($original->getFileAbsolutePath());
        }
        $this->parseFileToDatabase();
        $this->setMigrated($original->isMigrated());
        $this->doUpdate();

        // copy filters

        $filters = new ilBiblFieldFilterFactory();
        foreach ($filters->getAllForObjectId($original_id) as $filter) {
            $cloned_filter = clone $filter;
            $cloned_filter->setId(0);
            $cloned_filter->setObjectId($this->getId());
            $cloned_filter->create();
        }
    }

Here is the call graph for this function:

copyFile()

ilObjBibliographic::copyFile ( string  $file_to_copy )

private

Deprecated:

Definition at line 226 of file class.ilObjBibliographic.php.

References ILIAS\Repository\filesystem(), and getFileDirectory().

Referenced by cloneStructure().

                                                   : void
    {
        $target = $this->getFileDirectory() . '/' . basename($file_to_copy);
        $this->filesystem->copy($file_to_copy, $target);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteFile()

ilObjBibliographic::deleteFile ( )

protected

Definition at line 232 of file class.ilObjBibliographic.php.

References $path, ILIAS\Repository\filesystem(), and getFileDirectory().

Referenced by doDelete(), and doUpdate().

                                   : bool
    {
        $path = $this->getFileDirectory();
        try {
            $this->filesystem->deleteDir($path);
        } catch (IOException) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

determineFileTypeByFileName()

ilObjBibliographic::determineFileTypeByFileName

(

string

$filename

)

Definition at line 417 of file class.ilObjBibliographic.php.

Referenced by doCreate().

                                                                 : int
    {
        return $this->bib_type_factory->getInstanceForFileName($filename)->getId();
    }

Here is the caller graph for this function:

doCloneObject()

ilObjBibliographic::doCloneObject ( ilObject2  $new_obj, int  $a_target_id, ?int  $a_copy_id = null  )

protected

Definition at line 312 of file class.ilObjBibliographic.php.

References ilCopyWizardOptions\_getInstance(), ilObject\getId(), and ilObject\getObjectProperties().

                                                                                                  : void
    {
        assert($new_obj instanceof ilObjBibliographic);
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->getObjectProperties()->storePropertyIsOnline(new Online(false));
        }

        $new_obj->cloneStructure($this->getId());
        $new_obj->parseFileToDatabase();
    }

Here is the call graph for this function:

doCreate()

ilObjBibliographic::doCreate ( bool  $clone_mode = false )

protected

Create object.

Parameters

bool

$clone_mode

Definition at line 120 of file class.ilObjBibliographic.php.

References $id, determineFileTypeByFileName(), ilObject2\doRead(), getFilename(), ilObject\getId(), ilObject\getObjectProperties(), getResourceId(), handleUpload(), null, parseFileToDatabase(), setFilename(), setFileType(), setMigrated(), setResourceId(), and ActiveRecord\where().

                                                         : void
    {
        if ($this->upload_service->hasUploads()) {
            if (!$this->upload_service->hasBeenProcessed()) {
                $this->upload_service->process();
            }
            $this->setResourceId($this->handleUpload());
        }

        $this->db->insert(
            "il_bibl_data",
            [
                "id" => ["integer", $this->getId()],
                "filename" => ["text", $this->getFilename()],
                "file_type" => ["integer",
                                $this->getFilename() ? $this->determineFileTypeByFileName($this->getFilename()) : ""
                ],
                "rid" => ["string", (($rid = $this->getResourceId()) !== null) ? $rid->serialize() : ''],
            ]
        );
        $this->parseFileToDatabase();
        $this->getObjectProperties()->storePropertyIsOnline(new Online(false));
    }

Here is the call graph for this function:

doDelete()

ilObjBibliographic::doDelete ( bool  $leave_out_il_bibl_data = false, bool  $leave_out_delete_file = false  )

protected

Definition at line 189 of file class.ilObjBibliographic.php.

References ilHistory\_removeEntriesForObject(), deleteFile(), and ilObject\getId().

                                                                                                          : void
    {
        if (!$leave_out_delete_file) {
            $this->deleteFile();
        }
        //il_bibl_attribute
        $this->db->manipulate(
            "DELETE FROM il_bibl_attribute WHERE il_bibl_attribute.entry_id IN "
            . "(SELECT il_bibl_entry.id FROM il_bibl_entry WHERE il_bibl_entry.data_id = " . $this->db->quote(
                $this->getId(),
                "integer"
            ) . ")"
        );
        //il_bibl_entry
        $this->bib_entry_factory->deleteEntryById($this->getId());

        if (!$leave_out_il_bibl_data) {
            //il_bibl_data
            $this->db->manipulate(
                "DELETE FROM il_bibl_data WHERE id = " . $this->db->quote($this->getId(), "integer")
            );
        }
        // delete history entries
        ilHistory::_removeEntriesForObject($this->getId());
    }

Here is the call graph for this function:

doUpdate()

ilObjBibliographic::doUpdate ( )

protected

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

References deleteFile(), ilObject2\doDelete(), getFilename(), getFileType(), ilObject\getId(), getResourceId(), handleUpload(), isMigrated(), null, parseFileToDatabase(), setMigrated(), and setResourceId().

Referenced by cloneStructure().

                                 : void
    {
        $has_valid_upload = $this->upload_service->hasUploads() && !$this->upload_service->hasBeenProcessed();

        if ($has_valid_upload) {
            $identification = $this->handleUpload();
            if ($identification instanceof ResourceIdentification) {
                $this->setResourceId($identification);
                if (!$this->isMigrated()) {
                    $this->deleteFile();
                    $this->setMigrated(true);
                }
            }
        }
        if ($has_valid_upload) {
            // Delete the object, but leave the db table 'il_bibl_data' for being able to update it using WHERE, and also leave the file
            $this->doDelete(true, true);
            $this->parseFileToDatabase();
        }

        $this->db->update(
            "il_bibl_data",
            [
                "filename" => ["text", $this->getFilename()],
                "file_type" => ["integer", $this->getFileType()],
                "rid" => ["string", (($rid = $this->getResourceId()) !== null) ? $rid->serialize() : ''],
            ],
            ["id" => ["integer", $this->getId()]]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileAbsolutePath()

ilObjBibliographic::getFileAbsolutePath

(

)

Returns

string returns the absolute filepath of the bib/ris file. it's build as follows: /bibl/$id/$filename

Definition at line 277 of file class.ilObjBibliographic.php.

References getFileDirectory(), and getFilename().

Referenced by getLegacyAbsolutePath().

                                         : string
    {
        return $this->getFileDirectory() . DIRECTORY_SEPARATOR . $this->getFilename();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileDirectory()

ilObjBibliographic::getFileDirectory

(

)

Deprecated:

Definition at line 218 of file class.ilObjBibliographic.php.

Referenced by copyFile(), deleteFile(), and getFileAbsolutePath().

                                      : string
    {
        return "{$this->getType()}/{$this->getId()}";
    }

Here is the caller graph for this function:

getFilename()

ilObjBibliographic::getFilename

(

)

Definition at line 262 of file class.ilObjBibliographic.php.

References $filename, getResourceId(), and null.

Referenced by doCreate(), doUpdate(), getFileAbsolutePath(), getFilePath(), and getFileType().

                                 : ?string
    {
        if ($this->getResourceId() !== null) {
            return $this->filename = $this->storage->manage()
                                 ->getCurrentRevision($this->getResourceId())
                                 ->getInformation()
                                 ->getTitle();
        }
        return $this->filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilePath()

ilObjBibliographic::getFilePath

(

bool

$without_filename = false

)

Returns

string|void

Definition at line 247 of file class.ilObjBibliographic.php.

References getFilename().

                                                               : ?string
    {
        $file_name = $this->getFilename();

        if ($without_filename) {
            return substr((string) $file_name, 0, strrpos((string) $file_name, DIRECTORY_SEPARATOR));
        }
        return $file_name;
    }

Here is the call graph for this function:

getFileType()

ilObjBibliographic::getFileType

(

)

Definition at line 301 of file class.ilObjBibliographic.php.

References ilBiblTypeFactoryInterface\DATA_TYPE_BIBTEX, getFilename(), and null.

Referenced by ilBiblFactoryFacade\__construct(), doUpdate(), getFileTypeAsString(), and parseFileToDatabase().

                                 : int
    {
        $filename = $this->getFilename();
        if ($filename === null) {
            return ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX;
        }
        $instance = $this->bib_type_factory->getInstanceForFileName($filename);

        return $instance->getId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileTypeAsString()

ilObjBibliographic::getFileTypeAsString

(

)

Deprecated:

use type factory instead of string representation

Definition at line 294 of file class.ilObjBibliographic.php.

References ilObject\$type, and getFileType().

                                         : string
    {
        $type = $this->getFileType();

        return $this->bib_type_factory->getInstanceForType($type)->getStringRepresentation();
    }

Here is the call graph for this function:

getLegacyAbsolutePath()

ilObjBibliographic::getLegacyAbsolutePath

(

)

Definition at line 282 of file class.ilObjBibliographic.php.

References ILIAS\Repository\filesystem(), getFileAbsolutePath(), getResourceId(), and isMigrated().

    {
        $stream = ($this->isMigrated()) ?
            $this->storage->consume()->stream($this->getResourceId())->getStream() :
            $this->filesystem->readStream($this->getFileAbsolutePath());

        return $stream->getMetadata('uri');
    }

Here is the call graph for this function:

getResourceId()

ilObjBibliographic::getResourceId

(

)

Returns

ResourceIdentification

Definition at line 394 of file class.ilObjBibliographic.php.

References $resource_id.

Referenced by doCreate(), doUpdate(), getFilename(), getLegacyAbsolutePath(), getStorageId(), handleUpload(), and parseFileToDatabase().

                                   : ?ResourceIdentification
    {
        return $this->resource_id;
    }

Here is the caller graph for this function:

getStorageId()

ilObjBibliographic::getStorageId

(

)

Definition at line 399 of file class.ilObjBibliographic.php.

References getResourceId().

                                  : string
    {
        if (!$this->getResourceId() instanceof ResourceIdentification) {
            return '-';
        }
        return $this->storage->manage()->getResource($this->getResourceId())->getStorageID();
    }

Here is the call graph for this function:

handleUpload()

ilObjBibliographic::handleUpload ( )

private

handles a FileUpload and returns an IRSS identification string.

Exceptions

IllegalStateException

Definition at line 93 of file class.ilObjBibliographic.php.

References getResourceId(), and null.

Referenced by doCreate(), and doUpdate().

                                   : ?ResourceIdentification
    {
        if (!$this->upload_service->hasBeenProcessed()) {
            $this->upload_service->process();
        }
        $array_result = $this->upload_service->getResults();
        $result = reset($array_result); // FileUpload is the first element
        if (!$result->isOK()) {
            return null;
        }

        if ($this->getResourceId() !== null) {
            $this->storage->manage()->appendNewRevision(
                $this->getResourceId(),
                $result,
                $this->stakeholder
            );
            return $this->getResourceId();
        }

        return $this->storage->manage()->upload($result, $this->stakeholder);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initType()

ilObjBibliographic::initType ( )

protected

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

                                 : void
    {
        $this->type = "bibl";
    }

isMigrated()

ilObjBibliographic::isMigrated

(

)

Definition at line 407 of file class.ilObjBibliographic.php.

References $is_migrated.

Referenced by doUpdate(), and getLegacyAbsolutePath().

                                : bool
    {
        return $this->is_migrated;
    }

Here is the caller graph for this function:

parseFileToDatabase()

ilObjBibliographic::parseFileToDatabase

(

)

Reads out the source file and writes all entries to the database.

Definition at line 364 of file class.ilObjBibliographic.php.

References ilObject\$type, getFileType(), getResourceId(), and null.

Referenced by cloneStructure(), doCreate(), and doUpdate().

                                         : void
    {
        //Read File
        if ($this->getResourceId() === null) {
            return;
        }
        $type = $this->getFileType();
        $reader = $this->bib_filereader_factory->getByType(
            $type,
            $this->bib_entry_factory,
            $this->bib_field_factory,
            $this->bib_attribute_factory
        );
        $reader->readContent($this->getResourceId());
        $this->entries = $reader->parseContentToEntries($this);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFilename()

ilObjBibliographic::setFilename

(

string

$filename

)

Definition at line 257 of file class.ilObjBibliographic.php.

References $filename.

Referenced by cloneStructure(), and doCreate().

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

Here is the caller graph for this function:

setFileType()

ilObjBibliographic::setFileType

(

int

$file_type

)

Definition at line 381 of file class.ilObjBibliographic.php.

References $file_type.

Referenced by doCreate().

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

Here is the caller graph for this function:

setMigrated()

ilObjBibliographic::setMigrated

(

bool

$migrated

)

Definition at line 412 of file class.ilObjBibliographic.php.

Referenced by cloneStructure(), doCreate(), and doUpdate().

                                               : void
    {
        $this->is_migrated = $migrated;
    }

Here is the caller graph for this function:

setResourceId()

ilObjBibliographic::setResourceId

(

ResourceIdentification

$identification

)

Definition at line 386 of file class.ilObjBibliographic.php.

Referenced by cloneStructure(), doCreate(), and doUpdate().

                                                                         : void
    {
        $this->resource_id = $identification;
    }

Here is the caller graph for this function:

Field Documentation

$bib_attribute_factory

ilBiblAttributeFactory ilObjBibliographic::$bib_attribute_factory

protected

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

$bib_data_factory

ilBiblDataFactoryInterface ilObjBibliographic::$bib_data_factory

protected

Definition at line 42 of file class.ilObjBibliographic.php.

$bib_entry_factory

ilBiblEntryFactory ilObjBibliographic::$bib_entry_factory

protected

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

$bib_field_factory

ilBiblFieldFactory ilObjBibliographic::$bib_field_factory

protected

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

$bib_filereader_factory

ilBiblFileReaderFactory ilObjBibliographic::$bib_filereader_factory

protected

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

$bib_overview_factory

ilBiblOverviewModelFactory ilObjBibliographic::$bib_overview_factory

protected

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

$bib_type_factory

ilBiblTypeFactory ilObjBibliographic::$bib_type_factory

protected

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

$entries

array ilObjBibliographic::$entries = []

protected

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

$file_type

int ilObjBibliographic::$file_type = 0

protected

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

Referenced by setFileType().

$filename

string ilObjBibliographic::$filename = null

protected

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

Referenced by getFilename(), and setFilename().

$filesystem

Filesystem ilObjBibliographic::$filesystem

protected

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

$is_migrated

bool ilObjBibliographic::$is_migrated = false

protected

Definition at line 51 of file class.ilObjBibliographic.php.

Referenced by isMigrated().

$resource_id

ResourceIdentification ilObjBibliographic::$resource_id = null

protected

Definition at line 50 of file class.ilObjBibliographic.php.

Referenced by getResourceId().

$stakeholder

ilObjBibliographicStakeholder ilObjBibliographic::$stakeholder

protected

Definition at line 46 of file class.ilObjBibliographic.php.

$storage

Services ilObjBibliographic::$storage

protected

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

$upload_service

FileUpload ilObjBibliographic::$upload_service

protected

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

---

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

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