Inheritance diagram for ilObjectPluginGUI:

Collaboration diagram for ilObjectPluginGUI:

Public Member Functions
	__construct ($a_ref_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...

	executeCommand ()
	execute command More...

	addLocatorItems ()
	Add object to locator. More...

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

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

	afterSave (ilObject $newObj)
	After saving @access public. More...

	getAfterCreationCmd ()
	Cmd that will be redirected to after creation of a new object. More...

	getStandardCmd ()

	addInfoTab ()
	Add info screen tab. More...

	addPermissionTab ()
	Add permission tab. More...

	infoScreen ()
	show information screen More...

	addInfoItems ($info)
	Add items to info screen. 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...

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

	isVisible ($a_ref_id, $a_type)

	trash ()

	undelete ()

	cancelDelete ()

	removeFromSystem ()

	cloneAll ()

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

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

	create ()
	Deleted in ilObject. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()
	Import. More...

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

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

Static Public Member Functions
static	_goto ($a_target)
	Goto redirection. 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...

Protected Member Functions
	getPlugin ()
	Get plugin object. More...

	txt ($a_var)
	Wrapper for txt function. More...

	getCreationFormTitle ($a_form_type)
	Use custom creation form titles. More...

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

	supportsCloning ()

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

	supportsExport ()

	lookupParentTitleInCreationMode ()

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

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

	getAccessHandler ()
	Get access handler. More...

	setLocator ()
	set Locator More...

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

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

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

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) 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...

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

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

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

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

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

	showActions ()

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

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

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

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

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

	$tabs_gui = null

	$ctrl

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

Detailed Description

Definition at line 14 of file class.ilObjectPluginGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectPluginGUI::__construct	(	$a_ref_id = `0`,
		$a_id_type = `self::REPOSITORY_NODE_ID`,
		$a_parent_node_id = `0`
	)

Constructor.

Reimplemented from ilObject2GUI.

Reimplemented in ilOrgUnitExtensionGUI.

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

        {
                parent::__construct($a_ref_id, $a_id_type, $a_parent_node_id);
                $this->plugin = $this->getPlugin();
        }

References getPlugin().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjectPluginGUI::_goto ( $a_target )

static

Goto redirection.

Definition at line 442 of file class.ilObjectPluginGUI.php.

        {
                global $ilCtrl, $ilAccess, $lng;
                
                $t = explode("_", $a_target[0]);
                $ref_id = (int) $t[0];
                $class_name = $a_target[1];
                
                if ($ilAccess->checkAccess("read", "", $ref_id))
                {
                        $ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
                        $ilCtrl->setTargetScript("ilias.php");
                        $ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
                        $ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
                        $ilCtrl->redirectByClass(array("ilobjplugindispatchgui", $class_name), "");
                }
                else if($ilAccess->checkAccess("visible", "", $ref_id))
                {
                        $ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
                        $ilCtrl->setTargetScript("ilias.php");
                        $ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
                        $ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
                        $ilCtrl->redirectByClass(array("ilobjplugindispatchgui", $class_name), "infoScreen");
                }
                else if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
                {
                        ilUtil::sendFailure(sprintf($lng->txt("msg_no_perm_read_item"),
                                ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))));
                        include_once("./Services/Object/classes/class.ilObjectGUI.php");
                        ilObjectGUI::_gotoRepositoryRoot();
                }
        }

References $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$ref_id, $t, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilUtil\sendFailure(), and sprintf.

Here is the call graph for this function:

◆ addInfoItems()

ilObjectPluginGUI::addInfoItems ( $info )

Add items to info screen.

Definition at line 435 of file class.ilObjectPluginGUI.php.

436 {

437 }

Referenced by infoScreen().

Here is the caller graph for this function:

◆ addInfoTab()

ilObjectPluginGUI::addInfoTab ( )

