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 ()
	Update data. More...

	getFileDirectory ()

	moveFile ($file_to_copy=false)

	deleteFile ()

	getFilePath ($without_filename=false)

	setFilename ($filename)

	getFilename ()

	getFileAbsolutePath ()

	getFiletype ()

	doCloneObject (ilObjBibliographic $new_obj, $a_target_id, $a_copy_id=0)
	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...

	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 @access public. More...

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

	read ($a_force_db=false)
	Read data from db. 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...

	getOwner ()
	get object owner More...

	getOwnerName ()

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

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

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

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

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

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

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

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

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

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

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

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

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

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

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

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

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

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. 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)
	Clone object permissions, put in tree ... More...

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

Public Member Functions inherited from ilObject
	ilObject ($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 ($a_force_db=false)
	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...

	getOwner ()
	get object owner More...

	getOwnerName ()

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

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

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

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

	getDiskUsage ()

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

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

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

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

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

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

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

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

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

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

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

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

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

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

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

	_lookupCreationDate ($a_id)
	Lookup creation date. 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	__readRisFile ($full_filename)

static	__readBibFile ($full_filename)

static	__setCharsetToUtf8 ($full_filename)

static	__convertBibSpecialChars ($file_content)
	Replace BibTeX Special Characters with real characters Most systems do not use this encoding. More...

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

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

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

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

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

static	_lookupObjId ($a_id)

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

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

static	_exists ($a_id, $a_reference=false)

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

static	_prepareCloneSelection ($a_ref_ids, $new_type)

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	_getAllReferences ($a_id)
	get all reference ids of object More...

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

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

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

static	_lookupObjId ($a_id)

static	setDeletedDates ($a_ref_ids)
	Set deleted date @global type $ilDB. More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id 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	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
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

	$ilias

	$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

	$obj_data_record
	object_data record More...

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

	doRead ()

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

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	__force_rmdir ($path)
	remove a directory recursively More...

static	__removeSpacesAndDashesAtBeginning ($input)

Protected Attributes
	$filename

	$entries

	$overviewModels

	$is_online

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

Version

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

Definition at line 17 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 68 of file class.ilObjBibliographic.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ __convertBibSpecialChars()

static ilObjBibliographic::__convertBibSpecialChars ( $file_content )

static

Replace BibTeX Special Characters with real characters Most systems do not use this encoding.

In those cases, nothing will be replaced

Parameters

String $file_content The string with containing encodings

Returns: String (UTF-8) without encodings

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

                                                                       {
                $bibtex_special_chars['ä'] = '{\"a}';
                $bibtex_special_chars['ë'] = '{\"e}';
                $bibtex_special_chars['ï'] = '{\"i}';
                $bibtex_special_chars['ö'] = '{\"o}';
                $bibtex_special_chars['ü'] = '{\"u}';
                $bibtex_special_chars['Ä'] = '{\"A}';
                $bibtex_special_chars['Ë'] = '{\"E}';
                $bibtex_special_chars['Ï'] = '{\"I}';
                $bibtex_special_chars['Ö'] = '{\"O}';
                $bibtex_special_chars['Ü'] = '{\"U}';
                $bibtex_special_chars['â'] = '{\^a}';
                $bibtex_special_chars['ê'] = '{\^e}';
                $bibtex_special_chars['î'] = '{\^i}';
                $bibtex_special_chars['ô'] = '{\^o}';
                $bibtex_special_chars['û'] = '{\^u}';
                $bibtex_special_chars['Â'] = '{\^A}';
                $bibtex_special_chars['Ê'] = '{\^E}';
                $bibtex_special_chars['Î'] = '{\^I}';
                $bibtex_special_chars['Ô'] = '{\^O}';
                $bibtex_special_chars['Û'] = '{\^U}';
                $bibtex_special_chars['à'] = '{\`a}';
                $bibtex_special_chars['è'] = '{\`e}';
                $bibtex_special_chars['ì'] = '{\`i}';
                $bibtex_special_chars['ò'] = '{\`o}';
                $bibtex_special_chars['ù'] = '{\`u}';
                $bibtex_special_chars['À'] = '{\`A}';
                $bibtex_special_chars['È'] = '{\`E}';
                $bibtex_special_chars['Ì'] = '{\`I}';
                $bibtex_special_chars['Ò'] = '{\`O}';
                $bibtex_special_chars['Ù'] = '{\`U}';
                $bibtex_special_chars['á'] = '{\\\'a}';
                $bibtex_special_chars['é'] = '{\\\'e}';
                $bibtex_special_chars['í'] = '{\\\'i}';
                $bibtex_special_chars['ó'] = '{\\\'o}';
                $bibtex_special_chars['ú'] = '{\\\'u}';
                $bibtex_special_chars['Á'] = '{\\\'A}';
                $bibtex_special_chars['É'] = '{\\\'E}';
                $bibtex_special_chars['Í'] = '{\\\'I}';
                $bibtex_special_chars['Ó'] = '{\\\'O}';
                $bibtex_special_chars['Ú'] = '{\\\'U}';
                $bibtex_special_chars['à'] = '{\`a}';
                $bibtex_special_chars['è'] = '{\`e}';
                $bibtex_special_chars['ì'] = '{\`i}';
                $bibtex_special_chars['ò'] = '{\`o}';
                $bibtex_special_chars['ù'] = '{\`u}';
                $bibtex_special_chars['À'] = '{\`A}';
                $bibtex_special_chars['È'] = '{\`E}';
                $bibtex_special_chars['Ì'] = '{\`I}';
                $bibtex_special_chars['Ò'] = '{\`O}';
                $bibtex_special_chars['Ù'] = '{\`U}';
                $bibtex_special_chars['ç'] = '{\c c}';
                $bibtex_special_chars['ß'] = '{\ss}';
                $bibtex_special_chars['ñ'] = '{\~n}';
                $bibtex_special_chars['Ñ'] = '{\~N}';
 
                return str_replace($bibtex_special_chars, array_keys($bibtex_special_chars), $file_content);
        }

Referenced by __readBibFile().

Here is the caller graph for this function:

◆ __force_rmdir()

static ilObjBibliographic::__force_rmdir ( $path )

staticprotected

remove a directory recursively

Parameters

$path

Returns: bool

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

                                                       {
                if (! file_exists($path)) {
                        return false;
                }
                if (is_file($path) || is_link($path)) {
                        return unlink($path);
                }
                if (is_dir($path)) {
                        $path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
                        $result = true;
                        $dir = new DirectoryIterator($path);
                        foreach ($dir as $file) {
                                if (! $file->isDot()) {
                                        $result &= self::__force_rmdir($path . $file->getFilename(), false);
                                }
                        }
                        $result &= rmdir($path);
 
                        return $result;
                }
        }

References $file, $path, $result, and __force_rmdir().

Referenced by __force_rmdir(), and deleteFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __readBibFile()

static ilObjBibliographic::__readBibFile ( $full_filename )

static

Parameters

$full_filename

Returns: array

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

                                                             {
                self::__setCharsetToUtf8($full_filename);
                require_once 'Modules/Bibliographic/lib/PEAR_BibTex_1.0.0RC5/Structures/BibTex.php';
                $bibtex_reader = new Structures_BibTex();
                //Loading and parsing the file example.bib
                $bibtex_reader->loadFile($full_filename);
                //replace bibtex special chars with the real characters
                $bibtex_reader->content = self::__convertBibSpecialChars($bibtex_reader->content);
                $bibtex_reader->setOption('extractAuthors', false);
                $bibtex_reader->parse();
                // Remove library-bug: if there is no cite, the library mixes up the key for the type and the first attribute.
                // It also shows an empty and therefore unwanted cite in the array.
                //
                // The cite is the text coming right after the type. Example:
                // ﻿@book {cite,
                // author = { "...."},
                foreach ($bibtex_reader->data as $key => $entry) {
                        if (empty($entry['cite'])) {
                                unset($bibtex_reader->data[$key]['cite']);
                                foreach ($entry as $attr_key => $attribute) {
                                        if (strpos($attr_key, '{') !== false) {
                                                unset($bibtex_reader->data[$key][$attr_key]);
                                                $attr_key_exploaded = explode('{', $attr_key);
                                                $bibtex_reader->data[$key]['entryType'] = trim($attr_key_exploaded[0]);
                                                $bibtex_reader->data[$key][trim($attr_key_exploaded[1])] = $attribute;
                                        }
                                }
                        }
                        // formating the author to the following type of string
                        // Smith, John / Comte, Gabriel / von Gunten Jr, Thomas
                        foreach ($entry as $attr_key => $attribute) {
                                if ($attr_key == 'author' && is_array($attribute)) {
                                        $attribute_string = array();
                                        foreach ($attribute as $author_key => $author) {
                                                $lastname = array( $author['von'], $author['last'], $author['jr'] );
                                                $attribute_string[$author_key] = implode(' ', array_filter($lastname));
                                                if (! empty($author['first'])) {
                                                        $attribute_string[$author_key] .= ', ' . $author['first'];
                                                }
                                        }
                                        $bibtex_reader->data[$key][$attr_key] = implode(' / ', $attribute_string);
                                }
                        }
                }
 
                return $bibtex_reader->data;
        }

References __convertBibSpecialChars(), and __setCharsetToUtf8().

Referenced by writeSourcefileEntriesToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __readRisFile()

static ilObjBibliographic::__readRisFile ( $full_filename )

static

Parameters

$full_filename

Returns: null

Exceptions

LibRIS\ParseException

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

                                                             {
                self::__setCharsetToUtf8($full_filename);
                require_once "./Modules/Bibliographic/lib/LibRIS/src/LibRIS/RISReader.php";
                $ris_reader = new RISReader();
                $ris_reader->parseFile($full_filename);
 
                return $ris_reader->getRecords();
        }

References __setCharsetToUtf8().

Referenced by writeSourcefileEntriesToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __removeSpacesAndDashesAtBeginning()

static ilObjBibliographic::__removeSpacesAndDashesAtBeginning ( $input )

staticprotected

Parameters

$input

Deprecated:

Returns: string

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

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

◆ __setCharsetToUtf8()

static ilObjBibliographic::__setCharsetToUtf8 ( $full_filename )

static

Parameters

$full_filename

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

                                                                  {
                //If file charset does not seem to be Unicode, we assume that it is ISO-8859-1, and convert it to UTF-8.
                $filedata = file_get_contents($full_filename);
                if (strlen($filedata) == strlen(utf8_decode($filedata))) {
                        // file charset is not UTF-8
                        $filedata = mb_convert_encoding($filedata, 'UTF-8', 'ISO-8859-1');
                        file_put_contents($full_filename, $filedata);
                }
        }

Referenced by __readBibFile(), and __readRisFile().

Here is the caller graph for this function:

◆ 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

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

Returns: void

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

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

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

Referenced by doCloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteFile()

ilObjBibliographic::deleteFile ( )

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

                               {
                $path = $this->getFilePath(true);
                self::__force_rmdir($path);
        }

References $path, __force_rmdir(), and getFilePath().

Referenced by doDelete(), and doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCloneObject()

ilObjBibliographic::doCloneObject	(	ilObjBibliographic	$new_obj,
			$a_target_id,
			$a_copy_id = `0`
	)

Clone BIBL.

Parameters

ilObjBibliographic	$new_obj
	$a_target_id
int	$a_copy_id	copy id

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

                                                                                                 {
 
                //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;
        }

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

Here is the call graph for this function:

◆ doCreate()

ilObjBibliographic::doCreate ( )

protected

Create object.

Returns: void

Reimplemented from ilObject2.

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

                                      {
                global $ilDB;
                $ilDB->manipulate("INSERT INTO il_bibl_data " . "(id, filename, is_online) VALUES (" . $ilDB->quote($this->getId(), "integer") . "," . // id
                        $ilDB->quote($this->getFilename(), "text") . "," . // filename
                        $ilDB->quote($this->getOnline(), "integer") . // is_online
                        ")");
        }

References $ilDB.

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

                                                                                                     {
                global $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
                require_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_removeEntriesForObject($this->getId());
        }

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

Here is the call graph for this function:

◆ doRead()

ilObjBibliographic::doRead ( )

protected

Reimplemented from ilObject2.

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

                                    {
                global $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']);
                }
        }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilObjBibliographic::doUpdate ( )

