Remote wiki GUI. More...

Inheritance diagram for ilObjRemoteWikiGUI:

Collaboration diagram for ilObjRemoteWikiGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)

	getType ()

Public Member Functions inherited from ilRemoteObjectBaseGUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)

	executeCommand ()

	showObject ()
	show remote object More...

	callObject ()
	call remote object More...

	infoScreenObject ()
	this one is called from the info button in the repository More...

	infoScreen ()
	show info screen More...

	editObject (ilPropertyFormGUI $form=null)
	Edit settings. More...

	updateObject ()

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

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode (bool $mode=true)

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

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

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

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

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

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

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

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

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

	saveObject ()

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

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

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

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

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

	isVisible (int $ref_id, string $type)

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

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

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

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

Protected Member Functions
	addCustomInfoFields (ilInfoScreenGUI $a_info)

	availabilityToString ()

	addCustomEditForm (ilPropertyFormGUI $a_form)

Protected Member Functions inherited from ilRemoteObjectBaseGUI
	setTabs ()
	get tabs More...

	addCustomInfoFields (ilInfoScreenGUI $a_info)
	Add custom fields to info screen. More...

	initEditForm ()
	Init edit settings form. More...

	addCustomEditForm (ilPropertyFormGUI $a_form)
	Add custom fields to edit form. More...

	updateCustomValues (ilPropertyFormGUI $a_form)
	Update object custom values. More...

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

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

	getAccessHandler ()

	setLocator ()
	set Locator More...

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

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

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

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

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

	showPossibleSubObjects ()

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

	addAdminLocatorItems (bool $do_not_add_object=false)

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

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

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

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

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

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

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

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

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

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

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

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

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

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

	omitLocator (bool $omit=true)

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

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

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

	initEditForm ()

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

	getEditFormValues ()

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

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

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

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

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

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

	setFormAction (string $cmd, string $form_action)

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

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

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

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

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

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

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

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

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

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

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Additional Inherited Members
Static Public Member Functions inherited from ilRemoteObjectBaseGUI
static	_goto (string $a_target)

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

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

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

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields inherited from ilRemoteObjectBaseGUI
const	TAB_ID_PERMISSIONS = "id_permissions"

Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = []

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Detailed Description

Remote wiki GUI.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

ilObjRemoteWikiGUI: ilPermissionGUI, ilInfoScreenGUI ilObjRemoteWikiGUI: ilCommonActionDispatcherGUI \

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

Constructor & Destructor Documentation

◆ __construct()

ilObjRemoteWikiGUI::__construct	(	$a_id = `0`,
		$a_id_type = `self::REPOSITORY_NODE_ID`,
		$a_parent_node_id = `0`
	)

Definition at line 34 of file class.ilObjRemoteWikiGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

     {
         parent::__construct($a_id, $a_id_type, $a_parent_node_id);
 
         $this->lng->loadLanguageModule('rwik');
         $this->lng->loadLanguageModule('wiki');
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomEditForm()

ilObjRemoteWikiGUI::addCustomEditForm ( ilPropertyFormGUI $a_form )

protected

Definition at line 64 of file class.ilObjRemoteWikiGUI.php.

References ilObjRemoteWiki\ACTIVATION_OFFLINE, ilObjRemoteWiki\ACTIVATION_ONLINE, ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilRadioGroupInputGUI\setValue().

                                                                    : void
     {
         $radio_grp = new ilRadioGroupInputGUI($this->lng->txt('ecs_availability'), 'activation_type');
         $radio_grp->setValue($this->object->getAvailabilityType());
         $radio_grp->setDisabled(true);
 
         $radio_opt = new ilRadioOption($this->lng->txt('offline'), ilObjRemoteWiki::ACTIVATION_OFFLINE);
         $radio_grp->addOption($radio_opt);
 
         $radio_opt = new ilRadioOption($this->lng->txt('online'), ilObjRemoteWiki::ACTIVATION_ONLINE);
         $radio_grp->addOption($radio_opt);
 
         $a_form->addItem($radio_grp);
     }

Here is the call graph for this function:

◆ addCustomInfoFields()

ilObjRemoteWikiGUI::addCustomInfoFields ( ilInfoScreenGUI $a_info )

protected

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

References ilInfoScreenGUI\addProperty(), availabilityToString(), and ILIAS\Repository\lng().

                                                                    : void
     {
         $a_info->addProperty($this->lng->txt('ecs_availability'), $this->availabilityToString());
     }

Here is the call graph for this function:

◆ availabilityToString()

ilObjRemoteWikiGUI::availabilityToString ( )

protected

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

References ilObjRemoteWiki\ACTIVATION_OFFLINE, ilObjRemoteWiki\ACTIVATION_ONLINE, ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by addCustomInfoFields().

     {
         switch ($this->object->getAvailabilityType()) {
             case ilObjRemoteWiki::ACTIVATION_OFFLINE:
                 return $this->lng->txt('offline');
 
             case ilObjRemoteWiki::ACTIVATION_ONLINE:
                 return $this->lng->txt('online');
         }
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilObjRemoteWikiGUI::getType ( )

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

                              : string
     {
         return 'rwik';
     }

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

components/ILIAS/RemoteWiki/classes/class.ilObjRemoteWikiGUI.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomEditForm()

◆ addCustomInfoFields()

◆ availabilityToString()

◆ getType()