Inheritance diagram for ilObjBibliographicGUI:

Collaboration diagram for ilObjBibliographicGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)

	getStandardCmd ()
	getStandardCmd More...

	getType ()
	getType More...

	executeCommand ()
	executeCommand More...

	infoScreen ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...

	infoScreenForward ()
	show information screen More...

	addLocatorItems ()

	save ()

	initEditForm ()

	getEditFormCustomValues (array &$a_values)

	render ()

	showContent ()
	shows the overview page with all entries in a table More...

	sendFile ()
	provide file as a download More...

	showDetails ()

	view ()

	updateCustom (ilPropertyFormGUI $a_form)
	updateSettings More...

	toggleNotification ()

	addNews ($obj_id, $change='created')

	addToDeskObject ()
	Add desktop item. More...

	removeFromDeskObject ()
	Remove from desktop. More...

	addToDesk ()
	Add desktop item. More...

	removeFromDesk ()
	Remove from desktop. More...

Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...

	executeCommand ()
	execute command More...

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode ($a_mode=true)

	getCreationMode ()

	prepareOutput ($a_show_subobjects=true)

	isVisible ($a_ref_id, $a_type)

	trash ()

	undelete ()

	cancelDelete ()

	removeFromSystem ()

	cloneAll ()

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	Deleted in ilObject. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()
	Import. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

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

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page public More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()
	save object More...

	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

	viewObject ()
	list childs of current object More...

	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Static Public Member Functions
static	_goto ($a_target)
	_goto Deep link More...

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
const	P_ENTRY_ID = 'entry_id'

const	CMD_SHOW_CONTENT = 'showContent'

const	CMD_SEND_FILE = "sendFile"

const	TAB_CONTENT = "content"

const	SUB_TAB_FILTER = "filter"

const	CMD_VIEW = "view"

const	TAB_EXPORT = "export"

const	TAB_SETTINGS = self::SUBTAB_SETTINGS

const	TAB_ID_RECORDS = "id_records"

const	TAB_ID_PERMISSIONS = "id_permissions"

const	TAB_ID_INFO = "id_info"

const	CMD_SHOW_DETAILS = "showDetails"

const	CMD_EDIT = "edit"

const	SUBTAB_SETTINGS = "settings"

const	CMD_EDIT_OBJECT = 'editObject'

const	CMD_UPDATE_OBJECT = 'updateObject'

	$object

Data Fields inherited from ilObject2GUI
	$tree

