Collaboration diagram for ilBibliographicEntry:

Public Member Functions
	doCreate ()

	doRead ()

	doUpdate ()

	doDelete ()

	setAttributes ($attributes)

	getAttributes ()

	initOverviewHTML ()

	getOverview ()

	setOverview ($overview)

	setBibliographicObjId ($bibliographic_obj_id)

	getBibliographicObjId ()

	setEntryId ($entry_id)

	getEntryId ()

	setType ($type)

	getType ()

	getFileType ()

	setFileType ($file_type)

Static Public Member Functions
static	getInstance ($file_type, $entry_id=null)

static	getAllEntries ($object_id)
	Read all entries from the database. More...

Protected Member Functions
	__construct ($file_type, $entry_id=null)

	loadAttributes ()
	Reads all the entrys attributes from database. More...

Protected Attributes
	$bibliographic_obj_id

	$entry_id

	$type

	$attributes

	$file_type

	$overview = ''

Static Protected Attributes
static	$instances = array()

Detailed Description

Class ilBibliographicEntry.

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

Version

Id: class.ilBibliographicEntry.php 2012-11-15 16:11:42Z gcomte

Definition at line 12 of file class.ilBibliographicEntry.php.

Constructor & Destructor Documentation

◆ __construct()

ilBibliographicEntry::__construct	(	$file_type,
		$entry_id = `null`
	)

protected

Parameters

	$file_type
null	$entry_id

Definition at line 96 of file class.ilBibliographicEntry.php.