Update data.

Reimplemented from ilObject2.

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

                                   {
                global $ilDB;
                if (! empty($_FILES['bibliographic_file']['name'])) {
                        $this->deleteFile();
                        $this->moveFile();
                }
                // 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);
                $ilDB->manipulate("UPDATE il_bibl_data SET " . "filename = " . $ilDB->quote($this->getFilename(), "text") . ", " . // filename
                        "is_online = " . $ilDB->quote($this->getOnline(), "integer") . // is_online
                        " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
                $this->writeSourcefileEntriesToDb($this);
        }

References $ilDB, deleteFile(), ilObject2\doDelete(), moveFile(), and writeSourcefileEntriesToDb().

Referenced by ilObjBibliographicGUI\afterSave(), and cloneStructure().

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

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

References $ilDB, and $overviewModels.

Referenced by ilBiblOverviewGUI\render().

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: $ILIAS-data-folder/bibl/$id/$filename

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

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

References getFileDirectory(), and getFilename().

Referenced by writeSourcefileEntriesToDb().

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

                                           {
                return ilUtil::getDataDir() . DIRECTORY_SEPARATOR . $this->getType() . DIRECTORY_SEPARATOR . $this->getId();
        }

References ilUtil\getDataDir(), ilObject2\getId(), and ilObject2\getType().

Referenced by getFileAbsolutePath(), and moveFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilename()

ilObjBibliographic::getFilename ( )

Returns: int

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

                                      {
                return $this->filename;
        }

References $filename.

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

Here is the caller graph for this function:

◆ getFilePath()

ilObjBibliographic::getFilePath ( $without_filename = false )

Parameters

bool $without_filename

Returns: array with all filepath

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

                                                               {
                global $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'];
                        }
                }
        }