Add info screen tab.

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

        {
                global $ilAccess, $ilTabs;
                
                // info screen
                if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()))
                {
                        $ilTabs->addTarget("info_short",
                                $this->ctrl->getLinkTargetByClass(
                                "ilinfoscreengui", "showSummary"),
                                "showSummary");
                }
        }

◆ addLocatorItems()

ilObjectPluginGUI::addLocatorItems ( )

Add object to locator.

Reimplemented from ilObject2GUI.

Definition at line 157 of file class.ilObjectPluginGUI.php.

        {
                global $ilLocator;
 
                if (!$this->getCreationMode())
                {
                        $ilLocator->addItem($this->object->getTitle(),
                                $this->ctrl->getLinkTarget($this, $this->getStandardCmd()), "", $_GET["ref_id"]);
                }
        }

References $_GET, and ilObject2GUI\getCreationMode().

Here is the call graph for this function:

◆ addPermissionTab()

ilObjectPluginGUI::addPermissionTab ( )

Add permission tab.

Definition at line 393 of file class.ilObjectPluginGUI.php.

        {
                global $ilAccess, $ilTabs, $ilCtrl;
                
                // edit permissions
                if($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId()))
                {
                        $ilTabs->addTarget("perm_settings",
                                $ilCtrl->getLinkTargetByClass("ilpermissiongui", "perm"),
                                array("perm","info","owner"), 'ilpermissiongui');
                }
        }

References $ilCtrl.

◆ afterSave()

ilObjectPluginGUI::afterSave ( ilObject $newObj )

After saving @access public.

Reimplemented from ilObjectGUI.

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

        {
                global $ilCtrl;
                // always send a message
                ilUtil::sendSuccess($this->lng->txt("object_added"),true);
 
                $ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
                $ilCtrl->setTargetScript("ilias.php");
                $ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
                
//var_dump($ilCtrl->call_node);
//var_dump($ilCtrl->forward);
//var_dump($ilCtrl->parent);
//var_dump($ilCtrl->root_class);
 
                $ilCtrl->setParameterByClass(get_class($this), "ref_id", $newObj->getRefId());
                $ilCtrl->redirectByClass(array("ilobjplugindispatchgui", get_class($this)), $this->getAfterCreationCmd());
        }

References $ilCtrl, getAfterCreationCmd(), ilObject\getRefId(), and ilUtil\sendSuccess().

Here is the call graph for this function:

◆ executeCommand()

ilObjectPluginGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

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

        {
                global $ilCtrl, $tpl, $ilAccess, $lng, $ilNavigationHistory, $ilTabs;
 
                // get standard template (includes main menu and general layout)
                $tpl->getStandardTemplate();
 
                // set title
                if (!$this->getCreationMode())
                {
                        $tpl->setTitle($this->object->getTitle());
                        $tpl->setTitleIcon(ilObject::_getIcon($this->object->getId()));
 
                        // set tabs
                        if (strtolower($_GET["baseClass"]) != "iladministrationgui")
                        {
                                $this->setTabs();
                                $this->setLocator();
                        }
                        else
                        {
                                $this->addAdminLocatorItems();
                                $tpl->setLocator();
                                $this->setAdminTabs();
                        }
                        
                        // add entry to navigation history
                        if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
                        {
                                $ilNavigationHistory->addItem($_GET["ref_id"],
                                        $ilCtrl->getLinkTarget($this, $this->getStandardCmd()), $this->getType());
                        }
 
                }
                else
                {
                        // show info of parent
                        $tpl->setTitle($this->lookupParentTitleInCreationMode());
                        $tpl->setTitleIcon(
                                ilObject::_getIcon(ilObject::_lookupObjId($_GET["ref_id"]), "big"),
                                $lng->txt("obj_".ilObject::_lookupType($_GET["ref_id"], true)));
                        $this->setLocator();
 
                }
 
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
 
                switch($next_class)
                {
                        case "ilinfoscreengui":
                                $this->checkPermission("visible");
                                $this->infoScreen();    // forwards command
                                break;
 
                        case 'ilpermissiongui':
                                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                $perm_gui = new ilPermissionGUI($this);
                                $ilTabs->setTabActive("perm_settings");
                                $ilCtrl->forwardCommand($perm_gui);
                                break;
                
                        case 'ilobjectcopygui':
                                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                                $cp = new ilObjectCopyGUI($this);
                                $cp->setType($this->getType());
                                $this->ctrl->forwardCommand($cp);
                                break;
                        
                        case 'ilexportgui':
                                // only if plugin supports it?
                                include_once './Services/Export/classes/class.ilExportGUI.php';
                                $exp = new ilExportGUI($this);          
                                $exp->addFormat('xml');
                                $this->ctrl->forwardCommand($exp);
                                break;
                                                
                        case 'illearningprogressgui':
                                $ilTabs->setTabActive("learning_progress");
                                include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
                                $new_gui = new ilLearningProgressGUI(ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                                                                                                          $this->object->getRefId(),
                                                                                                          $_GET['user_id'] ? $_GET['user_id'] : $GLOBALS['ilUser']->getId());
                                $this->ctrl->forwardCommand($new_gui);
                                break;
                        case 'ilcommonactiondispatchergui':
                                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                                $this->ctrl->forwardCommand($gui);
                                break;
                        default:
                                if ($this->getCreationMode() || $cmd == "save")
                                {
                                        $this->$cmd();
                                        return;
                                }
//                              if (strtolower($_GET["baseClass"]) == "iladministrationgui")
//                              {
//                                      $this->viewObject();
//                                      return;
//                              }
                                if(!$cmd)
                                {
                                        $cmd = $this->getStandardCmd();
                                }
                                if ($cmd == "infoScreen")
                                {
                                        $ilCtrl->setCmd("showSummary");
                                        $ilCtrl->setCmdClass("ilinfoscreengui");
                                        $this->infoScreen();
                                }
                                else
                                {
                                        $this->performCommand($cmd);
                                }
                                break;
                }
 
                if (!$this->getCreationMode())
                {
                        $tpl->show();
                }
        }