References $entry_id, $file_type, doRead(), and setEntryId().

                                                                      {
                 $this->file_type = $file_type;
                 if ($entry_id) {
                         $this->setEntryId($entry_id);
                         $this->doRead();
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ doCreate()

ilBibliographicEntry::doCreate ( )

Definition at line 105 of file class.ilBibliographicEntry.php.

References $DIC, $ilDB, getAttributes(), and setEntryId().

                                    {
                 global $DIC;
                 $ilDB = $DIC['ilDB'];
                 //auto-increment il_bibl_entry
                 $this->setEntryId($ilDB->nextID('il_bibl_entry'));
                 //table il_bibl_entry
                 $ilDB->manipulate("INSERT INTO il_bibl_entry " . "(data_id, id, type) VALUES (" . $ilDB->quote($this->getBibliographicObjId(), "integer")
                                   . "," . // data_id
                                   $ilDB->quote($this->getEntryId(), "integer") . "," . // id
                                   $ilDB->quote($this->getType(), "text") . // type
                                   ")");
                 //table il_bibl_attribute
                 foreach ($this->getAttributes() as $attribute) {
                         //auto-increment il_bibl_attribute
                         $id = $ilDB->nextID('il_bibl_attribute');
                         $ilDB->manipulate("INSERT INTO il_bibl_attribute " . "(entry_id, name, value, id) VALUES (" . $ilDB->quote($this->getEntryId(), "integer")
                                           . "," . // entry_id
                                           $ilDB->quote($attribute['name'], "text") . "," . // name
                                           $ilDB->quote($attribute['value'], "text") . "," . // value
                                           $ilDB->quote($id, "integer") . // id
                                           ")");
                 }
         }

Here is the call graph for this function:

◆ doDelete()

ilBibliographicEntry::doDelete ( )

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

References $DIC, and $ilDB.

                                    {
                 global $DIC;
                 $ilDB = $DIC['ilDB'];
                 $this->emptyCache();
                 $this->deleteOptions();
                 $ilDB->manipulate("DELETE FROM il_bibl_entry WHERE id = " . $ilDB->quote($this->getEntryId(), "integer"));
                 $ilDB->manipulate("DELETE FROM il_bibl_attribute WHERE entry_id = " . $ilDB->quote($this->getEntryId(), "integer"));
         }

◆ doRead()

ilBibliographicEntry::doRead ( )

Definition at line 130 of file class.ilBibliographicEntry.php.

References $DIC, $ilDB, initOverviewHTML(), loadAttributes(), setAttributes(), and setType().

Referenced by __construct().

                                  {
                 global $DIC;
                 $ilDB = $DIC['ilDB'];
                 //table il_bibl_entry
                 $set = $ilDB->query("SELECT * FROM il_bibl_entry " . " WHERE id = " . $ilDB->quote($this->getEntryId(), "integer"));
                 while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->setType($rec['type']);
                 }
                 $this->setAttributes($this->loadAttributes());
                 $this->initOverviewHTML();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilBibliographicEntry::doUpdate ( )

Definition at line 143 of file class.ilBibliographicEntry.php.

References $DIC, $ilDB, and getAttributes().

                                    {
                 global $DIC;
                 $ilDB = $DIC['ilDB'];
                 //table il_bibl_entry
                 $ilDB->manipulate($up = "UPDATE il_bibl_entry SET " . " type = " . $ilDB->quote($this->getType(), "integer") . // type
                                         " WHERE id = " . $ilDB->quote($this->getEntryId(), "integer"));
                 //table il_bibl_attribute
                 foreach ($this->getAttributes() as $attribute) {
                         $ilDB->manipulate($up = "UPDATE il_bibl_attribute SET " . " name = " . $ilDB->quote($attribute['name'], "integer") . "," . // name
                                                 " value = " . $ilDB->quote($attribute['value'], "integer") . "," . // value
                                                 " WHERE id = " . $ilDB->quote($attribute['id'], "integer"));
                 }
         }

Here is the call graph for this function:

◆ getAllEntries()

static ilBibliographicEntry::getAllEntries ( $object_id )

static

Read all entries from the database.

Parameters

$object_id

Returns: array

Definition at line 309 of file class.ilBibliographicEntry.php.

References $DIC, $ilDB, and array.

Referenced by ilDataBibliographicRecordListTableGUI\initData().

                                                   {
                 global $DIC;
                 $ilDB = $DIC['ilDB'];
                 $entries = array();
                 $set = $ilDB->query("SELECT id FROM il_bibl_entry " . " WHERE data_id = " . $ilDB->quote($object_id, "integer"));
                 while ($rec = $ilDB->fetchAssoc($set)) {
                         $entries[]['entry_id'] = $rec['id'];
                 }
 
                 return $entries;
         }

Here is the caller graph for this function:

◆ getAttributes()

ilBibliographicEntry::getAttributes ( )

Returns: string[]

Definition at line 211 of file class.ilBibliographicEntry.php.

References $attributes.

Referenced by doCreate(), doUpdate(), and ilBibliographicSetting\generateLibraryLink().

                                         {
                 return $this->attributes;
         }

Here is the caller graph for this function:

◆ getBibliographicObjId()

ilBibliographicEntry::getBibliographicObjId ( )

Returns: int

Definition at line 249 of file class.ilBibliographicEntry.php.

References $bibliographic_obj_id.

                                                 {
                 return $this->bibliographic_obj_id;
         }

◆ getEntryId()

ilBibliographicEntry::getEntryId ( )

Returns: int

Definition at line 265 of file class.ilBibliographicEntry.php.

References $entry_id.

                                      {
                 return $this->entry_id;
         }

◆ getFileType()

ilBibliographicEntry::getFileType ( )

Returns: string

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

References $file_type.

                                       {
                 return $this->file_type;
         }

◆ getInstance()

static ilBibliographicEntry::getInstance	(	$file_type,
		$entry_id = `null`
	)

static

Parameters

	$file_type
null	$entry_id

Returns: ilBibliographicEntry

Definition at line 60 of file class.ilBibliographicEntry.php.

References $DIC, $entry_id, $file_type, $ilDB, $r, and array.

Referenced by ilDataBibliographicRecordListTableGUI\fillRow(), ilBibliographicDetailsGUI\getInstance(), ilDataBibliographicRecordListTableGUI\initData(), and ilObjBibliographic\writeSourcefileEntriesToDb().

                                                                          {
                 if (!$entry_id) {
                         return new self($file_type, $entry_id);
                 }
 
                 if (!isset(self::$instances[$entry_id])) {
                         self::$instances[$entry_id] = new self($file_type, $entry_id);
                 }
 
                 return self::$instances[$entry_id];
         }

Here is the caller graph for this function:

◆ getOverview()

ilBibliographicEntry::getOverview ( )

Returns: string

Definition at line 225 of file class.ilBibliographicEntry.php.

References $overview.

                                       {
                 return $this->overview;
         }

◆ getType()

ilBibliographicEntry::getType ( )

Returns: string

Definition at line 281 of file class.ilBibliographicEntry.php.

References $type.

Referenced by ilBibliographicSetting\generateLibraryLink(), and loadAttributes().

                                   {
                 return $this->type;
         }

Here is the caller graph for this function:

◆ initOverviewHTML()

ilBibliographicEntry::initOverviewHTML ( )

Definition at line 216 of file class.ilBibliographicEntry.php.

References setOverview().

Referenced by doRead().

                                            {
                 $ilBiblOverviewGUI = new ilBiblOverviewGUI($this);
                 $this->setOverview($ilBiblOverviewGUI->getHtml());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadAttributes()

ilBibliographicEntry::loadAttributes ( )

protected

Reads all the entrys attributes from database.

Returns: array Attributes of an entry

Definition at line 173 of file class.ilBibliographicEntry.php.

References $DIC, $ilDB, $type, array, and getType().

Referenced by doRead().

                                             {
                 global $DIC;
                 $ilDB = $DIC['ilDB'];
                 $all_attributes = array();
                 //table il_bibl_attribute
                 $set = $ilDB->query("SELECT * FROM il_bibl_attribute " . " WHERE entry_id = " . $ilDB->quote($this->getEntryId(), "integer"));
                 while ($rec = $ilDB->fetchAssoc($set)) {
                         $all_attributes[$rec['name']] = $rec['value'];
                 }
                 if ($this->file_type == "ris") {
                         //for RIS-Files also add the type;
                         $type = $this->getType();
                 } else {
                         $type = 'default';
                 }
                 $parsed_attributes = array();
                 foreach ($all_attributes as $key => $value) {
                         // surround links with <a href="">
                         // Allowed signs in URL: a-z A-Z 0-9 . ? & _ / - ~ ! ' * ( ) + , : ; @ = $ # [ ] %
                         $value = preg_replace('!(http)(s)?:\/\/[a-zA-Z0-9.?&_/\-~\!\'\*()+,:;@=$#\[\]%]+!', "<a href=\"\\0\" target=\"_blank\" rel=\"noopener\">\\0</a>", $value);
                         $parsed_attributes[strtolower($this->file_type . '_' . $type . '_' . $key)] = $value;
                 }
 
                 return $parsed_attributes;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAttributes()

ilBibliographicEntry::setAttributes ( $attributes )

Parameters

$attributes

Definition at line 203 of file class.ilBibliographicEntry.php.

References $attributes.

Referenced by doRead().

                                                    {
                 $this->attributes = $attributes;
         }

Here is the caller graph for this function:

◆ setBibliographicObjId()

ilBibliographicEntry::setBibliographicObjId ( $bibliographic_obj_id )

Parameters

int $bibliographic_obj_id

Definition at line 241 of file class.ilBibliographicEntry.php.

References $bibliographic_obj_id.

                                                                      {
                 $this->bibliographic_obj_id = $bibliographic_obj_id;
         }

◆ setEntryId()

ilBibliographicEntry::setEntryId ( $entry_id )

Parameters

int $entry_id

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

References $entry_id.

Referenced by __construct(), and doCreate().

                                               {
                 $this->entry_id = $entry_id;
         }

Here is the caller graph for this function:

◆ setFileType()

ilBibliographicEntry::setFileType ( $file_type )

Parameters

string $file_type

Definition at line 297 of file class.ilBibliographicEntry.php.

References $file_type.

                                                 {
                 $this->file_type = $file_type;
         }

◆ setOverview()

ilBibliographicEntry::setOverview ( $overview )

Parameters

string $overview

Definition at line 233 of file class.ilBibliographicEntry.php.

References $overview.

Referenced by initOverviewHTML().

                                                {
                 $this->overview = $overview;
         }

Here is the caller graph for this function:

◆ setType()

ilBibliographicEntry::setType ( $type )

Parameters

string $type

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

References $type.

Referenced by doRead().

                                        {
                 $this->type = $type;
         }

Here is the caller graph for this function:

Field Documentation

◆ $attributes

ilBibliographicEntry::$attributes

protected

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

Referenced by getAttributes(), and setAttributes().

◆ $bibliographic_obj_id

ilBibliographicEntry::$bibliographic_obj_id

protected

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

Referenced by getBibliographicObjId(), and setBibliographicObjId().

◆ $entry_id

ilBibliographicEntry::$entry_id

protected

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

Referenced by __construct(), getEntryId(), getInstance(), and setEntryId().

◆ $file_type

ilBibliographicEntry::$file_type

protected

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

Referenced by __construct(), getFileType(), getInstance(), and setFileType().

◆ $instances

ilBibliographicEntry::$instances = array()

staticprotected

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

◆ $overview

ilBibliographicEntry::$overview = ''

protected

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

Referenced by getOverview(), and setOverview().

◆ $type

ilBibliographicEntry::$type

protected

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

Referenced by getType(), loadAttributes(), and setType().

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

Modules/Bibliographic/classes/class.ilBibliographicEntry.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getAllEntries()

◆ getAttributes()

◆ getBibliographicObjId()

◆ getEntryId()

◆ getFileType()

◆ getInstance()

◆ getOverview()

◆ getType()

◆ initOverviewHTML()

◆ loadAttributes()

◆ setAttributes()

◆ setBibliographicObjId()

◆ setEntryId()

◆ setFileType()

◆ setOverview()

◆ setType()

Field Documentation

◆ $attributes

◆ $bibliographic_obj_id

◆ $entry_id

◆ $file_type

◆ $instances

◆ $overview

◆ $type