References $ilDB.

Referenced by deleteFile().

Here is the caller graph for this function:

◆ getFiletype()

ilObjBibliographic::getFiletype ( )

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

                                      {
                //return bib for filetype .bibtex:
                if (strtolower(substr($this->getFilename(), - 6)) == "bibtex") {
                        return "bib";
                }
 
                //else return its true filetype
                return strtolower(substr($this->getFilename(), - 3));
        }

References getFilename().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOnline()

ilObjBibliographic::getOnline ( )

Returns: bool

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

                                    {
                return $this->is_online;
        }

References $is_online.

Referenced by doCloneObject().

Here is the caller graph for this function:

◆ initType()

ilObjBibliographic::initType ( )

initType

Returns: void

Reimplemented from ilObject2.

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

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

◆ moveFile()

ilObjBibliographic::moveFile ( $file_to_copy = false )

Parameters

bool | false $file_to_copy

Exceptions

Exception

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

                                                        {
                $target_dir = $this->getFileDirectory();
                if (! is_dir($target_dir)) {
                        ilUtil::makeDirParents($target_dir);
                }
                if ($_FILES['bibliographic_file']['name']) {
                        $filename = $_FILES['bibliographic_file']['name'];
                } elseif ($file_to_copy) {
                        //file is not uploaded, but a clone is made out of another bibl
                        $split_path = explode(DIRECTORY_SEPARATOR, $file_to_copy);
                        $filename = $split_path[sizeof($split_path) - 1];
                } else {
                        throw new Exception("Either a file must be delivered via \$_POST/\$_FILE or the file must be delivered via the method argument file_to_copy");
                }
                $target_full_filename = $target_dir . DIRECTORY_SEPARATOR . $filename;
                //If there is no file_to_copy (which is used for clones), copy the file from the temporary upload directory (new creation of object).
                //Therefore, a warning predicates nothing and can be suppressed.
                if (@! copy($file_to_copy, $target_full_filename)) {
                        if (! empty($_FILES['bibliographic_file']['tmp_name'])) {
                                ilUtil::moveUploadedFile($_FILES['bibliographic_file']['tmp_name'], $_FILES['bibliographic_file']['name'], $target_full_filename);
                        } else {
                                throw new Exception("The file delivered via the method argument file_to_copy could not be copied. The file '{$file_to_copy}' does probably not exist.");
                        }
                }
                $this->setFilename($filename);
                ilUtil::sendSuccess($this->lng->txt("object_added"), true);
        }