References $_GET, $cmd, $GLOBALS, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject2GUI\addAdminLocatorItems(), ilObject2GUI\checkPermission(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getStandardCmd(), ilObject2GUI\getType(), infoScreen(), lookupParentTitleInCreationMode(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ilObjectGUI\setAdminTabs(), ilObject2GUI\setLocator(), and ilObject2GUI\setTabs().

Here is the call graph for this function:

◆ getAfterCreationCmd()

ilObjectPluginGUI::getAfterCreationCmd ( )

abstract

Cmd that will be redirected to after creation of a new object.

Referenced by afterSave().

Here is the caller graph for this function:

◆ getCreationFormTitle()

ilObjectPluginGUI::getCreationFormTitle ( $a_form_type )

protected

Use custom creation form titles.

Parameters

string $a_form_type

Returns: string

Definition at line 200 of file class.ilObjectPluginGUI.php.

        {
                switch($a_form_type)
                {
                        case self::CFORM_NEW:
                                return $this->txt($this->getType()."_new");
                                
                        case self::CFORM_IMPORT:
                                return $this->lng->txt("import");
                                
                        case self::CFORM_CLONE:
                                return $this->txt("objs_".$this->getType()."_duplicate");
                }
        }

References ilObjectGUI\CFORM_CLONE, ilObjectGUI\CFORM_IMPORT, ilObjectGUI\CFORM_NEW, ilObject2GUI\getType(), and txt().

Here is the call graph for this function:

◆ getPlugin()

ilObjectPluginGUI::getPlugin ( )

protected

Get plugin object.

Returns: object plugin object

Exceptions

ilPluginException

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 173 of file class.ilObjectPluginGUI.php.

        {
                if(!$this->plugin) {
                        $this->plugin =
                                ilPlugin::getPluginObject(IL_COMP_SERVICE, "Repository", "robj",
                                        ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $this->getType()));
                        if (!is_object($this->plugin)) {
                                throw new ilPluginException("ilObjectPluginGUI: Could not instantiate plugin object for type " . $this->getType() . ".");
                        }
                }
                return $this->plugin;
        }

References $plugin, ilPlugin\getPluginObject(), ilObject2GUI\getType(), IL_COMP_SERVICE, and ilPlugin\lookupNameForId().

Referenced by __construct(), supportsExport(), and txt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStandardCmd()

ilObjectPluginGUI::getStandardCmd ( )

abstract

Referenced by executeCommand().

Here is the caller graph for this function:

◆ infoScreen()

ilObjectPluginGUI::infoScreen ( )

show information screen

Definition at line 410 of file class.ilObjectPluginGUI.php.

        {
                global $ilAccess, $ilUser, $lng, $ilCtrl, $tpl, $ilTabs;
                
                $ilTabs->setTabActive("info_short");
                
                $this->checkPermission("visible");
 
                include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
                $info = new ilInfoScreenGUI($this);
                $info->enablePrivateNotes();
 
                // general information
                $lng->loadLanguageModule("meta");
 
                $this->addInfoItems($info);
 
                // forward the command
                $ret = $ilCtrl->forwardCommand($info);
                //$tpl->setContent($ret);
        }

References $ilCtrl, $ilUser, $info, ilObjectGUI\$lng, $ret, ilObjectGUI\$tpl, addInfoItems(), and ilObject2GUI\checkPermission().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateForm()

ilObjectPluginGUI::initCreateForm ( $a_new_type )

Init object creation form.

Parameters

string $a_new_type

Returns: ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 254 of file class.ilObjectPluginGUI.php.

        {
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setTarget("_top");
                $form->setFormAction($this->ctrl->getFormAction($this, "save"));
                $form->setTitle($this->txt($a_new_type."_new"));
 
                // title
                $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
                $ti->setSize(min(40, ilObject::TITLE_LENGTH));
                $ti->setMaxLength(ilObject::TITLE_LENGTH);
                $ti->setRequired(true);
                $form->addItem($ti);
 
                // description
                $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
                $ta->setCols(40);
                $ta->setRows(2);
                $form->addItem($ta);
 
                $form->addCommandButton("save", $this->txt($a_new_type."_add"));
                $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
                return $form;           
        }

References ilObject\TITLE_LENGTH, and txt().

Referenced by initCreationForms().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjectPluginGUI::initCreationForms ( $a_new_type )

protected

Init creation froms.

this will create the default creation forms: new, import, clone

Parameters

string $a_new_type

Returns: array

Reimplemented from ilObject2GUI.

Definition at line 223 of file class.ilObjectPluginGUI.php.

        {
                global $ilPluginAdmin;
                
                $forms = array();
                $forms[self::CFORM_NEW] = $this->initCreateForm($a_new_type);
 
                if($this->supportsExport())
                {
                        $forms[self::CFORM_IMPORT] = $this->initImportForm($a_new_type);
                }               
                if($this->supportsCloning()) {
                        $forms[self::CFORM_CLONE] = $this->fillCloneTemplate(null, $a_new_type);
                }
 
                return $forms;
        }

References ilObjectGUI\CFORM_CLONE, ilObjectGUI\CFORM_IMPORT, ilObjectGUI\CFORM_NEW, ilObject2GUI\fillCloneTemplate(), initCreateForm(), initImportForm(), supportsCloning(), and supportsExport().

Here is the call graph for this function:

◆ initEditForm()

ilObjectPluginGUI::initEditForm ( )

Init object update form.

Returns: ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 286 of file class.ilObjectPluginGUI.php.

        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setTarget("_top");
                $form->setFormAction($ilCtrl->getFormAction($this, "update"));   
                $form->setTitle($lng->txt("edit"));
        
                // title
                $ti = new ilTextInputGUI($lng->txt("title"), "title");
                $ti->setSize(min(40, ilObject::TITLE_LENGTH));
                $ti->setMaxLength(ilObject::TITLE_LENGTH);
                $ti->setRequired(true);
                $form->addItem($ti);
                
                // description
                $ta = new ilTextAreaInputGUI($lng->txt("description"), "desc");
                $ta->setCols(40);
                $ta->setRows(2);
                $form->addItem($ta);
        
                $form->addCommandButton("update", $lng->txt("save"));
                // $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));    
                
                return $form;
        }

