Inheritance diagram for ilObjBibliographicGUI:

Collaboration diagram for ilObjBibliographicGUI:

Public Member Functions
	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...

	addLocatorItems ()

	save ()

	editObject ()
	edit object public More...

	initEditForm ()

	getEditFormCustomValues (array &$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 (int $obj_id, string $change='created')

	addToDesk ()
	Add desktop item. More...

	removeFromDesk ()
	Remove from desktop. More...

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	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 (bool $mode=true)

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	cancelDelete ()

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

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

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

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

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

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

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

	createObject ()
	create new object form More...

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

	saveObject ()

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

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

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

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

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

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Public Member Functions inherited from ilDesktopItemHandling
	addToDeskObject ()
	Add desktop item public. More...

	removeFromDeskObject ()
	Remove from desktop public. More...

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

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

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

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

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'

ilObject	$object = null

Data Fields inherited from ilObject2GUI
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	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	initCreationForms (string $a_new_type)

	afterSave (ilObject $a_new_object)

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

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId (int $ref_id, string $cmd="")

	fillCloneTemplate (?string $tpl_varname, string $type)

	addAdminLocatorItems (bool $do_not_add_object=false)

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

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

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

	initCreationForms (string $new_type)
	Init creation forms. More...

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

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

	getPermanentLinkWidget (string $append=null, bool $center=false)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

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

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

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

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

	omitLocator (bool $omit=true)

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

	initCreationForms (string $new_type)
	Init creation forms. More...

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

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

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

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

	initEditForm ()

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

	getEditFormValues ()

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

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

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

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

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

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

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

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

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $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 ["ref_id"] value of the request More...

	fillCloneTemplate (?string $tpl_name, string $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...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

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

	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilBiblFactoryFacade	$facade = null

ilBiblTranslationFactory	$translation_factory

ilBiblFieldFactory	$field_factory

ilBiblFieldFilterFactory	$filter_factory

ilBiblTypeFactory	$type_factory

	$storage

ilObjBibliographicStakeholder	$stakeholder

string	$cmd = self::CMD_SHOW_CONTENT

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilObjectService	$object_service

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = array()

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Member Functions
	handleNonAccess ()

Detailed Description

Class ilObjBibliographicGUI.

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

Member Function Documentation

◆ _goto()

static ilObjBibliographicGUI::_goto ( string $a_target )

static

_goto Deep link

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

References $DIC, ilObjectGUI\$id, and P_ENTRY_ID.

                                                   : void
     {
         global $DIC;
 
         $id = explode("_", $a_target);
         $DIC->ctrl()->setTargetScript('ilias.php');
         $DIC->ctrl()->setParameterByClass(ilObjBibliographicGUI::class, "ref_id", (int) ($id[0] ?? 1));
         // Detail-View
         if (isset($id[1]) && $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, ilObject2GUI\$node_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

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

Here is the call graph for this function:

◆ addNews()

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

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

References $DIC, getType(), NEWS_NOTICE, and NEWS_USERS.

Referenced by afterSave(), and updateCustom().

                                                                     : void
     {
         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 648 of file class.ilObjBibliographicGUI.php.

References ilDesktopItemHandling\addToDeskObject().

                                : void
     {
         $this->addToDeskObject();
     }

Here is the call graph for this function:

◆ afterSave()

ilObjBibliographicGUI::afterSave ( ilObject $a_new_object )

protected

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

References $DIC, addNews(), ILIAS\Repository\ctrl(), ilObject\getId(), ILIAS\Repository\object(), and ilObject2GUI\setTabs().

                                                         : void
     {
         $this->addNews($a_new_object->getId(), 'created');
         $this->ctrl->redirect($this, self::CMD_EDIT);
     }

Here is the call graph for this function:

◆ applyFilter()

ilObjBibliographicGUI::applyFilter ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ editObject()

ilObjBibliographicGUI::editObject ( )

edit object public

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

References ilObject2GUI\$error, $ilErr, ilObject2GUI\$tabs_gui, ilObject2GUI\$tpl, ilObjectGUI\addExternalEditFormCustom(), ilObject2GUI\checkPermissionBool(), ilObjectGUI\getEditFormValues(), initEditForm(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                                 : void
     {
         $tpl = $this->tpl;
         $ilTabs = $this->tabs_gui;
         $ilErr = $this->error;
 
         if (!$this->checkPermissionBool("write")) {
             $ilErr->raiseError($this->lng->txt("msg_no_perm_write"), $ilErr->MESSAGE);
         }
 
         $ilTabs->activateTab("settings");
 
         $form = $this->initEditForm();
         $values = $this->getEditFormValues();
         if ($values !== []) {
             $form->setValuesByArray($values, true);
         }
 
         $this->addExternalEditFormCustom($form);
 
         $tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjBibliographicGUI::executeCommand ( )

executeCommand

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

References $DIC, ilObjectGUI\addHeaderAction(), ILIAS\Repository\ctrl(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getStandardCmd(), handleNonAccess(), initSubTabs(), ILIAS\Repository\object(), and ilObject2GUI\prepareOutput().

                                     : void
     {
         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(
             'read',
             "",
             $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):
                 $this->prepareOutput();
                 $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']->loadStandardTemplate();
                 $this->ctrl->forwardCommand($cp);
                 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;
         }
     }

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjBibliographicGUI::getEditFormCustomValues ( array & $values )

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

                                                            : void
     {
         $values["is_online"] = $this->object->getOnline();
     }

◆ getStandardCmd()

ilObjBibliographicGUI::getStandardCmd ( )

getStandardCmd

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

Referenced by executeCommand().

                                     : string
     {
         return self::CMD_VIEW;
     }

Here is the caller graph for this function:

◆ getType()

ilObjBibliographicGUI::getType ( )

getType

Deprecated:: REFACTOR use type factory via Facade

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

Referenced by addNews(), and save().

                              : string
     {
         return "bibl";
     }

Here is the caller graph for this function:

◆ handleNonAccess()

ilObjBibliographicGUI::handleNonAccess ( )

private

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

References $DIC, and ilObjectGUI\_gotoRepositoryRoot().

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

                                       : void
     {
         global $DIC;
 
         $this->tpl->setOnScreenMessage('failure', $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 195 of file class.ilObjBibliographicGUI.php.

References $DIC, ilResourceStorageInfoGUI\append(), ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

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

Here is the call graph for this function:

◆ initCreationForms()

ilObjBibliographicGUI::initCreationForms ( string $a_new_type )

protected

Returns: mixed[]

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

References $DIC, ILIAS\Repository\ctrl(), and ilFileInputGUI\setSuffixes().

Referenced by save().

                                                             : array
     {
         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

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

References $DIC, and ilPropertyFormGUI\addItem().

                                                                     : void
     {
         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 420 of file class.ilObjBibliographicGUI.php.

References $DIC, ilSubEnabledFormPropertyGUI\addSubItem(), ILIAS\Repository\lng(), and ilFileInputGUI\setSuffixes().

Referenced by editObject().

                                   : \ilPropertyFormGUI
     {
         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);
 
         $section_appearance = new ilFormSectionHeaderGUI();
         $section_appearance->setTitle($this->lng->txt('cont_presentation'));
         $form->addItem($section_appearance);
         $DIC->object()->commonSettings()->legacyForm($form, $this->object)->addTileImage();
 
         $form->setFormAction($DIC->ctrl()->getFormAction($this, "save"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSubTabs()

ilObjBibliographicGUI::initSubTabs ( )

protected

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

References $DIC, ilBiblFieldFilterGUI\CMD_STANDARD, and ILIAS\Repository\ctrl().

Referenced by executeCommand().

                                     : void
     {
         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 call graph for this function:

Here is the caller graph for this function:

◆ removeFromDesk()

ilObjBibliographicGUI::removeFromDesk ( )

Remove from desktop.

Alias for removeFromDeskObject. public

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

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

                                     : void
     {
         $this->removeFromDeskObject();
     }

Here is the call graph for this function:

◆ render()

ilObjBibliographicGUI::render ( )

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

References showContent().

                             : void
     {
         $this->showContent();
     }

Here is the call graph for this function:

◆ resetFilter()

ilObjBibliographicGUI::resetFilter ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ save()

ilObjBibliographicGUI::save ( )

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

References $DIC, getType(), and initCreationForms().

                           : void
     {
         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 529 of file class.ilObjBibliographicGUI.php.

References $DIC, ilFileDelivery\deliverFileAttached(), handleNonAccess(), ILIAS\Repository\object(), and showContent().

                               : void
     {
         global $DIC;
 
         if ($DIC['ilAccess']->checkAccess('read', "", $this->object->getRefId())) {
             if (!$this->object->isMigrated()) {
                 $file_path = $this->object->getLegacyAbsolutePath();
                 if ($file_path) {
                     if (is_file($file_path)) {
                         ilFileDelivery::deliverFileAttached(
                             $file_path,
                             $this->object->getFilename(),
                             'application/octet-stream'
                         );
                     } else {
                         $this->tpl->setOnScreenMessage('failure', $DIC['lng']->txt("file_not_found"));
                         $this->showContent();
                     }
                 }
             } else {
                 $this->storage->consume()->download($this->object->getResourceId())->run();
             }
         } 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 475 of file class.ilObjBibliographicGUI.php.

References Vendor\Package\$b, $DIC, ilObject2GUI\$html, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilLinkButton\getInstance(), handleNonAccess(), and ILIAS\Repository\object().

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

                                  : void
     {
         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($this->ref_id));
             $this->tpl->setOnScreenMessage('failure', 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, ilObjectGUI\$id, handleNonAccess(), and ILIAS\Repository\object().

                                  : void
     {
         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 599 of file class.ilObjBibliographicGUI.php.

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

                                         : void
     {
         global $DIC;
         $ntf = $DIC->http()->wrapper()->query()->retrieve(
             "ntf",
             $DIC->refinery()->to()->int()
         );
 
         switch ($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 580 of file class.ilObjBibliographicGUI.php.

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

                                                            : void
     {
         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');
             }
 
             $DIC->object()->commonSettings()->legacyForm($a_form, $this->object)->saveTileImage();
         } else {
             $this->handleNonAccess();
         }
     }

Here is the call graph for this function:

◆ view()

ilObjBibliographicGUI::view ( )

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

References showContent().

                           : void
     {
         $this->showContent();
     }

Here is the call graph for this function:

Field Documentation

◆ $cmd

string ilObjBibliographicGUI::$cmd = self::CMD_SHOW_CONTENT

protected

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

◆ $facade

ilBiblFactoryFacade ilObjBibliographicGUI::$facade = null

protected

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

◆ $field_factory

ilBiblFieldFactory ilObjBibliographicGUI::$field_factory

protected

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

◆ $filter_factory

ilBiblFieldFilterFactory ilObjBibliographicGUI::$filter_factory

protected

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

◆ $object

ilObject ilObjBibliographicGUI::$object = null

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

◆ $stakeholder

ilObjBibliographicStakeholder ilObjBibliographicGUI::$stakeholder

protected

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

◆ $storage

ilObjBibliographicGUI::$storage

protected

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

◆ $translation_factory

ilBiblTranslationFactory ilObjBibliographicGUI::$translation_factory

protected

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

◆ $type_factory

ilBiblTypeFactory ilObjBibliographicGUI::$type_factory

protected

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

◆ CMD_EDIT

const ilObjBibliographicGUI::CMD_EDIT = "edit"

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

◆ CMD_EDIT_OBJECT

const ilObjBibliographicGUI::CMD_EDIT_OBJECT = 'editObject'

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

◆ CMD_SEND_FILE

const ilObjBibliographicGUI::CMD_SEND_FILE = "sendFile"

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

◆ CMD_SHOW_CONTENT

const ilObjBibliographicGUI::CMD_SHOW_CONTENT = 'showContent'

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

Referenced by ilBiblEntryDetailPresentationGUI\initTabs().

◆ CMD_SHOW_DETAILS

const ilObjBibliographicGUI::CMD_SHOW_DETAILS = "showDetails"

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

◆ CMD_UPDATE_OBJECT

const ilObjBibliographicGUI::CMD_UPDATE_OBJECT = 'updateObject'

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

◆ CMD_VIEW

const ilObjBibliographicGUI::CMD_VIEW = "view"

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

Referenced by ilBiblEntryTableGUI\__construct().

◆ P_ENTRY_ID

const ilObjBibliographicGUI::P_ENTRY_ID = 'entry_id'

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

Referenced by ilObjBibliographicAccess\_checkAccess(), _goto(), and ilBiblEntryTableGUI\addAndReadFilterItem().

◆ SUB_TAB_FILTER

const ilObjBibliographicGUI::SUB_TAB_FILTER = "filter"

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

◆ SUBTAB_SETTINGS

const ilObjBibliographicGUI::SUBTAB_SETTINGS = "settings"

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

◆ TAB_CONTENT

const ilObjBibliographicGUI::TAB_CONTENT = "content"

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

◆ TAB_EXPORT

const ilObjBibliographicGUI::TAB_EXPORT = "export"

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

◆ TAB_ID_INFO

const ilObjBibliographicGUI::TAB_ID_INFO = "id_info"

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

◆ TAB_ID_PERMISSIONS

const ilObjBibliographicGUI::TAB_ID_PERMISSIONS = "id_permissions"

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

◆ TAB_ID_RECORDS

const ilObjBibliographicGUI::TAB_ID_RECORDS = "id_records"

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

◆ TAB_SETTINGS

const ilObjBibliographicGUI::TAB_SETTINGS = self::SUBTAB_SETTINGS

Definition at line 48 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

Member Function Documentation

◆ _goto()

◆ addLocatorItems()

◆ addNews()

◆ addToDesk()

◆ afterSave()

◆ applyFilter()

◆ editObject()

◆ executeCommand()

◆ getEditFormCustomValues()

◆ getStandardCmd()

◆ getType()

◆ handleNonAccess()

◆ infoScreen()

◆ initCreationForms()

◆ initEditCustomForm()

◆ initEditForm()

◆ initSubTabs()

◆ removeFromDesk()

◆ render()

◆ resetFilter()

◆ save()

◆ sendFile()

◆ showContent()

◆ showDetails()

◆ toggleNotification()

◆ updateCustom()

◆ view()

Field Documentation

◆ $cmd

◆ $facade

◆ $field_factory

◆ $filter_factory

◆ $object

◆ $stakeholder

◆ $storage

◆ $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