Bibliographic Administration Settings. More...

Inheritance diagram for ilObjBibliographicAdminGUI:

Collaboration diagram for ilObjBibliographicAdminGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	ilObjBibliographicAdminGUI constructor. More...

	executeCommand ()

	getTabsGui ()

	setTabsGui ($tabs_gui)

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

Data Fields
const	TAB_FIELDS = 'fields'

const	TAB_SETTINGS = 'settings'

const	CMD_DEFAULT = 'view'

	$object

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

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

	setAdminTabs ()
	set admin tabs @access 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
	$type = 'bibs'

	$facade

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

Additional Inherited Members
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...

Detailed Description

Bibliographic Administration Settings.

Author: Theodor Truffer tt@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

@ilCtrl_Calls ilObjBibliographicAdminGUI: ilPermissionGUI, ilObjBibliographicAdminLibrariesGUI @ilCtrl_Calls ilObjBibliographicAdminGUI: ilBiblAdminFieldGUI @ilCtrl_Calls ilObjBibliographicAdminGUI: ilBiblLibraryGUI @ilCtrl_Calls ilObjBibliographicAdminGUI: ilBiblAdminRisFieldGUI, ilBiblAdminBibtexFieldGUI

Definition at line 16 of file class.ilObjBibliographicAdminGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjBibliographicAdminGUI::__construct	(	$a_data,
		$a_id,
		$a_call_by_reference = `true`,
		$a_prepare_output = `true`
	)

ilObjBibliographicAdminGUI constructor.

Parameters

	$a_data
	$a_id
bool	$a_call_by_reference
bool	$a_prepare_output

Exceptions

ilObjectException

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

    {
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $this->type = 'bibs';
        $this->lng->loadLanguageModule('bibl');
        // Check Permissions globally for all SubGUIs. We check read-permission first
        $this->checkPermission('read');
    }

References ilObjectGUI\checkPermission().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilObjBibliographicAdminGUI::executeCommand ( )

Returns: bool|void$

Exceptions

ilCtrlException

Reimplemented from ilObjectGUI.

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

    {
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case 'ilpermissiongui':
                $this->prepareOutput();
                $this->tabs_gui->activateTab('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case strtolower(ilBiblLibraryGUI::class):
                $this->prepareOutput();
                $this->tabs_gui->activateTab(self::TAB_SETTINGS);
                $f = new ilBiblAdminLibraryFacade($this->object);
                $this->ctrl->forwardCommand(new ilBiblLibraryGUI($f));
                break;
            case strtolower(ilBiblAdminRisFieldGUI::class):
                $this->prepareOutput();
                $this->tabs_gui->activateTab(self::TAB_FIELDS);
                $this->ctrl->forwardCommand(new ilBiblAdminRisFieldGUI(new ilBiblAdminFactoryFacade($this->object, ilBiblTypeFactoryInterface::DATA_TYPE_RIS)));
                break;
            case strtolower(ilBiblAdminBibtexFieldGUI::class):
                $this->prepareOutput();
                $this->tabs_gui->activateTab(self::TAB_FIELDS);
                $this->ctrl->forwardCommand(new ilBiblAdminBibtexFieldGUI(new ilBiblAdminFactoryFacade($this->object, ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX)));
                break;
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_DEFAULT);
                $this->{$cmd}();
                break;
        }
    }

References $f, ilBiblTypeFactoryInterface\DATA_TYPE_BIBTEX, ilBiblTypeFactoryInterface\DATA_TYPE_RIS, and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getTabsGui()

ilObjBibliographicAdminGUI::getTabsGui ( )

Returns: \ilTabsGUI

Definition at line 128 of file class.ilObjBibliographicAdminGUI.php.

    {
        return $this->tabs_gui;
    }

References ilObjectGUI\$tabs_gui.

◆ setTabsGui()

ilObjBibliographicAdminGUI::setTabsGui ( $tabs_gui )

Parameters

\ilTabsGUI $tabs_gui

Definition at line 137 of file class.ilObjBibliographicAdminGUI.php.

    {
        $this->tabs_gui = $tabs_gui;
    }

References ilObjectGUI\$tabs_gui.

◆ view()

ilObjBibliographicAdminGUI::view ( )

protected

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

    {
        $this->ctrl->redirectByClass(ilBiblAdminRisFieldGUI::class);
    }

Field Documentation

◆ $facade

ilObjBibliographicAdminGUI::$facade

protected

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

◆ $object

ilObjBibliographicAdminGUI::$object

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

◆ $type

ilObjBibliographicAdminGUI::$type = 'bibs'

protected

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

◆ CMD_DEFAULT

const ilObjBibliographicAdminGUI::CMD_DEFAULT = 'view'

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

◆ TAB_FIELDS

const ilObjBibliographicAdminGUI::TAB_FIELDS = 'fields'

Definition at line 18 of file class.ilObjBibliographicAdminGUI.php.

Referenced by ilBiblAdminFieldGUI\executeCommand().

◆ TAB_SETTINGS

const ilObjBibliographicAdminGUI::TAB_SETTINGS = 'settings'

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

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

Modules/Bibliographic/classes/class.ilObjBibliographicAdminGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ getTabsGui()

◆ setTabsGui()

◆ view()

Field Documentation

◆ $facade

◆ $object

◆ $type

◆ CMD_DEFAULT

◆ TAB_FIELDS

◆ TAB_SETTINGS