Inheritance diagram for ilObjBibliographic:

Collaboration diagram for ilObjBibliographic:

Public Member Functions
	initType ()
	initType More...

	__construct ($existant_bibl_id=0)
	If bibliographic object exists, read it's data from database, otherwise create it. More...

	doUpdate ()

	getFileDirectory ()

	getFilePath ($without_filename=false)

	setFilename ($filename)

	getFilename ()

	getFileAbsolutePath ()

	getLegacyAbsolutePath ()

	getFileTypeAsString ()

	getFileType ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone BIBL. More...

	cloneStructure ($original_id)
	@description 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 ($file_type)

	setOnline ($a_online)

	getOnline ()

	determineFileTypeByFileName ($filename)

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	Read data from db. More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	create ($a_clone_mode=false)

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Protected Member Functions
	doCreate ()
	Create object. More...

	doRead ()

	doDelete ($leave_out_il_bibl_data=false, $leave_out_delete_file=false)

	deleteFile ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Protected Attributes
	$bib_filereader_factory

	$bib_type_factory

	$bib_entry_factory

	$bib_field_factory

	$bib_data_factory

	$bib_overview_factory

	$bib_attribute_factory

	$filename

	$entries

	$is_online

	$file_type = 0

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Private Member Functions
	copyFile ($file_to_copy)

	getFileSystem ()

Additional Inherited Members
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

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

Version

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjBibliographic::__construct ( $existant_bibl_id = 0 )

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

Parameters

$existant_bibl_id int is not set when object is getting created

Returns: \ilObjBibliographic

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

    {
        if ($existant_bibl_id) {
            $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);
    }

References ILIAS\GlobalScreen\Provider\__construct(), doRead(), and ilObject\setId().

Here is the call graph for this function:

Member Function Documentation

◆ cloneStructure()

ilObjBibliographic::cloneStructure ( $original_id )

@description 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

Returns: void

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

    {
        $original = new ilObjBibliographic($original_id);
        $this->setFilename($original->getFilename());
        $this->copyFile($original->getFileAbsolutePath());
        $this->setDescription($original->getDescription());
        $this->setTitle($original->getTitle());
        $this->setType($original->getType());
        $this->doUpdate();
    }

References copyFile(), doUpdate(), ilObject2\setDescription(), setFilename(), ilObject2\setTitle(), and ilObject2\setType().

Here is the call graph for this function:

◆ copyFile()

ilObjBibliographic::copyFile ( $file_to_copy )

private

Parameters

$file_to_copy

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

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

References getFileDirectory(), and getFileSystem().

Referenced by cloneStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteFile()

ilObjBibliographic::deleteFile ( )

protected

Returns: bool

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

    {
        $path = $this->getFileDirectory();
        try {
            $this->getFileSystem()->deleteDir($path);
        } catch (\ILIAS\Filesystem\Exception\IOException $e) {
            return false;
        }
 
        return true;
    }

References Vendor\Package\$e, getFileDirectory(), and getFileSystem().

Referenced by doDelete(), and doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineFileTypeByFileName()

ilObjBibliographic::determineFileTypeByFileName ( $filename )

Parameters

$filename

Returns: int

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

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

References $filename.

Referenced by doCreate().

Here is the caller graph for this function:

◆ doCloneObject()

ilObjBibliographic::doCloneObject	(	$new_obj,
		$a_target_id,
		$a_copy_id = `null`,
		$a_omit_tree = `false`
	)

Clone BIBL.

Parameters

ilObjBibliographic	$new_obj
	$a_target_id
int	$a_copy_id	copy id

Returns: ilObjPoll

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

    {
        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->setOnline($this->getOnline());
        }
 
        $new_obj->cloneStructure($this->getId());
 
        $new_obj->parseFileToDatabase();
 
        return $new_obj;
    }

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

Here is the call graph for this function:

◆ doCreate()

ilObjBibliographic::doCreate ( )

protected

Create object.

Returns: void

