ilObjBibliographic Class Reference

Class ilObjBibliographic. More...

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 ()
	getFiletype ()
	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone BIBL. More...
	cloneStructure ($original_id)
	Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id)) More...
	writeSourcefileEntriesToDb ()
	Reads out the source file and writes all entries to the database. More...
	setOnline ($a_online)
	getOnline ()
Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	read ()
	Read data from db. More...
	getId ()
	setId ($a_id)
	setRefId ($a_id)
	getRefId ()
	getType ()
	setType ($a_type)
	getPresentationTitle ()
	getTitle ()
	getUntranslatedTitle ()
	setTitle ($a_title)
	getDescription ()
	setDescription ($a_desc)
	getLongDescription ()
	getImportId ()
	setImportId ($a_import_id)
	getOwner ()
	getOwnerName ()
	setOwner ($a_owner)
	getCreateDate ()
	getLastUpdateDate ()
	create ($a_clone_mode=false)
	update ()
	MDUpdateListener ($a_element)
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	putInTree ($a_parent_ref)
	setPermissions ($a_parent_ref)
	createReference ()
	countReferences ()
	delete ()
	initDefaultRoles ()
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	cloneMetaData ($target_obj)
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	cloneDependencies ($a_target_id, $a_copy_id)
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor 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 public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title 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 public More...
	getLastUpdateDate ()
	get last update date 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...
	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) 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...

Static Public Member Functions
static	getAllOverviewModels ()
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupOwnerName ($a_owner_id)
static	_getIdForImportId ($a_import_id)
static	_getAllReferences ($a_id)
static	_lookupTitle ($a_id)
static	_lookupOwner ($a_id)
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
static	_lookupLastUpdate ($a_id, $a_as_string=false)
static	_getLastUpdateOfObjects ($a_objs)
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
static	_resetDeletedDate ($a_ref_id)
static	_lookupDeletedDate ($a_ref_id)
static	_writeTitle ($a_obj_id, $a_title)
static	_writeDescription ($a_obj_id, $a_desc)
static	_writeImportId ($a_obj_id, $a_import_id)
static	_lookupType ($a_id, $a_reference=false)
static	_isInTrash ($a_ref_id)
static	_hasUntrashedReference ($a_obj_id)
static	_lookupObjectId ($a_ref_id)
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
static	_exists ($a_id, $a_reference=false, $a_type=null)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
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	_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)
	only called in ilTree::saveSubTree More...
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. 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 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
const	FILETYPE_RIS = "ris"
const	FILETYPE_BIB = "bib"
const	ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH = 4000
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

Protected Member Functions
	doCreate ()
	Create object. More...
	doRead ()
	doDelete ($leave_out_il_bibl_data=false, $leave_out_delete_file=false)
	moveUploadedFile (\ILIAS\FileUpload\FileUpload $upload)
	deleteFile ()
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate ()
	beforeCreate ()
	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 ()

Static Protected Member Functions
static	__removeSpacesAndDashesAtBeginning ($input)

Protected Attributes
	$filename
	$entries
	$overviewModels
	$is_online
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Private Member Functions
	copyFile ($file_to_copy)
	getFileSystem ()

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 16 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

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

References doRead(), and ilObject2\setId().

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

Here is the call graph for this function:

Member Function Documentation

__removeSpacesAndDashesAtBeginning()

static ilObjBibliographic::__removeSpacesAndDashesAtBeginning (   $input )

staticprotected

Parameters

$input

Deprecated:

Returns

string

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

References $i.

    {
        for ($i = 0; $i < strlen($input); $i++) {
            if ($input[$i] != " " && $input[$i] != "-") {
                return substr($input, $i);
            }
        }
    }

cloneStructure()

ilObjBibliographic::cloneStructure

(

$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

Returns

void

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

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

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

Here is the call graph for this function:

copyFile()

ilObjBibliographic::copyFile (   $file_to_copy )

private

Parameters

$file_to_copy

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

References $target, getFileDirectory(), and getFileSystem().

Referenced by cloneStructure().

    {
        $target = $this->getFileDirectory() . '/' . basename($file_to_copy);
        $this->getFileSystem()->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

Returns

bool

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

References $path, getFileDirectory(), and getFileSystem().

Referenced by doDelete(), doUpdate(), and moveUploadedFile().

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

        return true;
    }

Here is the call graph for this function:

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

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

    {
        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());

        return $new_obj;
    }