References $ilCtrl, ilObjectGUI\$lng, and ilObject\TITLE_LENGTH.

◆ initImportForm()

ilObjectPluginGUI::initImportForm ( $a_new_type )

protected

Init object import form.

Parameters

string new type

Returns: ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 321 of file class.ilObjectPluginGUI.php.

        {
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setTarget("_top");
                $form->setFormAction($this->ctrl->getFormAction($this, "importFile"));
                $form->setTitle($this->lng->txt("import"));
 
                include_once("./Services/Form/classes/class.ilFileInputGUI.php");
                $fi = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
                $fi->setSuffixes(array("zip"));
                $fi->setRequired(true);
                $form->addItem($fi);
 
                $form->addCommandButton("importFile", $this->lng->txt("import"));
                $form->addCommandButton("cancel", $this->lng->txt("cancel"));
        
                return $form;
        }

Referenced by initCreationForms().

Here is the caller graph for this function:

◆ lookupParentTitleInCreationMode()

ilObjectPluginGUI::lookupParentTitleInCreationMode ( )

protected

Returns: mixed

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 489 of file class.ilObjectPluginGUI.php.

                                                             {
                return ilObject::_lookupTitle(ilObject::_lookupObjId($_GET["ref_id"]));
        }

References $_GET, ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportsCloning()

ilObjectPluginGUI::supportsCloning ( )

protected

Returns: bool returns true iff this plugin object supports cloning

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 244 of file class.ilObjectPluginGUI.php.

                                             {
                return true;
        }

Referenced by initCreationForms().

Here is the caller graph for this function:

◆ supportsExport()

ilObjectPluginGUI::supportsExport ( )

protected

Returns: bool

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 479 of file class.ilObjectPluginGUI.php.

                                            {
                global $ilPluginAdmin;
 
                return $ilPluginAdmin->supportsExport(IL_COMP_SERVICE, "Repository", "robj", $this->getPlugin()->getPluginName());
        }

References getPlugin(), and IL_COMP_SERVICE.

Referenced by initCreationForms().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ txt()

ilObjectPluginGUI::txt ( $a_var )

finalprotected

Wrapper for txt function.

Definition at line 189 of file class.ilObjectPluginGUI.php.

        {
                return $this->getPlugin()->txt($a_var);
        }

References getPlugin().

Referenced by getCreationFormTitle(), and initCreateForm().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $plugin

ilObjectPluginGUI::$plugin

protected

Definition at line 17 of file class.ilObjectPluginGUI.php.

Referenced by ilOrgUnitExtensionGUI\getPlugin(), and getPlugin().

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

Services/Repository/classes/class.ilObjectPluginGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addInfoItems()

◆ addInfoTab()

◆ addLocatorItems()

◆ addPermissionTab()

◆ afterSave()

◆ executeCommand()

◆ getAfterCreationCmd()

◆ getCreationFormTitle()

◆ getPlugin()

◆ getStandardCmd()

◆ infoScreen()

◆ initCreateForm()

◆ initCreationForms()

◆ initEditForm()

◆ initImportForm()

◆ lookupParentTitleInCreationMode()

◆ supportsCloning()

◆ supportsExport()

◆ txt()

Field Documentation

◆ $plugin