const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	initCreationForms ($a_new_type)

	initSubTabs ()

	initEditCustomForm (ilPropertyFormGUI $a_form)

	applyFilter ()

	resetFilter ()

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()
	Get access handler. More...

	setLocator ()
	set Locator More...

	deleteConfirmation ()
	Display delete confirmation form (workspace specific) More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...

	setTitleAndDescription ()

	showUpperIcon ()

	omitLocator ($a_omit=true)

	getTargetFrame ($a_cmd, $a_target_frame="")

	setTargetFrame ($a_cmd, $a_target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	setColumnSettings (ilColumnGUI $column_gui)

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId ($a_ref_id, $a_cmd="")

	fillCloneTemplate ($a_tpl_varname, $a_type)

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

	addAdminLocatorItems ($a_do_not_add_object=false)

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...

	setReturnLocation ($a_cmd, $a_location)

	showActions ()

	getTabs ()

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")

	addLocatorItems ()
	Functions to be overwritten. More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

	getPermanentLinkWidget ($a_append=null, $a_center=false)

	handleAutoRating (ilObject $a_new_obj)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	showMountWebfolderIcon ()

	setTabs ()
	set admin tabs public More...

	setAdminTabs ()
	set admin tabs public More...

	setLocator ()
	set Locator More...

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator ($a_omit=true)

	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...

	initEditForm ()
	Init object edit form. More...

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()
	Get values for edit form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$facade

	$translation_factory

	$field_factory

	$filter_factory

	$type_factory

	$cmd = self::CMD_SHOW_CONTENT

Protected Attributes inherited from ilObject2GUI
	$object_id

	$node_id

	$creation_forms = array()

	$id_type = array()

	$parent_id

	$access_handler

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

Private Member Functions
	handleNonAccess ()

Detailed Description

Class ilObjBibliographicGUI.

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; Martin Studer ms@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

ilObjBibliographicGUI: ilInfoScreenGUI, ilNoteGUI ilObjBibliographicGUI: ilCommonActionDispatcherGUI ilObjBibliographicGUI: ilPermissionGUI, ilObjectCopyGUI, ilExportGUI ilObjBibliographicGUI: ilObjUserGUI, ilBiblEntryPresentationGUI ilObjBibliographicGUI: ilBiblEntryTableGUI ilObjBibliographicGUI: ilBiblFieldFilterGUI ilObjBibliographicGUI: ilRepositoryGUI

Definition at line 21 of file class.ilObjBibliographicGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjBibliographicGUI::__construct	(	$a_id = `0`,
		$a_id_type = `self::REPOSITORY_NODE_ID`,
		$a_parent_node_id = `0`
	)

Parameters

int	$a_id
int	$a_id_type
int	$a_parent_node_id

Definition at line 75 of file class.ilObjBibliographicGUI.php.

References $DIC.

     {
         global $DIC;
 
         parent::__construct($a_id, $a_id_type, $a_parent_node_id);
         $DIC->language()->loadLanguageModule('bibl');
 
         if (is_object($this->object)) {
             $this->facade = new ilBiblFactoryFacade($this->object);
         }
     }

Member Function Documentation

◆ _goto()

static ilObjBibliographicGUI::_goto ( $a_target )

static

_goto Deep link

Parameters

string $a_target

Definition at line 248 of file class.ilObjBibliographicGUI.php.

References $DIC, $id, and P_ENTRY_ID.

     {
         global $DIC;
 
         $id = explode("_", $a_target);
         $DIC->ctrl()->initBaseClass(ilRepositoryGUI::class);
         $DIC->ctrl()->setParameterByClass(ilObjBibliographicGUI::class, "ref_id", $id[0]);
         // Detail-View
         if ($id[1]) {
             $DIC->ctrl()
                 ->setParameterByClass(ilObjBibliographicGUI::class, ilObjBibliographicGUI::P_ENTRY_ID, $id[1]);
             $DIC->ctrl()->redirectByClass(
                 array(
                     ilRepositoryGUI::class,
                     ilObjBibliographicGUI::class,
                 ),
                 self::CMD_SHOW_DETAILS
             );
         } else {
             $DIC->ctrl()->redirectByClass(
                 array(
                     ilRepositoryGUI::class,
                     ilObjBibliographicGUI::class,
                 ),
                 self::CMD_VIEW
             );
         }
     }

◆ addLocatorItems()

ilObjBibliographicGUI::addLocatorItems ( )

Definition at line 232 of file class.ilObjBibliographicGUI.php.

References $DIC, and ilObject2GUI\$node_id.

     {
         global $DIC;
         $ilLocator = $DIC['ilLocator'];
         if (is_object($this->object)) {
             $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
         }
     }

◆ addNews()

ilObjBibliographicGUI::addNews	(	$obj_id,
		$change = `'created'`
	)

Parameters

string $change

Definition at line 631 of file class.ilObjBibliographicGUI.php.

References $DIC, ilObjectGUI\$obj_id, getType(), NEWS_NOTICE, and NEWS_USERS.

Referenced by save(), and updateCustom().

     {
         global $DIC;
 
         $ilNewsItem = new ilNewsItem();
         $ilNewsItem->setTitle($DIC->language()->txt('news_title_' . $change));
         $ilNewsItem->setPriority(NEWS_NOTICE);
         $ilNewsItem->setContext($obj_id, $this->getType());
         $ilNewsItem->setUserId($DIC->user()->getId());
         $ilNewsItem->setVisibility(NEWS_USERS);
         $ilNewsItem->setContentTextIsLangVar(false);
         $ilNewsItem->create();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToDesk()

ilObjBibliographicGUI::addToDesk ( )

Add desktop item.

Alias for addToDeskObject.

public

Definition at line 681 of file class.ilObjBibliographicGUI.php.

References addToDeskObject().

     {
         $this->addToDeskObject();
     }

Here is the call graph for this function:

◆ addToDeskObject()

ilObjBibliographicGUI::addToDeskObject ( )

Add desktop item.

public

Implements ilDesktopItemHandling.

Definition at line 651 of file class.ilObjBibliographicGUI.php.

References $DIC, and ilDesktopItemGUI\addToDesktop().

Referenced by addToDesk().

     {
         global $DIC;
 
         ilDesktopItemGUI::addToDesktop();
         ilUtil::sendSuccess($DIC->language()->txt("added_to_desktop"), true);
         $this->ctrl->redirect($this, self::CMD_VIEW);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyFilter()

ilObjBibliographicGUI::applyFilter ( )

protected

Definition at line 515 of file class.ilObjBibliographicGUI.php.

References $table.

     {
         $table = new ilBiblEntryTableGUI($this, $this->facade);
         $table->writeFilterToSession();
         $table->resetOffset();
         $this->ctrl->redirect($this, self::CMD_SHOW_CONTENT);
     }

◆ executeCommand()

ilObjBibliographicGUI::executeCommand ( )

executeCommand

Definition at line 115 of file class.ilObjBibliographicGUI.php.

References $cmd, $DIC, ilObjectGUI\addHeaderAction(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getStandardCmd(), handleNonAccess(), infoScreenForward(), initSubTabs(), and ilObject2GUI\prepareOutput().

     {
         global $DIC;
         $ilNavigationHistory = $DIC['ilNavigationHistory'];
 
         // Navigation History
         $link = $this->dic()->ctrl()->getLinkTarget($this, $this->getStandardCmd());
         if ($this->object != null) {
             $ilNavigationHistory->addItem($this->object->getRefId(), $link, "bibl");
             $this->addHeaderAction();
         }
 
         // general Access Check, especially for single entries not matching the object
         if ($this->object instanceof ilObjBibliographic && !$DIC->access()->checkAccess('visible', "", $this->object->getRefId())) {
             $this->handleNonAccess();
         }
 
         $next_class = $this->dic()->ctrl()->getNextClass($this);
         $this->cmd = $this->dic()->ctrl()->getCmd();
         switch ($next_class) {
             case strtolower(ilInfoScreenGUI::class):
                 $this->prepareOutput();
                 $this->dic()->tabs()->activateTab(self::TAB_ID_INFO);
                 $this->infoScreenForward();
                 break;
             case strtolower(ilCommonActionDispatcherGUI::class):
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $this->ctrl->forwardCommand($gui);
                 break;
             case strtolower(ilPermissionGUI::class):
                 $this->prepareOutput();
                 $this->dic()->tabs()->activateTab(self::TAB_ID_PERMISSIONS);
                 $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                 break;
             case strtolower(ilObjectCopyGUI::class):
                 $cp = new ilObjectCopyGUI($this);
                 $cp->setType('bibl');
                 $this->dic()['tpl']->getStandardTemplate();
                 $this->ctrl->forwardCommand($cp);
                 break;
             case strtolower(ilObjFileGUI::class):
                 $this->prepareOutput();
                 $this->dic()->tabs()->setTabActive(self::TAB_ID_RECORDS);
                 $this->ctrl->forwardCommand(new ilObjFile($this));
                 break;
             case strtolower(ilExportGUI::class):
                 $this->prepareOutput();
                 $this->dic()->tabs()->setTabActive(self::TAB_EXPORT);
                 $exp_gui = new ilExportGUI($this);
                 $exp_gui->addFormat("xml");
                 $this->ctrl->forwardCommand($exp_gui);
                 break;
             case strtolower(ilBiblFieldFilterGUI::class):
                 $this->prepareOutput();
                 $this->dic()->tabs()->setTabActive(self::TAB_SETTINGS);
                 $this->initSubTabs();
                 $this->tabs_gui->activateSubTab(self::SUB_TAB_FILTER);
                 $this->ctrl->forwardCommand(new ilBiblFieldFilterGUI($this->facade));
                 break;
             default:
                 $this->prepareOutput();
                 $cmd = $this->ctrl->getCmd(self::CMD_SHOW_CONTENT);
                 switch ($cmd) {
                     case 'edit':
                     case 'update':
                     case self::CMD_EDIT_OBJECT:
                     case self::CMD_UPDATE_OBJECT:
                         $this->initSubTabs();
                         $this->tabs_gui->activateSubTab(self::SUBTAB_SETTINGS);
                         $this->{$cmd}();
                         break;
                     default:
                         $this->{$cmd}();
                         break;
                 }
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjBibliographicGUI::getEditFormCustomValues ( array & $a_values )

Parameters

array $a_values

Returns: array

Definition at line 459 of file class.ilObjBibliographicGUI.php.

     {
         $a_values["is_online"] = $this->object->getOnline();
 
         return $a_values;
     }

◆ getStandardCmd()

ilObjBibliographicGUI::getStandardCmd ( )

getStandardCmd

Returns: String

Definition at line 93 of file class.ilObjBibliographicGUI.php.

Referenced by executeCommand().

     {
         return self::CMD_VIEW;
     }

Here is the caller graph for this function:

◆ getType()

ilObjBibliographicGUI::getType ( )

getType

Returns: String

Deprecated:: REFACTOR use type factory via Facade

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

Referenced by addNews(), and save().

     {
         return "bibl";
     }

Here is the caller graph for this function:

◆ handleNonAccess()

ilObjBibliographicGUI::handleNonAccess ( )

private

Definition at line 712 of file class.ilObjBibliographicGUI.php.

References $_GET, $DIC, ilObjectGUI\_gotoRepositoryRoot(), and ilUtil\sendFailure().

Referenced by executeCommand(), sendFile(), showContent(), showDetails(), and updateCustom().

     {
         global $DIC;
 
         unset($_GET);
         ilUtil::sendFailure($DIC->language()->txt("no_permission"), true);
         ilObjectGUI::_gotoRepositoryRoot();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoScreen()

ilObjBibliographicGUI::infoScreen ( )

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 202 of file class.ilObjBibliographicGUI.php.

References infoScreenForward().

     {
         $this->ctrl->setCmd("showSummary");
         $this->ctrl->setCmdClass(ilInfoScreenGUI::class);
         $this->infoScreenForward();
     }

Here is the call graph for this function:

◆ infoScreenForward()

ilObjBibliographicGUI::infoScreenForward ( )

show information screen

Definition at line 213 of file class.ilObjBibliographicGUI.php.

References $DIC, $info, and ilUtil\sendFailure().

Referenced by executeCommand(), and infoScreen().

     {
         global $DIC;
 
         if (!$this->checkPermissionBoolAndReturn("visible") && !$this->checkPermissionBoolAndReturn('read')) {
             ilUtil::sendFailure($DIC['lng']->txt("msg_no_perm_read"), true);
             $this->ctrl->redirectByClass('ilPersonalDesktopGUI', '');
         }
         $DIC->tabs()->activateTab(self::TAB_ID_INFO);
         $info = new ilInfoScreenGUI($this);
         $info->enablePrivateNotes();
         $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
         $this->ctrl->forwardCommand($info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjBibliographicGUI::initCreationForms ( $a_new_type )

protected

Parameters

string $a_new_type

Returns: array

Definition at line 283 of file class.ilObjBibliographicGUI.php.

References $DIC, and ilFileInputGUI\setSuffixes().

Referenced by save().

     {
         global $DIC;
 
         $forms = parent::initCreationForms($a_new_type);
         // Add File-Upload
         $in_file = new ilFileInputGUI($DIC->language()->txt("bibliography_file"), "bibliographic_file");
         $in_file->setSuffixes(array("ris", "bib", "bibtex"));
         $in_file->setRequired(true);
         $forms[self::CFORM_NEW]->addItem($in_file);
         $this->ctrl->saveParameterByClass('ilobjrootfoldergui', 'new_type');
         $forms[self::CFORM_NEW]->setFormAction($this->ctrl->getFormActionByClass('ilobjrootfoldergui', "save"));
 
         return $forms;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditCustomForm()

ilObjBibliographicGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Parameters

ilPropertyFormGUI $a_form

Definition at line 443 of file class.ilObjBibliographicGUI.php.

References $DIC, and ilPropertyFormGUI\addItem().

     {
         global $DIC;
 
         $DIC->tabs()->activateTab(self::SUBTAB_SETTINGS);
         // is_online
         $cb = new ilCheckboxInputGUI($DIC->language()->txt("online"), "is_online");
         $a_form->addItem($cb);
     }

Here is the call graph for this function:

◆ initEditForm()

ilObjBibliographicGUI::initEditForm ( )

Definition at line 413 of file class.ilObjBibliographicGUI.php.

References $DIC, $form, ilSubEnabledFormPropertyGUI\addSubItem(), and ilFileInputGUI\setSuffixes().

     {
         global $DIC;
 
         $form = parent::initEditForm();
         // Add File-Upload
         $in_file = new ilFileInputGUI(
             $DIC->language()
                 ->txt("bibliography_file"),
             "bibliographic_file"
         );
         $in_file->setSuffixes(array("ris", "bib", "bibtex"));
         $in_file->setRequired(false);
         $cb_override = new ilCheckboxInputGUI(
             $DIC->language()
                 ->txt("override_entries"),
             "override_entries"
         );
         $cb_override->addSubItem($in_file);
 
         $form->addItem($cb_override);
         $form->setFormAction($DIC->ctrl()->getFormAction($this, "save"));
 
         return $form;
     }

Here is the call graph for this function:

◆ initSubTabs()

ilObjBibliographicGUI::initSubTabs ( )

protected

Definition at line 395 of file class.ilObjBibliographicGUI.php.

References $DIC, and ilBiblFieldFilterGUI\CMD_STANDARD.

Referenced by executeCommand().

     {
         global $DIC;
         $DIC->tabs()->addSubTab(
             self::SUBTAB_SETTINGS,
             $DIC->language()
             ->txt(self::SUBTAB_SETTINGS),
             $this->ctrl->getLinkTarget($this, self::CMD_EDIT_OBJECT)
         );
         $DIC->tabs()->addSubTab(
             self::SUB_TAB_FILTER,
             $DIC->language()
             ->txt("bibl_filter"),
             $this->ctrl->getLinkTargetByClass(ilBiblFieldFilterGUI::class, ilBiblFieldFilterGUI::CMD_STANDARD)
         );
     }

Here is the caller graph for this function:

◆ removeFromDesk()

ilObjBibliographicGUI::removeFromDesk ( )

Remove from desktop.

Alias for removeFromDeskObject.

public

Definition at line 692 of file class.ilObjBibliographicGUI.php.

References ilObjectGUI\afterImport(), and removeFromDeskObject().

     {
         $this->removeFromDeskObject();
     }

Here is the call graph for this function:

◆ removeFromDeskObject()

ilObjBibliographicGUI::removeFromDeskObject ( )

Remove from desktop.

public

Implements ilDesktopItemHandling.

Definition at line 666 of file class.ilObjBibliographicGUI.php.

References $DIC, and ilDesktopItemGUI\removeFromDesktop().

Referenced by removeFromDesk().

     {
         global $DIC;
 
         ilDesktopItemGUI::removeFromDesktop();
         ilUtil::sendSuccess($DIC->language()->txt("removed_from_desktop"), true);
         $this->ctrl->redirect($this, self::CMD_VIEW);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilObjBibliographicGUI::render ( )

Definition at line 467 of file class.ilObjBibliographicGUI.php.

References showContent().

     {
         $this->showContent();
     }

Here is the call graph for this function:

◆ resetFilter()

ilObjBibliographicGUI::resetFilter ( )

protected

Definition at line 524 of file class.ilObjBibliographicGUI.php.

References $table.

     {
         $table = new ilBiblEntryTableGUI($this, $this->facade);
         $table->resetFilter();
         $table->resetOffset();
         $this->ctrl->redirect($this, self::CMD_SHOW_CONTENT);
     }

◆ save()

ilObjBibliographicGUI::save ( )

Definition at line 300 of file class.ilObjBibliographicGUI.php.

References $DIC, $form, addNews(), ilObjectGUI\afterSave(), ilObject\getId(), getType(), initCreationForms(), and ilObject2GUI\setTabs().

     {
         global $DIC;
 
         $form = $this->initCreationForms($this->getType());
         if ($form[self::CFORM_NEW]->checkInput()) {
             parent::save();
         } else {
             $form = $form[self::CFORM_NEW];
             $form->setValuesByPost();
             $DIC->ui()->mainTemplate()->setContent($form->getHtml());
         }
     }

Here is the call graph for this function:

◆ sendFile()

ilObjBibliographicGUI::sendFile ( )

provide file as a download

Definition at line 536 of file class.ilObjBibliographicGUI.php.

References $DIC, ilFileDelivery\deliverFileAttached(), handleNonAccess(), ilUtil\sendFailure(), and showContent().

     {
         global $DIC;
 
         if ($DIC['ilAccess']->checkAccess('read', "", $this->object->getRefId())) {
             $file_path = $this->object->getLegacyAbsolutePath();
             if ($file_path) {
                 if (is_file($file_path)) {
                     ilFileDelivery::deliverFileAttached($file_path, $this->object->getFilename(), 'application/octet-stream');
                 } else {
                     ilUtil::sendFailure($DIC['lng']->txt("file_not_found"));
                     $this->showContent();
                 }
             }
         } else {
             $this->handleNonAccess();
         }
     }

Here is the call graph for this function:

◆ showContent()

ilObjBibliographicGUI::showContent ( )

shows the overview page with all entries in a table

Definition at line 476 of file class.ilObjBibliographicGUI.php.

References $_GET, $DIC, $html, $table, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilLinkButton\getInstance(), handleNonAccess(), and ilUtil\sendFailure().

Referenced by render(), sendFile(), and view().

     {
         global $DIC;
 
         // if user has read permission and object is online OR user has write permissions
         $read_access = $DIC->access()->checkAccess('read', "", $this->object->getRefId());
         $online = $this->object->getOnline();
         $write_access = $DIC->access()->checkAccess('write', "", $this->object->getRefId());
         if (($read_access && $online) || $write_access) {
             $DIC->tabs()->activateTab(self::TAB_CONTENT);
 
             $b = ilLinkButton::getInstance();
             $b->setCaption('download_original_file');
             $b->setUrl($DIC->ctrl()->getLinkTargetByClass(self::class, self::CMD_SEND_FILE));
             $b->setPrimary(true);
             $DIC->toolbar()->addButtonInstance($b);
 
             $table = new ilBiblEntryTableGUI($this, $this->facade);
             $html = $table->getHTML();
             $DIC->ui()->mainTemplate()->setContent($html);
 
             //Permanent Link
             $DIC->ui()->mainTemplate()->setPermanentLink("bibl", $this->object->getRefId());
         } else {
             $object_title = ilObject::_lookupTitle(ilObject::_lookupObjId($_GET["ref_id"]));
             ilUtil::sendFailure(
                 sprintf(
                     $DIC->language()
                         ->txt("msg_no_perm_read_item"),
                     $object_title
                 ),
                 true
             );
             //redirect to repository without any parameters
             $this->handleNonAccess();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showDetails()

ilObjBibliographicGUI::showDetails ( )

Definition at line 556 of file class.ilObjBibliographicGUI.php.

References $DIC, $id, and handleNonAccess().

     {
         global $DIC;
 
         if ($DIC->access()->checkAccess('read', "", $this->object->getRefId())) {
             $id = $DIC->http()->request()->getQueryParams()[self::P_ENTRY_ID];
             $entry = $this->facade->entryFactory()
                 ->findByIdAndTypeString($id, $this->object->getFileTypeAsString());
             $bibGUI = new ilBiblEntryDetailPresentationGUI($entry, $this->facade);
 
             $DIC->ui()->mainTemplate()->setContent($bibGUI->getHTML());
         } else {
             $this->handleNonAccess();
         }
     }

Here is the call graph for this function:

◆ toggleNotification()

ilObjBibliographicGUI::toggleNotification ( )

Definition at line 600 of file class.ilObjBibliographicGUI.php.

References $_GET, $DIC, ilObjectGUI\$obj_id, ilNotification\setNotification(), and ilNotification\TYPE_DATA_COLLECTION.

     {
         global $DIC;
 
         switch ($_GET["ntf"]) {
             case 1:
                 ilNotification::setNotification(
                     ilNotification::TYPE_DATA_COLLECTION,
                     $DIC->user()
                     ->getId(),
                     $this->obj_id,
                     false
                 );
                 break;
             case 2:
                 ilNotification::setNotification(
                     ilNotification::TYPE_DATA_COLLECTION,
                     $DIC->user()
                     ->getId(),
                     $this->obj_id,
                     true
                 );
                 break;
         }
         $DIC->ctrl()->redirect($this, "");
     }

Here is the call graph for this function:

◆ updateCustom()

ilObjBibliographicGUI::updateCustom ( ilPropertyFormGUI $a_form )

updateSettings

Definition at line 582 of file class.ilObjBibliographicGUI.php.

References $DIC, addNews(), ilPropertyFormGUI\getInput(), and handleNonAccess().

     {
         global $DIC;
 
         if ($DIC->access()->checkAccess('write', "", $this->object->getRefId())) {
             if ($this->object->getOnline() != $a_form->getInput("is_online")) {
                 $this->object->setOnline($a_form->getInput("is_online"));
             }
 
             if (!empty($_FILES['bibliographic_file']['name'])) {
                 $this->addNews($this->object->getId(), 'updated');
             }
         } else {
             $this->handleNonAccess();
         }
     }

Here is the call graph for this function:

◆ view()

ilObjBibliographicGUI::view ( )

Definition at line 573 of file class.ilObjBibliographicGUI.php.

References showContent().

     {
         $this->showContent();
     }

Here is the call graph for this function:

Field Documentation

◆ $cmd

ilObjBibliographicGUI::$cmd = self::CMD_SHOW_CONTENT

protected

Definition at line 67 of file class.ilObjBibliographicGUI.php.

Referenced by executeCommand().

◆ $facade

ilObjBibliographicGUI::$facade

protected

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

◆ $field_factory

ilObjBibliographicGUI::$field_factory

protected

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

◆ $filter_factory

ilObjBibliographicGUI::$filter_factory

protected

Definition at line 59 of file class.ilObjBibliographicGUI.php.

◆ $object

ilObjBibliographicGUI::$object

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

◆ $translation_factory

ilObjBibliographicGUI::$translation_factory

protected

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

◆ $type_factory

ilObjBibliographicGUI::$type_factory

protected

Definition at line 63 of file class.ilObjBibliographicGUI.php.

◆ CMD_EDIT

const ilObjBibliographicGUI::CMD_EDIT = "edit"

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

◆ CMD_EDIT_OBJECT

const ilObjBibliographicGUI::CMD_EDIT_OBJECT = 'editObject'

Definition at line 38 of file class.ilObjBibliographicGUI.php.

◆ CMD_SEND_FILE

const ilObjBibliographicGUI::CMD_SEND_FILE = "sendFile"

Definition at line 26 of file class.ilObjBibliographicGUI.php.

◆ CMD_SHOW_CONTENT

const ilObjBibliographicGUI::CMD_SHOW_CONTENT = 'showContent'

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

Referenced by ilBiblEntryDetailPresentationGUI\initTabs().

◆ CMD_SHOW_DETAILS

const ilObjBibliographicGUI::CMD_SHOW_DETAILS = "showDetails"

Definition at line 35 of file class.ilObjBibliographicGUI.php.

◆ CMD_UPDATE_OBJECT

const ilObjBibliographicGUI::CMD_UPDATE_OBJECT = 'updateObject'

Definition at line 39 of file class.ilObjBibliographicGUI.php.

◆ CMD_VIEW

const ilObjBibliographicGUI::CMD_VIEW = "view"

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

◆ P_ENTRY_ID

const ilObjBibliographicGUI::P_ENTRY_ID = 'entry_id'

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

Referenced by ilObjBibliographicAccess\_checkAccess(), _goto(), ilBiblEntryTableGUI\fillRow(), and ilBiblEntryDetailPresentationGUI\getHTML().

◆ SUB_TAB_FILTER

const ilObjBibliographicGUI::SUB_TAB_FILTER = "filter"

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

◆ SUBTAB_SETTINGS

const ilObjBibliographicGUI::SUBTAB_SETTINGS = "settings"

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

◆ TAB_CONTENT

const ilObjBibliographicGUI::TAB_CONTENT = "content"

Definition at line 27 of file class.ilObjBibliographicGUI.php.

◆ TAB_EXPORT

const ilObjBibliographicGUI::TAB_EXPORT = "export"

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

◆ TAB_ID_INFO

const ilObjBibliographicGUI::TAB_ID_INFO = "id_info"

Definition at line 34 of file class.ilObjBibliographicGUI.php.

◆ TAB_ID_PERMISSIONS

const ilObjBibliographicGUI::TAB_ID_PERMISSIONS = "id_permissions"

Definition at line 33 of file class.ilObjBibliographicGUI.php.

◆ TAB_ID_RECORDS

const ilObjBibliographicGUI::TAB_ID_RECORDS = "id_records"

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

◆ TAB_SETTINGS

const ilObjBibliographicGUI::TAB_SETTINGS = self::SUBTAB_SETTINGS

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

Referenced by ilBiblFieldFilterGUI\executeCommand().

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

Modules/Bibliographic/classes/class.ilObjBibliographicGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addLocatorItems()

◆ addNews()

◆ addToDesk()

◆ addToDeskObject()

◆ applyFilter()

◆ executeCommand()

◆ getEditFormCustomValues()

◆ getStandardCmd()

◆ getType()

◆ handleNonAccess()

◆ infoScreen()

◆ infoScreenForward()

◆ initCreationForms()

◆ initEditCustomForm()

◆ initEditForm()

◆ initSubTabs()

◆ removeFromDesk()

◆ removeFromDeskObject()

◆ render()

◆ resetFilter()

◆ save()

◆ sendFile()

◆ showContent()

◆ showDetails()

◆ toggleNotification()

◆ updateCustom()

◆ view()

Field Documentation

◆ $cmd

◆ $facade

◆ $field_factory

◆ $filter_factory

◆ $object

◆ $translation_factory

◆ $type_factory

◆ CMD_EDIT

◆ CMD_EDIT_OBJECT

◆ CMD_SEND_FILE

◆ CMD_SHOW_CONTENT

◆ CMD_SHOW_DETAILS

◆ CMD_UPDATE_OBJECT

◆ CMD_VIEW

◆ P_ENTRY_ID

◆ SUB_TAB_FILTER

◆ SUBTAB_SETTINGS

◆ TAB_CONTENT

◆ TAB_EXPORT

◆ TAB_ID_INFO

◆ TAB_ID_PERMISSIONS

◆ TAB_ID_RECORDS

◆ TAB_SETTINGS