ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilObjDataCollectionGUI Class Reference

Class ilObjDataCollectionGUI. More...

+ Inheritance diagram for ilObjDataCollectionGUI:
+ Collaboration diagram for ilObjDataCollectionGUI:

Public Member Functions

 getStandardCmd ()
 getType ()
 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
 render ()
 show Content; redirect to ilDataCollectionRecordListGUI::listRecords
 infoScreenForward ()
 show information screen
 addLocatorItems ()
 Functions to be overwritten.
 setTabs ()
 setTabs create tabs (repository/workspace switch)
 addListFieldsTabs ($a_active)
 listRecords ()
 getDataCollectionObject ()
 getEditFormCustomValues (array &$a_values)
 updateCustom (ilPropertyFormGUI $a_form)
 toggleNotification ()
 addHeaderAction ($a_redraw=false)
- Public Member Functions inherited from ilObject2GUI
 __construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
 Constructor.
executeCommand ()
 execute command
 delete ()
 Display delete confirmation form (repository/workspace switch)
 confirmedDelete ()
 Delete objects (repository/workspace switch)
 getHTML ()
 withReferences ()
 Final/Private declaration of unchanged parent methods.
 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
 getCreationMode ()
 get creation mode
 isVisible ()
 trash ()
 undelete ()
 cancelDelete ()
 removeFromSystem ()
 cloneAll ()
 view ()
 view object content (repository/workspace switch)
 create ()
 Deleted in ilObject.
 save ()
 edit ()
 update ()
 cancel ()
 importFile ()
 Import.
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 createObject ()
 create new object form
 cancelCreation ()
 cancel create action and go back to repository parent
 saveObject ()
 save object
 editObject ()
 edit object
 updateObject ()
 updates object entry in object_data
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 isVisible ($a_ref_id, $a_type)
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.

Static Public Member Functions

static _goto ($a_target)
- Static Public Member Functions inherited from ilObject2GUI
static handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
 After creation callback.
- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root.
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root.

Data Fields

const GET_DCL_GTR = "dcl_gtr"
const GET_REF_ID = "ref_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 (ilObject $a_new_object)
 initEditCustomForm (ilPropertyFormGUI $a_form)
- Protected Member Functions inherited from ilObject2GUI
 afterConstructor ()
 Do anything that should be done after constructor in here.
 assignObject ()
 create object instance as internal property (repository/workspace switch)
 getAccessHandler ()
 Get access handler.
 setLocator ()
 set Locator
 deleteConfirmation ()
 Display delete confirmation form (workspace specific)
 deleteConfirmedObjects ()
 Delete objects (workspace specific)
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 omitLocator ($a_omit=true)
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g.
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 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.
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 searchCloneSource ()
 buildCloneSelect ($existing_objs)
 addAdminLocatorItems ()
 getReturnLocation ()
 Deprecated functions.
 setReturnLocation ()
 showActions ()
 getTitlesByRefId ()
 getTabs ()
 __showButton ()
 hitsperpageObject ()
 __initTableGUI ()
 __setTableGUIBasicData ()
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position.
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
 Check permission.
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu.
 redrawHeaderAction ()
 Updating icons after ajax call.
 getPermanentLinkWidget ($a_append=null, $a_center=false)
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting.
- Protected Member Functions inherited from ilObjectGUI
 insertHeaderAction ($a_list_gui)
 Insert header action into main template.
 addHeaderAction ()
 Add header action menu.
 redrawHeaderActionObject ()
 Ajax call: redraw action header only.
 showMountWebfolderIcon ()
 setAdminTabs ()
 set admin tabs public
 addAdminLocatorItems ($a_do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded)
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion)
 initCreateForm ($a_new_type)
 Init object creation form.
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 initEditForm ()
 Init object edit form.
 getEditFormValues ()
 Get values for edit form.
 validateCustom (ilPropertyFormGUI $a_form)
 Validate custom values (if not possible with checkInput())
 afterUpdate ()
 Post (successful) object update hook.
 initImportForm ($a_new_type)
 Init object import form.
 importFileObject ($parent_id=null)
 Import.
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook.
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g.
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 getTabs (&$tabs_gui)
 get tabs abstract method.
 __showButton ($a_cmd, $a_text, $a_target= '')
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table
 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
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error.
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files.