References $filename, getFileDirectory(), ilUtil\makeDirParents(), ilUtil\moveUploadedFile(), ilUtil\sendSuccess(), and setFilename().

Referenced by cloneStructure(), and doUpdate().

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

                                               {
                $this->filename = $filename;
        }

References $filename.

Referenced by doRead(), and moveFile().

Here is the caller graph for this function:

◆ setOnline()

ilObjBibliographic::setOnline ( $a_online )

Parameters

$a_online

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

                                             {
                $this->is_online = $a_online;
        }

Referenced by doCloneObject(), and doRead().

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

                                                     {
                //Read File
                $entries_from_file = array();
                switch ($this->getFiletype()) {
                        case("ris"):
                                $entries_from_file = self::__readRisFile($this->getFileAbsolutePath());
                                break;
                        case("bib"):
                                $entries_from_file = self::__readBibFile($this->getFileAbsolutePath());
                                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();
                }
        }

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

Referenced by doUpdate().

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

◆ $filename

ilObjBibliographic::$filename

protected

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

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

◆ $is_online

ilObjBibliographic::$is_online

protected

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

Referenced by getOnline().

◆ $overviewModels

ilObjBibliographic::$overviewModels

protected

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

Referenced by getAllOverviewModels().

◆ ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH

const ilObjBibliographic::ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH = 4000

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

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

Modules/Bibliographic/classes/class.ilObjBibliographic.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __convertBibSpecialChars()

◆ __force_rmdir()

◆ __readBibFile()

◆ __readRisFile()

◆ __removeSpacesAndDashesAtBeginning()

◆ __setCharsetToUtf8()

◆ cloneStructure()

◆ deleteFile()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getAllOverviewModels()

◆ getFileAbsolutePath()

◆ getFileDirectory()

◆ getFilename()

◆ getFilePath()

◆ getFiletype()

◆ getOnline()

◆ initType()

◆ moveFile()

◆ setFilename()

◆ setOnline()

◆ writeSourcefileEntriesToDb()

Field Documentation

◆ $entries

◆ $filename

◆ $is_online

◆ $overviewModels

◆ ATTRIBUTE_VALUE_MAXIMAL_TEXT_LENGTH