ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjBibliographicGUI Class Reference

Class ilObjBibliographicGUI. More...

+ 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 ()
 Functions to be overwritten. More...
 
 save ()
 
 initEditForm ()
 Init object edit form. More...
 
 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 ()
 view object content (repository/workspace switch) More...
 
 updateCustom (ilPropertyFormGUI $a_form)
 updateSettings More...
 
 toggleNotification ()
 
 addNews ($obj_id, $change='created')
 
 addToDeskObject ()
 Add desktop item @access public. More...
 
 removeFromDeskObject ()
 Remove from desktop @access public. 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)
 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...
 
 isVisible ()
 
 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...
 
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor @access public. More...
 
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...
 
 getAdminTabs (&$tabs_gui)
 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 ($in_rep=false)
 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...
 
 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...
 
 addToDeskObject ()
 Add desktop item @access public. More...
 
 removeFromDeskObject ()
 Remove from desktop @access public. 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'
 
- 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
 
 $ilias
 
 $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)
 
 afterSave (ilObjBibliographic $a_new_object)
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 
- 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...
 
 prepareOutput ()
 prepare output More...
 
 setTitleAndDescription ()
 called by prepare output More...
 
 showUpperIcon ()
 
 omitLocator ($a_omit=true)
 
 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...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 setColumnSettings ($column_gui)
 May be overwritten in subclasses. More...
 
 checkPermission ($a_perm, $a_cmd="")
 
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu) More...
 
 redirectToRefId ()
 
 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...
 
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 
 searchCloneSource ()
 
 buildCloneSelect ($existing_objs)
 
 addAdminLocatorItems ()
 
 setTabs ()
 create tabs (repository/workspace switch) More...
 
 getReturnLocation ()
 Deprecated functions. More...
 
 setReturnLocation ()
 
 showActions ()
 
 getTitlesByRefId ()
 
 getTabs ()
 
 __showButton ()
 
 hitsperpageObject ()
 
 __initTableGUI ()
 
 __setTableGUIBasicData ()
 
 addLocatorItems ()
 Functions to be overwritten. More...
 
 initCreationForms ($a_new_type)
 Init creation froms. More...
 
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position. 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)
 Activate rating automatically if parent container setting. More...
 
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 
 prepareOutput ()
 prepare output More...
 
 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...
 
 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...
 
 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...
 
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste More...
 
 getTabs (&$tabs_gui)
 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 ($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

 $bibl_obj
 
- Protected Attributes inherited from ilObject2GUI
 $object_id
 
 $node_id
 
 $creation_forms = array()
 
 $id_type = array()
 
 $parent_id
 
 $access_handler
 
- Protected Attributes inherited from ilObjectGUI
 $tmp_import_dir
 

Detailed Description

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

Reimplemented from ilObject2GUI.

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

41 {
42 global $lng, $ilias;
43 $this->lng = $lng;
44 $this->ilias = $ilias;
45 parent::__construct($a_id, $a_id_type, $a_parent_node_id);
46 $lng->loadLanguageModule('bibl');
47 if ($a_id > 0) {
48 $this->bibl_obj = $this->object;
49 }
50 }
redirection script todo: (a better solution should control the processing via a xml file)

References ilObjectGUI\$ilias, ilObjectGUI\$lng, and ilObjectGUI\$object.

Member Function Documentation

◆ _goto()

static ilObjBibliographicGUI::_goto (   $a_target)
static

_goto Deep link

Parameters
string$a_target

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

180 {
181 global $ilAccess, $ilErr, $ilCtrl;
182 $id = explode("_", $a_target);
183 $ilCtrl->setTargetScript("ilias.php");
184 $ilCtrl->initBaseClass("ilRepositoryGUI");
185 $ilCtrl->setParameterByClass("ilobjbibliographicgui", "ref_id", $id[0]);
186 //Detail-View
187 if ($id[1]) {
188 $ilCtrl->setParameterByClass("ilobjbibliographicgui", ilObjBibliographicGUI::P_ENTRY_ID, $id[1]);
189 $ilCtrl->redirectByClass(array( "ilRepositoryGUI", "ilobjbibliographicgui" ), "showDetails");
190 } else {
191 $ilCtrl->redirectByClass(array( "ilRepositoryGUI", "ilobjbibliographicgui" ), "view");
192 }
193 }
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl, $ilErr, and P_ENTRY_ID.

◆ addLocatorItems()

ilObjBibliographicGUI::addLocatorItems ( )

Functions to be overwritten.

Reimplemented from ilObject2GUI.

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

166 {
167 global $ilLocator;
168 if (is_object($this->object)) {
169 $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
170 }
171 }

◆ addNews()

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

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

433 {
434 global $lng, $ilUser;
435
436 $ilNewsItem = new ilNewsItem();
437 $ilNewsItem->setTitle($lng->txt('news_title_' . $change));
438 $ilNewsItem->setPriority(NEWS_NOTICE);
439 $ilNewsItem->setContext($obj_id, $this->getType());
440 $ilNewsItem->setUserId($ilUser->getId());
441 $ilNewsItem->setVisibility(NEWS_USERS);
442 $ilNewsItem->setContentTextIsLangVar(false);
443 $ilNewsItem->create();
444 }
const NEWS_USERS
const NEWS_NOTICE
global $ilUser
Definition: imgupload.php:15

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

Referenced by afterSave(), and updateCustom().

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

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

472 {
473 $this->addToDeskObject();
474 }
addToDeskObject()
Add desktop item @access public.

References addToDeskObject().

+ Here is the call graph for this function:

◆ addToDeskObject()

ilObjBibliographicGUI::addToDeskObject ( )

Add desktop item @access public.

Implements ilDesktopItemHandling.

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

450 {
451 include_once './Services/PersonalDesktop/classes/class.ilDesktopItemGUI.php';
453 ilUtil::sendSuccess($this->lng->txt("added_to_desktop"), true);
454 $this->ctrl->redirect($this, 'view');
455 }
static addToDesktop()
Add desktop item @access public.
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.

References ilDesktopItemGUI\addToDesktop(), and ilUtil\sendSuccess().

Referenced by addToDesk().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ afterSave()

ilObjBibliographicGUI::afterSave ( ilObjBibliographic  $a_new_object)
protected
Parameters
ilObjBibliographic$a_new_object

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

232 {
233 $a_new_object->doUpdate();
234 $this->addNews($a_new_object->getId(), 'created');
235 $this->ctrl->redirect($this, "edit");
236 }
addNews($obj_id, $change='created')
getId()
get object id @access public

References addNews(), ilObjBibliographic\doUpdate(), and ilObject2\getId().

+ Here is the call graph for this function:

◆ executeCommand()

ilObjBibliographicGUI::executeCommand ( )

executeCommand

Reimplemented from ilObject2GUI.

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

76 {
77 global $ilCtrl, $ilTabs, $ilNavigationHistory, $tpl, $lng;
78 // Navigation History
79 $link = $ilCtrl->getLinkTarget($this, $this->getStandardCmd());
80 if ($this->object != NULL) {
81 $ilNavigationHistory->addItem($this->object->getRefId(), $link, "bibl");
82 $this->addHeaderAction();
83 }
84 $next_class = $ilCtrl->getNextClass($this);
85 $this->cmd = $ilCtrl->getCmd();
86 switch ($next_class) {
87 case "ilinfoscreengui":
88 $this->prepareOutput();
89 $ilTabs->activateTab("id_info");
90 $this->infoScreenForward();
91 break;
92 case "ilcommonactiondispatchergui":
93 include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
95 $this->ctrl->forwardCommand($gui);
96 break;
97 case "ilpermissiongui":
98 $this->prepareOutput();
99 $ilTabs->activateTab("id_permissions");
100 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
101 $perm_gui = new ilPermissionGUI($this);
102 $this->ctrl->forwardCommand($perm_gui);
103 break;
104 case "ilobjectcopygui":
105 include_once "./Services/Object/classes/class.ilObjectCopyGUI.php";
106 $cp = new ilObjectCopyGUI($this);
107 $cp->setType('bibl');
108 $tpl->getStandardTemplate();
109 $this->ctrl->forwardCommand($cp);
110 break;
111 case "ilobjfilegui":
112 $this->prepareOutput();
113 $ilTabs->setTabActive("id_records");
114 include_once("./Modules/File/classes/class.ilObjFile.php");
115 $file_gui = new ilObjFile($this);
116 $this->ctrl->forwardCommand($file_gui);
117 break;
118 case "ilexportgui":
119 $this->prepareOutput();
120 $ilTabs->setTabActive("export");
121 $exp_gui = new ilExportGUI($this);
122 $exp_gui->addFormat("xml");
123 $this->ctrl->forwardCommand($exp_gui);
124 break;
125 default:
126 return parent::executeCommand();
127 }
128
129 return true;
130 }
static getInstanceFromAjaxCall()
(Re-)Build instance from ajax call
Export User Interface Class.
infoScreenForward()
show information screen
Class ilObjFile.
prepareOutput()
prepare output
GUI class for the workflow of copying objects.
addHeaderAction()
Add header action menu.
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.

References $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjectGUI\addHeaderAction(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getStandardCmd(), infoScreenForward(), and ilObject2GUI\prepareOutput().

+ Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjBibliographicGUI::getEditFormCustomValues ( array &  $a_values)
Parameters
array$a_values
Returns
array|void

Reimplemented from ilObjectGUI.

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

310 {
311 $a_values["is_online"] = $this->object->getOnline();
312
313 return $a_values;
314 }

◆ getStandardCmd()

ilObjBibliographicGUI::getStandardCmd ( )

getStandardCmd

Returns
String

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

58 {
59 return "view";
60 }

Referenced by executeCommand().

+ Here is the caller graph for this function:

◆ getType()

ilObjBibliographicGUI::getType ( )

getType

Returns
String

Reimplemented from ilObject2GUI.

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

68 {
69 return "bibl";
70 }

Referenced by addNews(), and save().

+ 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 138 of file class.ilObjBibliographicGUI.php.

138 {
139 $this->ctrl->setCmd("showSummary");
140 $this->ctrl->setCmdClass("ilinfoscreengui");
141 $this->infoScreenForward();
142 }

References infoScreenForward().

+ Here is the call graph for this function:

◆ infoScreenForward()

ilObjBibliographicGUI::infoScreenForward ( )

show information screen

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

148 {
149 global $ilTabs, $ilErr, $lng;
150 if (! $this->checkPermissionBool("visible")) {
151 ilUtil::sendFailure($lng->txt("msg_no_perm_read"), true);
152 $this->ctrl->redirectByClass('ilPersonalDesktopGUI', '');
153 }
154 $ilTabs->activateTab("id_info");
155 include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
156 $info = new ilInfoScreenGUI($this);
157 $info->enablePrivateNotes();
158 $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
159 $this->ctrl->forwardCommand($info);
160 }
Class ilInfoScreenGUI.
checkPermissionBool($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
Check permission.
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
$info
Definition: example_052.php:80

References $ilErr, $info, ilObjectGUI\$lng, ilObject2GUI\checkPermissionBool(), and ilUtil\sendFailure().

Referenced by executeCommand(), and infoScreen().

+ 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

Reimplemented from ilObject2GUI.

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

201 {
202 global $lng;
203 $forms = parent::initCreationForms($a_new_type);
204 // Add File-Upload
205 $in_file = new ilFileInputGUI($lng->txt("bibliography file"), "bibliographic_file");
206 $in_file->setSuffixes(array( "ris", "bib", "bibtex" ));
207 $in_file->setRequired(true);
208 $forms[self::CFORM_NEW]->addItem($in_file);
209 $this->ctrl->saveParameterByClass('ilobjrootfoldergui', 'new_type');
210 $forms[self::CFORM_NEW]->setFormAction($this->ctrl->getFormActionByClass('ilobjrootfoldergui', "save"));
211
212 return $forms;
213 }
This class represents a file property in a property form.

References ilObjectGUI\$lng, and ilObjectGUI\CFORM_NEW.

Referenced by save().

+ Here is the caller graph for this function:

◆ initEditCustomForm()

ilObjBibliographicGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected
Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

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

296 {
297 global $ilTabs;
298 $ilTabs->activateTab("settings");
299 // is_online
300 $cb = new ilCheckboxInputGUI($this->lng->txt("online"), "is_online");
301 $a_form->addItem($cb);
302 }
This class represents a checkbox property in a property form.
addItem($a_item)
Add Item (Property, SectionHeader).

References ilPropertyFormGUI\addItem().

+ Here is the call graph for this function:

◆ initEditForm()

ilObjBibliographicGUI::initEditForm ( )

Init object edit form.

Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

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

277 {
278 global $lng;
279 $form = parent::initEditForm();
280 // Add File-Upload
281 $in_file = new ilFileInputGUI($lng->txt("bibliography file"), "bibliographic_file");
282 $in_file->setSuffixes(array( "ris", "bib", "bibtex" ));
283 $in_file->setRequired(false);
284 $cb_override = new ilCheckboxInputGUI($this->lng->txt("override_entries"), "override_entries");
285 $cb_override->addSubItem($in_file);
286 $form->addItem($cb_override);
287 $form->setFormAction($this->ctrl->getFormAction($this, "save"));
288
289 return $form;
290 }

References ilObjectGUI\$lng.

◆ removeFromDesk()

ilObjBibliographicGUI::removeFromDesk ( )

Remove from desktop.

Alias for removeFromDeskObject. @access public

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

480 {
481 $this->removeFromDeskObject();
482 }
removeFromDeskObject()
Remove from desktop @access public.

References removeFromDeskObject().

+ Here is the call graph for this function:

◆ removeFromDeskObject()

ilObjBibliographicGUI::removeFromDeskObject ( )

Remove from desktop @access public.

Implements ilDesktopItemHandling.

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

461 {
462 include_once './Services/PersonalDesktop/classes/class.ilDesktopItemGUI.php';
464 ilUtil::sendSuccess($this->lng->txt("removed_from_desktop"), true);
465 $this->ctrl->redirect($this, 'view');
466 }
static removeFromDesktop()
Remove item from personal desktop @access public.

References ilDesktopItemGUI\removeFromDesktop(), and ilUtil\sendSuccess().

Referenced by removeFromDesk().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ render()

ilObjBibliographicGUI::render ( )

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

319 {
320 $this->showContent();
321 }
showContent()
shows the overview page with all entries in a table

References showContent().

+ Here is the call graph for this function:

◆ save()

ilObjBibliographicGUI::save ( )

Reimplemented from ilObject2GUI.

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

216 {
217 global $tpl;
218 $form = $this->initCreationForms($this->getType());
219 if ($form[self::CFORM_NEW]->checkInput()) {
220 parent::save();
221 } else {
222 $form = $form[self::CFORM_NEW];
223 $form->setValuesByPost();
224 $tpl->setContent($form->getHtml());
225 }
226 }

References ilObjectGUI\$tpl, ilObjectGUI\CFORM_NEW, getType(), and initCreationForms().

+ Here is the call graph for this function:

◆ sendFile()

ilObjBibliographicGUI::sendFile ( )

provide file as a download

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

356 {
357 global $ilAccess, $tpl, $lng;
358 if ($ilAccess->checkAccess('read', "", $this->object->getRefId())) {
359 $file_path = $this->bibl_obj->getFileAbsolutePath();
360 if ($file_path) {
361 if (is_file($file_path)) {
362 $path_array = explode(DIRECTORY_SEPARATOR, $file_path);
363 $filename = $path_array[sizeof($path_array) - 1];
364 require_once('./Services/FileDelivery/classes/class.ilFileDelivery.php');
365 ilFileDelivery::deliverFileAttached($file_path, null, 'application/octet-stream');
366// ilUtil::deliverFile($file_path, $filename);
367 } else {
368 ilUtil::sendFailure($lng->txt("file_not_found"));
369 $this->showContent($this->bibl_obj);
370 }
371 }
372 } else {
373 ilUtil::sendFailure($this->lng->txt("no_permission"), true);
375 }
376 }
$filename
Definition: buildRTE.php:89
static deliverFileAttached($path_to_file, $download_file_name=null, $mime_type=null)
static _gotoRepositoryRoot($a_raise_error=false)
Goto repository root.

References $filename, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjectGUI\_gotoRepositoryRoot(), ilFileDelivery\deliverFileAttached(), ilUtil\sendFailure(), and showContent().

+ Here is the call graph for this function:

◆ showContent()

ilObjBibliographicGUI::showContent ( )

shows the overview page with all entries in a table

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

327 {
328 global $ilAccess, $tpl, $lng, $ilToolbar, $ilCtrl, $ilTabs;
329 // if user has read permission and object is online OR user has write permissions
330 if (($ilAccess->checkAccess('read', "", $this->object->getRefId()) && $this->object->getOnline())
331 || $ilAccess->checkAccess('write', "", $this->object->getRefId())
332 ) {
333 $ilTabs->setTabActive("content");
334 include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
335 $ilToolbar = new ilToolbarGUI();
336 $ilToolbar->addButton($lng->txt("download_original_file"), $ilCtrl->getLinkTargetByClass("ilBibliographicDetailsGUI", "sendFile"));
337 include_once "./Modules/Bibliographic/classes/class.ilBibliographicRecordListTableGUI.php";
338 $table = new ilDataBibliographicRecordListTableGUI($this, $this->cmd);
339 $html = $table->getHTML();
340 $tpl->setContent($html);
341 //Permanent Link
342 $tpl->setPermanentLink("bibl", $this->object->getRefId());
343 } else {
344 $object_title = ilObject::_lookupTitle(ilObject::_lookupObjId($_GET["ref_id"]));
345 ilUtil::sendFailure(sprintf($this->lng->txt("msg_no_perm_read_item"), $object_title), true);
346 //redirect to repository without any parameters
347 unset($_GET);
349 }
350 }
$_GET["client_id"]
static _lookupObjId($a_id)
static _lookupTitle($a_id)
lookup object title
$html
Definition: example_001.php:87

References $_GET, $html, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilUtil\sendFailure().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ showDetails()

ilObjBibliographicGUI::showDetails ( )

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

379 {
380 global $ilAccess, $tpl, $lng;
381 if ($ilAccess->checkAccess('read', "", $this->object->getRefId())) {
382 $bibGUI = ilBibliographicDetailsGUI::getInstance($this->bibl_obj, $_GET[self::P_ENTRY_ID]);
383 $this->tpl->setContent($bibGUI->getHTML());
384 } else {
385 ilUtil::sendFailure($this->lng->txt("no_permission"), true);
387 }
388 }
static getInstance(ilObjBibliographic $bibl_obj, $entry_id)

References $_GET, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjectGUI\_gotoRepositoryRoot(), ilBibliographicDetailsGUI\getInstance(), and ilUtil\sendFailure().

+ Here is the call graph for this function:

◆ toggleNotification()

ilObjBibliographicGUI::toggleNotification ( )

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

416 {
417 global $ilCtrl, $ilUser;
418 include_once "./Services/Notification/classes/class.ilNotification.php";
419 switch ($_GET["ntf"]) {
420 case 1:
422 break;
423 case 2:
425 break;
426 }
427 $ilCtrl->redirect($this, "");
428 }
static setNotification($type, $user_id, $id, $status=true)
Set notification status for object and user.

References $_GET, $ilCtrl, $ilUser, ilNotification\setNotification(), and ilNotification\TYPE_DATA_COLLECTION.

+ Here is the call graph for this function:

◆ updateCustom()

ilObjBibliographicGUI::updateCustom ( ilPropertyFormGUI  $a_form)

updateSettings

Reimplemented from ilObjectGUI.

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

399 {
400 global $ilAccess;
401 if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
402 if ($this->object->getOnline() != $a_form->getInput("is_online")) {
403 $this->object->setOnline($a_form->getInput("is_online"));
404 }
405
406 if (! empty($_FILES['bibliographic_file']['name'])) {
407 $this->addNews($this->bibl_obj->getId(), 'updated');
408 }
409
410 } else {
411 ilUtil::sendFailure($this->lng->txt("no_permission"), true);
413 }
414 }
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.

References ilObjectGUI\_gotoRepositoryRoot(), addNews(), ilPropertyFormGUI\getInput(), and ilUtil\sendFailure().

+ Here is the call graph for this function:

◆ view()

ilObjBibliographicGUI::view ( )

view object content (repository/workspace switch)

Reimplemented from ilObject2GUI.

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

391 {
392 $this->showContent();
393 }

References showContent().

+ Here is the call graph for this function:

Field Documentation

◆ $bibl_obj

ilObjBibliographicGUI::$bibl_obj
protected

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

◆ P_ENTRY_ID

const ilObjBibliographicGUI::P_ENTRY_ID = 'entry_id'

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