Private Member Functions

 emptyInfo ()

Additional Inherited Members

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

Detailed Description

Member Function Documentation

static ilObjDataCollectionGUI::_goto (   $a_target)
static
Parameters
$a_target

Definition at line 345 of file class.ilObjDataCollectionGUI.php.

References $_GET, exit, GET_DCL_GTR, and GET_REF_ID.

{
$id = explode("_", $a_target);
$_GET["baseClass"] = "ilRepositoryGUI";
$_GET[self::GET_DCL_GTR] = $id[1]; //recordID
$_GET["cmd"] = "listRecords";
require_once('./ilias.php');
}
ilObjDataCollectionGUI::addHeaderAction (   $a_redraw = false)
Parameters
bool$a_redraw
Returns
string|void

Definition at line 541 of file class.ilObjDataCollectionGUI.php.

References $ilCtrl, $ilUser, ilObjectGUI\$lng, ilObjectGUI\$obj_id, ilObjectGUI\$tpl, ilUtil\getImagePath(), ilNotification\hasNotification(), ilNotification\TYPE_DATA_COLLECTION, and ilCommonActionDispatcherGUI\TYPE_REPOSITORY.

{
global $ilUser, $ilAccess, $tpl, $lng, $ilCtrl;
require_once('./Services/Object/classes/class.ilCommonActionDispatcherGUI.php');
$dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY, $ilAccess, "dcl", $this->ref_id, $this->obj_id);
require_once('./Services/Object/classes/class.ilObjectListGUI.php');
ilObjectListGUI::prepareJSLinks($this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true), $ilCtrl->getLinkTargetByClass(array(
"ilcommonactiondispatchergui",
"ilnotegui"
), "", "", true, false), $ilCtrl->getLinkTargetByClass(array( "ilcommonactiondispatchergui", "iltagginggui" ), "", "", true, false));
$lg = $dispatcher->initHeaderAction();
//$lg->enableNotes(true);
//$lg->enableComments(ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()), false);
// notification
if ($ilUser->getId() != ANONYMOUS_USER_ID AND $this->object->getNotification() == 1) {
require_once('./Services/Notification/classes/class.ilNotification.php');
//Command Activate Notification
$ilCtrl->setParameter($this, "ntf", 1);
$lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_deactivate_dcl");
$lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_on.svg"), $lng->txt("dcl_notification_activated"));
} else {
//Command Deactivate Notification
$ilCtrl->setParameter($this, "ntf", 2);
$lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_activate_dcl");
$lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_off.svg"), $lng->txt("dcl_notification_deactivated"));
}
$ilCtrl->setParameter($this, "ntf", "");
}
if (!$a_redraw) {
$tpl->setHeaderActionMenu($lg->getHeaderAction());
} else {
return $lg->getHeaderAction();
}
$tpl->setHeaderActionMenu($lg->getHeaderAction());
}

+ Here is the call graph for this function:

ilObjDataCollectionGUI::addListFieldsTabs (   $a_active)
Parameters
$a_active

Definition at line 424 of file class.ilObjDataCollectionGUI.php.

References $ilCtrl, and ilObjectGUI\$lng.

{
global $ilTabs, $ilCtrl, $lng;
$ilTabs->addSubTab("list_fields", $lng->txt("dcl_list_fields"), $ilCtrl->getLinkTargetByClass("ildatacollectionfieldlistgui", "listFields"));
$ilCtrl->setParameterByClass("ildatacollectionrecordviewviewdefinitiongui", "table_id", $this->table_id);
$ilTabs->addSubTab("view_viewdefinition", $lng->txt("dcl_record_view_viewdefinition"), $ilCtrl->getLinkTargetByClass("ildatacollectionrecordviewviewdefinitiongui", "edit"));
$ilTabs->activateSubTab($a_active);
}
ilObjDataCollectionGUI::addLocatorItems ( )