Here is the call graph for this function:

doCreate()

ilObjBibliographic::doCreate ( )

protected

Create object.

Returns

void

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

References $DIC, getFilename(), ilObject2\getId(), getOnline(), and moveUploadedFile().

    {
        global $DIC;

        $upload = $DIC->upload();
        if ($upload->hasUploads() && !$upload->hasBeenProcessed()) {
            $upload->process();
            $this->moveUploadedFile($upload);
        }

        $DIC->database()->insert("il_bibl_data", [
            "id" => ["integer", $this->getId()],
            "filename" => ["text", $this->getFilename()],
            "is_online" => ["integer", $this->getOnline()],
        ]);
    }

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

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

    {
        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
        $ilDB->manipulate("DELETE FROM il_bibl_entry WHERE data_id = "
                          . $ilDB->quote($this->getId(), "integer"));
        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());
    }

Here is the call graph for this function:

doRead()

ilObjBibliographic::doRead ( )

protected

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

References $DIC, $ilDB, getFilename(), setFilename(), and setOnline().

Referenced by __construct().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $set = $ilDB->query("SELECT * FROM il_bibl_data " . " WHERE id = "
                            . $ilDB->quote($this->getId(), "integer"));
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (!$this->getFilename()) {
                $this->setFilename($rec["filename"]);
            }
            $this->setOnline($rec['is_online']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doUpdate()

ilObjBibliographic::doUpdate

(

)

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

References $_POST, $DIC, deleteFile(), ilObject2\doDelete(), getFilename(), ilObject2\getId(), getOnline(), moveUploadedFile(), and writeSourcefileEntriesToDb().

Referenced by cloneStructure().

    {
        global $DIC;

        $upload = $DIC->upload();
        if ($_POST['override_entries'] && $upload->hasUploads() && !$upload->hasBeenProcessed()) {
            $upload->process();
            $this->deleteFile();
            $this->moveUploadedFile($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);

        $DIC->database()->update("il_bibl_data", [
            "filename" => ["text", $this->getFilename()],
            "is_online" => ["integer", $this->getOnline()],
        ], ["id" => ["integer", $this->getId()]]);

        $this->writeSourcefileEntriesToDb();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllOverviewModels()

static ilObjBibliographic::getAllOverviewModels ( )

static

Returns

array

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

References $DIC, $ilDB, $overviewModels, and array.

Referenced by ilBiblOverviewGUI\render().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $overviewModels = array();
        $set = $ilDB->query('SELECT * FROM il_bibl_overview_model');
        while ($rec = $ilDB->fetchAssoc($set)) {
            if ($rec['literature_type']) {
                $overviewModels[$rec['filetype']][$rec['literature_type']] = $rec['pattern'];
            } else {
                $overviewModels[$rec['filetype']] = $rec['pattern'];
            }
        }

        return $overviewModels;
    }

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

References getFileDirectory(), and getFilename().

Referenced by getLegacyAbsolutePath(), and writeSourcefileEntriesToDb().

    {
        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

(

)

Returns

string the folder is: $ILIAS-data-folder/bibl/$id

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

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

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

Here is the caller graph for this function:

getFilename()

ilObjBibliographic::getFilename

(

)

Returns

int

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

References $filename.

Referenced by doCreate(), doRead(), doUpdate(), getFileAbsolutePath(), and getFiletype().

    {
        return $this->filename;
    }

Here is the caller graph for this function:

getFilePath()

ilObjBibliographic::getFilePath

(

$without_filename = false

)

Parameters

bool

$without_filename

Returns

string

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

References $DIC, and $ilDB.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $set = $ilDB->query("SELECT filename FROM il_bibl_data " . " WHERE id = "
                            . $ilDB->quote($this->getId(), "integer"));
        $rec = $ilDB->fetchAssoc($set);
        {
            if ($without_filename) {
                return substr($rec['filename'], 0, strrpos($rec['filename'], DIRECTORY_SEPARATOR));
            } else {
                return $rec['filename'];
            }
        }
    }

getFileSystem()

ilObjBibliographic::getFileSystem ( )

private

Returns

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

References $DIC.

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

    {
        global $DIC;

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

Here is the caller graph for this function:

getFiletype()

ilObjBibliographic::getFiletype

(

)

Returns

string

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

References $filename, and getFilename().

Referenced by ilBibliographicSetting\getButton(), and writeSourcefileEntriesToDb().

    {
        //return bib for filetype .bibtex:
        $filename = $this->getFilename();
        if (strtolower(substr($filename, -6)) == "bibtex") {
            return self::FILETYPE_BIB;
        }

        //else return its true filetype
        return strtolower(substr($filename, -3));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLegacyAbsolutePath()

ilObjBibliographic::getLegacyAbsolutePath

(

)

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

References GuzzleHttp\Psr7\$stream, getFileAbsolutePath(), and getFileSystem().

    {
        $stream = $this->getFileSystem()->readStream($this->getFileAbsolutePath());

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

Here is the call graph for this function:

getOnline()

ilObjBibliographic::getOnline

(

)

Returns

bool

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

References $is_online.

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

    {
        return $this->is_online;
    }

Here is the caller graph for this function:

initType()

ilObjBibliographic::initType

(

)

initType

Returns

void

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

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

moveUploadedFile()

ilObjBibliographic::moveUploadedFile ( \ILIAS\FileUpload\FileUpload  $upload )

protected

Parameters

\ILIAS\FileUpload\FileUpload

$upload

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

References $result, deleteFile(), getFileDirectory(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, and setFilename().

Referenced by doCreate(), and doUpdate().

    {
        $result = array_values($upload->getResults())[0];
        if ($result->getStatus() == \ILIAS\FileUpload\DTO\ProcessingStatus::OK) {
            $this->deleteFile();
            $upload->moveFilesTo($this->getFileDirectory(), \ILIAS\FileUpload\Location::STORAGE);
            $this->setFilename($result->getName());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFilename()

ilObjBibliographic::setFilename

(

$filename

)

Parameters

$filename

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

References $filename.

Referenced by cloneStructure(), doRead(), and moveUploadedFile().

    {
        $this->filename = $filename;
    }

Here is the caller graph for this function:

setOnline()

ilObjBibliographic::setOnline

(

$a_online

)

Parameters

$a_online

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

Referenced by doRead().

    {
        $this->is_online = $a_online;
    }

Here is the caller graph for this function:

writeSourcefileEntriesToDb()

ilObjBibliographic::writeSourcefileEntriesToDb

(

)

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

Returns

void

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

References $key, ilObject\$type, $x, array, getFileAbsolutePath(), getFiletype(), ilObject2\getId(), ilBibliographicEntry\getInstance(), ilStr\strLen(), and ilStr\subStr().

Referenced by doUpdate().

    {
        //Read File
        $entries_from_file = array();
        $filetype = $this->getFiletype();
        switch ($filetype) {
            case(self::FILETYPE_RIS):
                $ilRis = new ilRis();
                $ilRis->readContent($this->getFileAbsolutePath());

                $entries_from_file = $ilRis->parseContent();
                break;
            case(self::FILETYPE_BIB):
                $bib = new ilBibTex();
                $bib->readContent($this->getFileAbsolutePath());

                $entries_from_file = $bib->parseContent();
                break;
        }
        //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) {
                // if the attribute is an array, make a comma separated string out of it
                if (is_array($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;
            }
            //create the entry and fill data into database by executing doCreate()
            $entry_model = ilBibliographicEntry::getInstance($this->getFiletype());
            $entry_model->setType($type);
            $entry_model->setAttributes($parsed_entry);
            $entry_model->setBibliographicObjId($this->getId());
            $entry_model->doCreate();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$entries

ilObjBibliographic::$entries

protected

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

$filename

ilObjBibliographic::$filename

protected

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

Referenced by getFilename(), getFiletype(), and setFilename().

$is_online

ilObjBibliographic::$is_online

protected

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

Referenced by getOnline().

$overviewModels

ilObjBibliographic::$overviewModels

protected

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

Referenced by getAllOverviewModels().

ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH

const ilObjBibliographic::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH = 4000

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

FILETYPE_BIB

const ilObjBibliographic::FILETYPE_BIB = "bib"

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

FILETYPE_RIS

const ilObjBibliographic::FILETYPE_RIS = "ris"

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

---

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

• Modules/Bibliographic/classes/class.ilObjBibliographic.php