Reimplemented from ilObject2.

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

    {
        global $DIC;
 
        $upload = $DIC->upload();
        if ($upload->hasUploads() && !$upload->hasBeenProcessed()) {
            $upload->process();
            $this->moveUploadedFile($upload);
            $this->parseFileToDatabase();
        }
 
        $DIC->database()->insert(
            "il_bibl_data",
            [
                "id" => ["integer", $this->getId()],
                "filename" => ["text", $this->getFilename()],
                "is_online" => ["integer", $this->getOnline()],
                "file_type" => ["integer", $this->getFilename() ? $this->determineFileTypeByFileName($this->getFilename()) : ""],
            ]
        );
    }

References $DIC, determineFileTypeByFileName(), getFilename(), ilObject\getId(), getOnline(), and parseFileToDatabase().

Here is the call graph for this function:

◆ doDelete()

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

protected

Parameters

bool \| false	$leave_out_il_bibl_data
bool \| false	$leave_out_delete_file

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        if (!$leave_out_delete_file) {
            $this->deleteFile();
        }
        //il_bibl_attribute
        $ilDB->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 = " . $ilDB->quote(
                $this->getId(),
                "integer"
            ) . ")"
        );
        //il_bibl_entry
        $this->bib_entry_factory->deleteEntryById($this->getId());
 
        if (!$leave_out_il_bibl_data) {
            //il_bibl_data
            $ilDB->manipulate(
                "DELETE FROM il_bibl_data WHERE id = " . $ilDB->quote($this->getId(), "integer")
            );
        }
        // delete history entries
        ilHistory::_removeEntriesForObject($this->getId());
    }

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

Here is the call graph for this function:

◆ doRead()

ilObjBibliographic::doRead ( )

protected

Reimplemented from ilObject2.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilBiblData = ilBiblData::where(array('id' => $this->getId()))->first();
        if (!$this->getFilename()) {
            $this->setFilename($ilBiblData->getFilename());
        }
        $this->setFileType($ilBiblData->getFileType());
        $this->setOnline($ilBiblData->getIsOnline());
    }

References $DIC, $ilDB, getFilename(), ilObject\getId(), setFilename(), setFileType(), setOnline(), and ActiveRecord\where().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilObjBibliographic::doUpdate ( )

Reimplemented from ilObject2.

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

    {
        global $DIC;
 
        $upload = $DIC->upload();
        $has_valid_upload = $upload->hasUploads() && !$upload->hasBeenProcessed();
        if ($_POST['override_entries'] && $has_valid_upload) {
            $upload->process();
            $this->deleteFile();
            $this->moveUploadedFile($upload);
        }
        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();
        }
 
        $DIC->database()->update(
            "il_bibl_data",
            [
            "filename" => ["text", $this->getFilename()],
            "is_online" => ["integer", $this->getOnline()],
            "file_type" => ["integer", $this->getFileType()],
        ],
            ["id" => ["integer", $this->getId()]]
        );
    }

References $_POST, $DIC, deleteFile(), ilObject2\doDelete(), getFilename(), getFileType(), ilObject\getId(), getOnline(), and parseFileToDatabase().

Referenced by cloneStructure().

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 308 of file class.ilObjBibliographic.php.

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

References getFileDirectory(), and getFilename().

Referenced by getLegacyAbsolutePath(), and parseFileToDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileDirectory()

ilObjBibliographic::getFileDirectory ( )

Returns: string the folder is: bibl/$id

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

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

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

Here is the caller graph for this function:

◆ getFilename()

ilObjBibliographic::getFilename ( )

Returns: string

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

    {
        return $this->filename;
    }

References $filename.

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

Here is the caller graph for this function:

◆ getFilePath()

ilObjBibliographic::getFilePath ( $without_filename = false )

Parameters

bool $without_filename

Returns: string

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

    {
        $file_name = $this->getFilename();
 
        if ($without_filename) {
            return substr($file_name, 0, strrpos($file_name, DIRECTORY_SEPARATOR));
        } else {
            return $file_name;
        }
    }

References getFilename().

Here is the call graph for this function:

◆ getFileSystem()

ilObjBibliographic::getFileSystem ( )

private

Returns: \ILIAS\Filesystem\Filesystem

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

    {
        global $DIC;
 
        return $DIC["filesystem"]->storage();
    }

References $DIC.

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