Functions to be overwritten.

Reimplemented from ilObject2GUI.

Definition at line 333 of file class.ilObjDataCollectionGUI.php.

References ilObject2GUI\$node_id.

{
global $ilLocator;
if (is_object($this->object)) {
$ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
}
}
ilObjDataCollectionGUI::afterSave ( ilObject  $a_new_object)
protected
Parameters
ilObject$a_new_object

Reimplemented from ilObjectGUI.

Definition at line 372 of file class.ilObjDataCollectionGUI.php.

References ilUtil\sendSuccess().

{
ilUtil::sendSuccess($this->lng->txt("object_added"), true);
$this->ctrl->redirectByClass("ilDataCollectionFieldListGUI", "listFields");
}

+ Here is the call graph for this function:

ilObjDataCollectionGUI::emptyInfo ( )
private

Definition at line 507 of file class.ilObjDataCollectionGUI.php.

References ilObjectGUI\$lng, ilDataCollectionCache\getTableCache(), and ilUtil\sendInfo().

Referenced by updateCustom().

{
global $lng;
$this->table = ilDataCollectionCache::getTableCache($this->object->getMainTableId());
$tables = $this->object->getTables();
if (count($tables) == 1 AND count($this->table->getRecordFields()) == 0 AND count($this->table->getRecords()) == 0
AND $this->object->getOnline()
) {
ilUtil::sendInfo($lng->txt("dcl_no_content_warning"), true);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjDataCollectionGUI::getDataCollectionObject ( )
Returns
ilObjDataCollection

Definition at line 469 of file class.ilObjDataCollectionGUI.php.

{
$obj = new ilObjDataCollection($this->ref_id, true);
return $obj;
}
ilObjDataCollectionGUI::getEditFormCustomValues ( array &  $a_values)
Parameters
array$a_values
Returns
array|void

Reimplemented from ilObjectGUI.

Definition at line 481 of file class.ilObjDataCollectionGUI.php.

{
$a_values["is_online"] = $this->object->getOnline();
$a_values["rating"] = $this->object->getRating();
$a_values["public_notes"] = $this->object->getPublicNotes();
$a_values["approval"] = $this->object->getApproval();
$a_values["notification"] = $this->object->getNotification();
return $a_values;
}
ilObjDataCollectionGUI::getStandardCmd ( )
Returns
string

Definition at line 89 of file class.ilObjDataCollectionGUI.php.

{
return "render";
}
ilObjDataCollectionGUI::getType ( )
Returns
string

Reimplemented from ilObject2GUI.

Definition at line 97 of file class.ilObjDataCollectionGUI.php.

{
return "dcl";
}
ilObjDataCollectionGUI::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 295 of file class.ilObjDataCollectionGUI.php.

References infoScreenForward().

{
$this->ctrl->setCmd("showSummary");
$this->ctrl->setCmdClass("ilinfoscreengui");
}

+ Here is the call graph for this function:

ilObjDataCollectionGUI::infoScreenForward ( )

show information screen

Definition at line 315 of file class.ilObjDataCollectionGUI.php.

References $ilErr, and ilObject2GUI\checkPermissionBool().

Referenced by infoScreen().

{
global $ilTabs, $ilErr;
$ilTabs->activateTab("id_info");
if (!$this->checkPermissionBool("visible")) {
$ilErr->raiseError($this->lng->txt("msg_no_perm_read"));
}
require_once('./Services/InfoScreen/classes/class.ilInfoScreenGUI.php');
$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:

ilObjDataCollectionGUI::initCreationForms (   $a_new_type)
protected
Parameters
string$a_new_type
Returns
array

Reimplemented from ilObject2GUI.

Definition at line 362 of file class.ilObjDataCollectionGUI.php.

{
$forms = parent::initCreationForms($a_new_type);
return $forms;
}
ilObjDataCollectionGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected
Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

Definition at line 439 of file class.ilObjDataCollectionGUI.php.

References $ilCtrl, $ilErr, ilPropertyFormGUI\addItem(), and ilFormPropertyGUI\setInfo().

{
global $ilCtrl, $ilErr, $ilTabs;
$ilTabs->activateTab("id_settings");
// is_online
$cb = new ilCheckboxInputGUI($this->lng->txt("online"), "is_online");
$cb->setInfo($this->lng->txt("dcl_online_info"));
$a_form->addItem($cb);
// Notification
$cb = new ilCheckboxInputGUI($this->lng->txt("dcl_activate_notification"), "notification");
$cb->setInfo($this->lng->txt("dcl_notification_info"));
$a_form->addItem($cb);
}

+ Here is the call graph for this function:

ilObjDataCollectionGUI::listRecords ( )
Deprecated:

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

References $ilCtrl.

{
global $ilCtrl;
$ilCtrl->redirectByClass("ildatacollectionrecordlistgui", "listRecords");
}
ilObjDataCollectionGUI::render ( )

show Content; redirect to ilDataCollectionRecordListGUI::listRecords

Definition at line 305 of file class.ilObjDataCollectionGUI.php.

References $ilCtrl.

{
global $ilCtrl;
$ilCtrl->redirectByClass("ildatacollectionrecordlistgui", "listRecords");
}
ilObjDataCollectionGUI::setTabs ( )

setTabs create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

Reimplemented from ilObject2GUI.

Definition at line 384 of file class.ilObjDataCollectionGUI.php.

References ilObjectGUI\$lng.

{
global $ilAccess, $ilTabs, $lng, $ilHelp;
$ilHelp->setScreenIdComponent("dcl");
// list records
if ($ilAccess->checkAccess('read', "", $this->object->getRefId())) {
$ilTabs->addTab("id_records", $lng->txt("content"), $this->ctrl->getLinkTargetByClass("ildatacollectionrecordlistgui", "listRecords"));
}
// info screen
if ($ilAccess->checkAccess('visible', "", $this->object->getRefId())) {
$ilTabs->addTab("id_info", $lng->txt("info_short"), $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"));
}
// settings
if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
$ilTabs->addTab("id_settings", $lng->txt("settings"), $this->ctrl->getLinkTarget($this, "editObject"));
}
// list fields
if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
$ilTabs->addTab("id_fields", $lng->txt("dcl_list_fields"), $this->ctrl->getLinkTargetByClass("ildatacollectionfieldlistgui", "listFields"));
}
// export
if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
$ilTabs->addTab("export", $lng->txt("export"), $this->ctrl->getLinkTargetByClass("ilexportgui", ""));
}
// edit permissions
if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId())) {
$ilTabs->addTab("id_permissions", $lng->txt("perm_settings"), $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"));
}
}
ilObjDataCollectionGUI::toggleNotification ( )

