Inheritance diagram for ilBibliographicSetting:

Collaboration diagram for ilBibliographicSetting:

Public Member Functions
	getConnectorContainerName ()

	generateLibraryLink (ilBibliographicEntry $entry, $type)

	getButton (ilObjBibliographic $bibl_obj, ilBibliographicEntry $entry)

	getId ()

	setId ($id)

	getImg ()

	setImg ($img)

	getName ()

	setName ($name)

	getShowInList ()

	setShowInList ($show_in_list)

	getUrl ()

	setUrl ($url)

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()

	setConnectorContainerName ($connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0, arConnector $connector=null)

	storeObjectToCache ()

	__getConvertedDateFieldsAsArray ($format=null)

	__asCsv ($separator=';', $header=false)

	__asArray ()

	__asStdClass ()

	__asSerializedObject ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForDb ()

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy ($new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

static	getAll ()

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField ($old_name, $new_name)

static	tableExists ()

static	fieldExists ($field_name)

static	removeDBField ($field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=array())

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	orderBy ($orderBy, $orderDirection='ASC')

static	dateFormat ($date_format='d.m.Y - H:i:s')

static	limit ($start, $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $connector)

static	raw ($set_raw=true)

static	getArray ($key=null, $values=null)

static	_toCamelCase ($str, $capitalise_first_char=false)

Data Fields
const	TABLE_NAME = 'il_bibl_settings'

Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Attributes
	$id

	$name

	$url

	$img

	$show_in_list

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Private Member Functions
	formatAttribute ($a, $type, $attributes, $prefix)

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()

static	fromCamelCase ($str)

Detailed Description

Class ilBibliographicSetting.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

Definition at line 11 of file class.ilBibliographicSetting.php.

Member Function Documentation

◆ formatAttribute()

ilBibliographicSetting::formatAttribute	(	$a,
		$type,
		$attributes,
		$prefix
	)

private

Parameters

String	$a
String	$type
array	$attributes
String	$prefix

Returns: String

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

References $attributes, and $type.

Referenced by generateLibraryLink().

     {
         if ($type = 'ris') {
             switch ($a) {
                 case 'ti':
                     $a = "title";
                     break;
                 case 't1':
                     $a = "title";
                     break;
                 case 'au':
                     $a = "author";
                     break;
                 case 'sn':
                     if (strlen($attributes[$prefix . "sn"]) <= 9) {
                         $a = "issn";
                     } else {
                         $a = "isbn";
                     }
                     break;
                 case 'py':
                     $a = "date";
                     break;
                 case 'is':
                     $a = "issue";
                     break;
                 case 'vl':
                     $a = "volume";
                     break;
             }
         } elseif ($type = 'bib') {
             switch ($a) {
                 case 'number':
                     $a = "issue";
                     break;
                 case 'year':
                     $a = "date";
                     break;
             }
         }
 
         return $a;
     }

Here is the caller graph for this function:

◆ generateLibraryLink()

ilBibliographicSetting::generateLibraryLink	(	ilBibliographicEntry	$entry,
			$type
	)

Parameters

ilBibliographicEntry	$entry
string	$type	(bib\|ris)

Returns: string

Definition at line 98 of file class.ilBibliographicSetting.php.

References $attributes, $type, array, formatAttribute(), ilBibliographicEntry\getAttributes(), ilBibliographicEntry\getType(), and getUrl().

Referenced by getButton().

     {
         $attributes = $entry->getAttributes();
         switch ($type) {
             case 'bib':
                 $prefix = "bib_default_";
                 if (!empty($attributes[$prefix . "isbn"])) {
                     $attr = array( "isbn" );
                 } elseif (!empty($attributes[$prefix . "pmid"])) {
                     $attr = array( "pmid" );
                 } elseif (!empty($attributes[$prefix . "doi"])) {
                     $attr = array( "doi" );
                 } elseif (!empty($attributes[$prefix . "issn"])) {
                     $attr = array( "issn" );
                 } else {
                     $attr = array( "title", "author", "year", "number", "volume" );
                 }
                 break;
             case 'ris':
                 $prefix = "ris_" . strtolower($entry->getType()) . "_";
                 if (!empty($attributes[$prefix . "sn"])) {
                     $attr = array( "sn" );
                 } elseif (!empty($attributes[$prefix . "do"])) {
                     $attr = array( "do" );
                 } else {
                     $attr = array( "ti", "t1", "au", "py", "is", "vl" );
                 }
                 break;
         }
 
         $url_params = "?";
         if (sizeof($attr) == 1) {
             if (($attr[0] == "doi") || ($attr[0] == "pmid")) {
                 $url_params .= "id=" . $this->formatAttribute($attr[0], $type, $attributes, $prefix) . "%3A" . $attributes[$prefix . $attr[0]];
             } elseif ($attr[0] == "do") {
                 $url_params .= "id=" . $this->formatAttribute($attr[0], $type, $attributes, $prefix) . "i%3A" . $attributes[$prefix . $attr[0]];
             } else {
                 $url_params .= $this->formatAttribute($attr[0], $type, $attributes, $prefix) . "=" . urlencode($attributes[$prefix . $attr[0]]);
             }
         } else {
             foreach ($attr as $a) {
                 if (array_key_exists($prefix . $a, $attributes)) {
                     if (strlen($url_params) > 1) {
                         $url_params .= "&";
                     }
                     $url_params .= $this->formatAttribute($a, $type, $attributes, $prefix) . "=" . urlencode($attributes[$prefix . $a]);
                 }
             }
         }
 
         // return full link
         $full_link = $this->getUrl() . $url_params;
 
         return $full_link;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAll()

static ilBibliographicSetting::getAll ( )

static

Returns: ilBibliographicSetting[]

Definition at line 86 of file class.ilBibliographicSetting.php.

Referenced by ilBibliographicRecordListTableGUI\fillRow(), ilBibliographicDetailsGUI\getInstance(), and ilObjBibliographicAdminLibrariesGUI\initTable().

     {
         return self::get();
     }

Here is the caller graph for this function:

◆ getButton()

ilBibliographicSetting::getButton	(	ilObjBibliographic	$bibl_obj,
		ilBibliographicEntry	$entry
	)

Parameters

ilObjBibliographic	$bibl_obj
ilBibliographicEntry	$entry

Returns: string

Definition at line 161 of file class.ilBibliographicSetting.php.

References generateLibraryLink(), ilObjBibliographic\getFiletype(), getImg(), ilImageLinkButton\getInstance(), and ilLinkButton\getInstance().

     {
         if ($this->getImg()) {
             $button = ilImageLinkButton::getInstance();
             $button->setUrl($this->generateLibraryLink($entry, $bibl_obj->getFiletype()));
             $button->setImage($this->getImg(), false);
         } else {
             $button = ilLinkButton::getInstance();
             $button->setUrl($this->generateLibraryLink($entry, $bibl_obj->getFiletype()));
             $button->setCaption('bibl_link_online');
         }
 
         $button->setTarget('_blank');
 
         return $button->render();
     }

Here is the call graph for this function:

◆ getConnectorContainerName()

ilBibliographicSetting::getConnectorContainerName ( )

Returns: string

Definition at line 29 of file class.ilBibliographicSetting.php.

     {
         return self::TABLE_NAME;
     }

◆ getId()

ilBibliographicSetting::getId ( )

Returns: mixed

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

References $id.

     {
         return $this->id;
     }

◆ getImg()

ilBibliographicSetting::getImg ( )

Returns: mixed

Definition at line 253 of file class.ilBibliographicSetting.php.

References $img.

Referenced by getButton().

     {
         return $this->img;
     }

Here is the caller graph for this function:

◆ getName()

ilBibliographicSetting::getName ( )

Returns: mixed

Definition at line 271 of file class.ilBibliographicSetting.php.

References $name.

     {
         return $this->name;
     }

◆ getShowInList()

ilBibliographicSetting::getShowInList ( )

Returns: mixed

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

References $show_in_list.

     {
         return $this->show_in_list;
     }

◆ getUrl()

ilBibliographicSetting::getUrl ( )

Returns: mixed

Definition at line 307 of file class.ilBibliographicSetting.php.

References $url.

Referenced by generateLibraryLink().

     {
         return $this->url;
     }

Here is the caller graph for this function:

◆ returnDbTableName()

static ilBibliographicSetting::returnDbTableName ( )

static

Returns: string

Deprecated:

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

     {
         return self::TABLE_NAME;
     }

◆ setId()

ilBibliographicSetting::setId ( $id )

Parameters

mixed $id

Definition at line 244 of file class.ilBibliographicSetting.php.

References $id.

     {
         $this->id = $id;
     }

◆ setImg()

ilBibliographicSetting::setImg ( $img )

Parameters

mixed $img

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

References $img.

     {
         $this->img = $img;
     }

◆ setName()

ilBibliographicSetting::setName ( $name )

Parameters

mixed $name

Definition at line 280 of file class.ilBibliographicSetting.php.

References $name.

     {
         $this->name = $name;
     }

◆ setShowInList()

ilBibliographicSetting::setShowInList ( $show_in_list )

Parameters

mixed $show_in_list

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

References $show_in_list.

     {
         $this->show_in_list = $show_in_list;
     }

◆ setUrl()

ilBibliographicSetting::setUrl ( $url )

Parameters

mixed $url

Definition at line 316 of file class.ilBibliographicSetting.php.

References $url.

     {
         $this->url = $url;
     }

Field Documentation

◆ $id

ilBibliographicSetting::$id

protected

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

Referenced by getId(), and setId().

◆ $img

ilBibliographicSetting::$img

protected

Definition at line 72 of file class.ilBibliographicSetting.php.

Referenced by getImg(), and setImg().

◆ $name

ilBibliographicSetting::$name

protected

Definition at line 55 of file class.ilBibliographicSetting.php.

Referenced by getName(), and setName().

◆ $show_in_list

ilBibliographicSetting::$show_in_list

protected

Definition at line 80 of file class.ilBibliographicSetting.php.

Referenced by getShowInList(), and setShowInList().

◆ $url

ilBibliographicSetting::$url

protected

Definition at line 64 of file class.ilBibliographicSetting.php.

Referenced by getUrl(), and setUrl().

◆ TABLE_NAME

const ilBibliographicSetting::TABLE_NAME = 'il_bibl_settings'

Definition at line 13 of file class.ilBibliographicSetting.php.

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

Modules/Bibliographic/classes/Admin/class.ilBibliographicSetting.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ formatAttribute()

◆ generateLibraryLink()

◆ getAll()

◆ getButton()

◆ getConnectorContainerName()

◆ getId()

◆ getImg()

◆ getName()

◆ getShowInList()

◆ getUrl()

◆ returnDbTableName()

◆ setId()

◆ setImg()

◆ setName()

◆ setShowInList()

◆ setUrl()

Field Documentation

◆ $id

◆ $img

◆ $name

◆ $show_in_list

◆ $url

◆ TABLE_NAME