Here is the caller graph for this function:

◆ getFileType()

ilObjBibliographic::getFileType ( )

Returns: int

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

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

References $filename, ilBiblTypeFactoryInterface\DATA_TYPE_BIBTEX, and getFilename().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileTypeAsString()

ilObjBibliographic::getFileTypeAsString ( )

Returns: string

Deprecated:: use type factory instead of string representation

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

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

References ilObject\$type, and getFileType().

Here is the call graph for this function:

◆ getLegacyAbsolutePath()

ilObjBibliographic::getLegacyAbsolutePath ( )

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

    {
        $stream = $this->getFileSystem()->readStream($this->getFileAbsolutePath());
 
        return $stream->getMetadata('uri');
    }

References getFileAbsolutePath(), and getFileSystem().

Here is the call graph for this function:

◆ getOnline()

ilObjBibliographic::getOnline ( )

Returns: bool

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

    {
        return $this->is_online;
    }

References $is_online.

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

Here is the caller graph for this function:

◆ initType()

ilObjBibliographic::initType ( )

initType

Returns: void

Reimplemented from ilObject2.

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

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

◆ parseFileToDatabase()

ilObjBibliographic::parseFileToDatabase ( )

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

Returns: void

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

    {
        //Read File
        $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->getFileAbsolutePath());
        $this->entries = $reader->parseContentToEntries($this);
    }

References ilObject\$type, getFileAbsolutePath(), and getFileType().

Referenced by doCreate(), and doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFilename()

ilObjBibliographic::setFilename ( $filename )

Parameters

string $filename

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

    {
        $this->filename = $filename;
    }

References $filename.

Referenced by cloneStructure(), and doRead().

Here is the caller graph for this function:

◆ setFileType()

ilObjBibliographic::setFileType ( $file_type )

Parameters

int $file_type

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

    {
        $this->file_type = $file_type;
    }

References $file_type.

Referenced by doRead().

Here is the caller graph for this function:

◆ setOnline()

ilObjBibliographic::setOnline ( $a_online )

Parameters

$a_online

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

    {
        $this->is_online = $a_online;
    }

Referenced by doRead().

Here is the caller graph for this function:

Field Documentation

◆ $bib_attribute_factory

ilObjBibliographic::$bib_attribute_factory

protected

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

◆ $bib_data_factory

ilObjBibliographic::$bib_data_factory

protected

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

◆ $bib_entry_factory

ilObjBibliographic::$bib_entry_factory

protected

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

◆ $bib_field_factory

ilObjBibliographic::$bib_field_factory

protected

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

◆ $bib_filereader_factory

ilObjBibliographic::$bib_filereader_factory

protected

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

◆ $bib_overview_factory

ilObjBibliographic::$bib_overview_factory

protected

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

◆ $bib_type_factory

ilObjBibliographic::$bib_type_factory

protected

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

◆ $entries

ilObjBibliographic::$entries

protected

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

◆ $file_type

ilObjBibliographic::$file_type = 0

protected

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

Referenced by setFileType().

◆ $filename

ilObjBibliographic::$filename

protected

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

Referenced by determineFileTypeByFileName(), getFilename(), getFileType(), and setFilename().

◆ $is_online

ilObjBibliographic::$is_online

protected

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

Referenced by getOnline().

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

Modules/Bibliographic/classes/class.ilObjBibliographic.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cloneStructure()

◆ copyFile()

◆ deleteFile()

◆ determineFileTypeByFileName()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getFileAbsolutePath()

◆ getFileDirectory()

◆ getFilename()

◆ getFilePath()

◆ getFileSystem()

◆ getFileType()

◆ getFileTypeAsString()

◆ getLegacyAbsolutePath()

◆ getOnline()

◆ initType()

◆ parseFileToDatabase()

◆ setFilename()

◆ setFileType()

◆ setOnline()

Field Documentation

◆ $bib_attribute_factory

◆ $bib_data_factory

◆ $bib_entry_factory

◆ $bib_field_factory

◆ $bib_filereader_factory

◆ $bib_overview_factory

◆ $bib_type_factory

◆ $entries

◆ $file_type

◆ $filename

◆ $is_online