Definition at line 520 of file class.ilObjDataCollectionGUI.php.

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

{
global $ilCtrl, $ilUser;
require_once('./Services/Notification/classes/class.ilNotification.php');
switch ($_GET["ntf"]) {
case 1:
break;
case 2:
break;
}
$ilCtrl->redirectByClass("ildatacollectionrecordlistgui", "listRecords");
}

+ Here is the call graph for this function:

ilObjDataCollectionGUI::updateCustom ( ilPropertyFormGUI  $a_form)
Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

Definition at line 495 of file class.ilObjDataCollectionGUI.php.

References $ilUser, emptyInfo(), and ilPropertyFormGUI\getInput().

{
global $ilUser;
$this->object->setOnline($a_form->getInput("is_online"));
$this->object->setRating($a_form->getInput("rating"));
$this->object->setPublicNotes($a_form->getInput("public_notes"));
$this->object->setApproval($a_form->getInput("approval"));
$this->object->setNotification($a_form->getInput("notification"));
$this->emptyInfo();
}

+ Here is the call graph for this function:

Field Documentation

const ilObjDataCollectionGUI::GET_DCL_GTR = "dcl_gtr"

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

Referenced by _goto().

const ilObjDataCollectionGUI::GET_REF_ID = "ref_id"

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

Referenced by _goto().


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