Class ilObjectOwnershipManagementGUI. More...

Collaboration diagram for ilObjectOwnershipManagementGUI:

Public Member Functions
	__construct (?int $user_id=null, bool $read_only=false)

	executeCommand ()

	listObjects ()

	applyFilter ()

	resetFilter ()

	delete ()

	move ()

	export ()

	changeOwner ()

	isReadOnly ()

Data Fields
const	P_OWNID = 'ownid'

Protected Member Functions
	redirectParentCmd (int $ref_id, string $cmd)

	redirectCmd (int $ref_id, string $class, ?string $cmd=null)

	checkReadOnly ()

Protected Attributes
ilObjUser	$user

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

UIFactory	$ui_factory

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilObjectDefinition	$obj_definition

ilTree	$tree

int	$user_id

int	$own_id = 0

bool	$read_only

Private Member Functions
	getLabelForObjectType (string $type)

Private Attributes
ilObjectRequestRetriever	$retriever

Detailed Description

Class ilObjectOwnershipManagementGUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilObjectOwnershipManagementGUI:

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectOwnershipManagementGUI::__construct	(	?int	$user_id = `null`,
		bool	$read_only = `false`
	)

Definition at line 46 of file class.ilObjectOwnershipManagementGUI.php.

References $DIC, $read_only, $user_id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->user = $DIC['ilUser'];
         $this->ctrl = $DIC['ilCtrl'];
         $this->tpl = $DIC['tpl'];
         $this->ui_factory = $DIC['ui.factory'];
         $this->toolbar = $DIC['ilToolbar'];
         $this->lng = $DIC['lng'];
         $this->obj_definition = $DIC['objDefinition'];
         $this->tree = $DIC['tree'];
         $this->retriever = new ilObjectRequestRetriever($DIC->http()->wrapper(), $DIC['refinery']);
 
         $this->lng->loadLanguageModule('obj');
 
         $this->user_id = $this->user->getId();
         if (!is_null($user_id)) {
             $this->user_id = $user_id;
         }
         $this->read_only = $read_only;
         $this->own_id = $this->retriever->getMaybeInt(self::P_OWNID, 0);
     }

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilObjectOwnershipManagementGUI::applyFilter ( )

Definition at line 134 of file class.ilObjectOwnershipManagementGUI.php.

References listObjects().

                                  : void
     {
         $tbl = new ilObjectOwnershipManagementTableGUI($this, 'listObjects', $this->user_id);
         $tbl->resetOffset();
         $tbl->writeFilterToSession();
         $this->listObjects();
     }

Here is the call graph for this function:

◆ changeOwner()

ilObjectOwnershipManagementGUI::changeOwner ( )

Definition at line 221 of file class.ilObjectOwnershipManagementGUI.php.

References checkReadOnly(), and redirectCmd().

                                  : void
     {
         $this->checkReadOnly();
 
         $this->redirectCmd(
             $this->own_id,
             ilPermissionGUI::class,
             'owner'
         );
     }

Here is the call graph for this function:

◆ checkReadOnly()

ilObjectOwnershipManagementGUI::checkReadOnly ( )

protected

Definition at line 237 of file class.ilObjectOwnershipManagementGUI.php.

Referenced by changeOwner(), delete(), export(), and move().

                                       : void
     {
         if ($this->read_only) {
             throw new ilObjectException(
                 'Cannot perform actions when in read only mode'
             );
         }
     }

Here is the caller graph for this function:

◆ delete()

ilObjectOwnershipManagementGUI::delete ( )

Definition at line 191 of file class.ilObjectOwnershipManagementGUI.php.

References checkReadOnly(), and redirectParentCmd().

                             : void
     {
         $this->checkReadOnly();
 
         $this->redirectParentCmd(
             $this->own_id,
             'delete'
         );
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjectOwnershipManagementGUI::executeCommand ( )

Definition at line 70 of file class.ilObjectOwnershipManagementGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         if (!$cmd) {
             $cmd = 'listObjects';
         }
         $this->$cmd();
     }

Here is the call graph for this function:

◆ export()

ilObjectOwnershipManagementGUI::export ( )

Definition at line 211 of file class.ilObjectOwnershipManagementGUI.php.

References checkReadOnly(), and redirectCmd().

                             : void
     {
         $this->checkReadOnly();
 
         $this->redirectCmd(
             $this->own_id,
             ilExportGUI::class
         );
     }

Here is the call graph for this function:

◆ getLabelForObjectType()

ilObjectOwnershipManagementGUI::getLabelForObjectType ( string $type )

private

Definition at line 124 of file class.ilObjectOwnershipManagementGUI.php.

References ilObjectPlugin\getPluginObjectByType(), and ILIAS\Repository\lng().

Referenced by listObjects().

                                                         : string
     {
         if ($this->obj_definition->isPlugin($type)) {
             return ilObjectPlugin::getPluginObjectByType($type)
                 ->txt('obj_' . $type);
         }
 
         return $this->lng->txt('objs_' . $type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReadOnly()

ilObjectOwnershipManagementGUI::isReadOnly ( )

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

References $read_only.

                                 : bool
     {
         return $this->read_only;
     }

◆ listObjects()

ilObjectOwnershipManagementGUI::listObjects ( )

Definition at line 81 of file class.ilObjectOwnershipManagementGUI.php.

References ILIAS\Repository\ctrl(), ilObject\fixMissingTitles(), ilObject\getAllOwnedRepositoryObjects(), getLabelForObjectType(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by applyFilter(), and resetFilter().

                                  : void
     {
         $objects = ilObject::getAllOwnedRepositoryObjects($this->user_id);
 
         $tbl = new ilObjectOwnershipManagementTableGUI($this, 'listObjects', $this->user_id);
 
         if ($objects === []) {
             $tbl->setTitle($this->lng->txt('user_owns_no_objects'));
             $this->tpl->setContent($tbl->getHTML());
             return;
         }
 
         $object_types = array_keys($objects);
 
         $options = [];
         foreach ($object_types as $type) {
             $this->ctrl->setParameterByClass(self::class, 'type', $type);
             $target = $this->ctrl->getLinkTargetByClass(self::class, 'listObjects');
             $label = $this->getLabelForObjectType($type);
             $options[$type] = $this->ui_factory->button()->shy($label, $target);
         }
         asort($options);
 
         $selected_type = $this->retriever->getMaybeString('type') ?? array_keys($options)[0];
         unset($options[$selected_type]);
 
         $dropdown = $this->ui_factory->dropdown()->standard($options)->withLabel(
             $this->lng->txt('select_object_type')
         );
 
         $this->toolbar->addStickyItem($dropdown);
 
         if (is_array($objects[$selected_type])
             && $objects[$selected_type] !== []) {
             ilObject::fixMissingTitles($selected_type, $objects[$selected_type]);
         }
 
         $tbl->setTitle($this->getLabelForObjectType($selected_type));
         $tbl->initItems($objects[$selected_type]);
         $this->ctrl->setParameterByClass(self::class, 'type', $selected_type);
         $this->tpl->setContent($tbl->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move()

ilObjectOwnershipManagementGUI::move ( )

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

References checkReadOnly(), and redirectParentCmd().

                           : void
     {
         $this->checkReadOnly();
 
         $this->redirectParentCmd(
             $this->own_id,
             'cut'
         );
     }

Here is the call graph for this function:

◆ redirectCmd()

ilObjectOwnershipManagementGUI::redirectCmd	(	int	$ref_id,
		string	$class,
		?string	$cmd = `null`
	)

protected

Definition at line 159 of file class.ilObjectOwnershipManagementGUI.php.

References Vendor\Package\$e, $path, and ILIAS\Repository\ctrl().

Referenced by changeOwner(), and export().

                                                                                    : void
     {
         $node = $this->tree->getNodeData($ref_id);
         $gui_class = 'ilObj' . $this->obj_definition->getClassName($node['type']) . 'GUI';
         $path = ['ilRepositoryGUI', $gui_class, $class];
 
         if ($class == 'ilExportGUI') {
             try {
                 $this->ctrl->getLinkTargetByClass($path);
             } catch (Exception $e) {
                 switch ($node['type']) {
                     case 'glo':
                         $export_cmd = 'exportList';
                         $path = ['ilRepositoryGUI', 'ilGlossaryEditorGUI', $gui_class];
                         break;
 
                     default:
                         $export_cmd = 'export';
                         $path = ['ilRepositoryGUI', $gui_class];
                         break;
                 }
                 $this->ctrl->setParameterByClass($gui_class, 'ref_id', $ref_id);
                 $this->ctrl->setParameterByClass($gui_class, 'cmd', $export_cmd);
                 $this->ctrl->redirectByClass($path);
             }
         }
 
         $this->ctrl->setParameterByClass($class, 'ref_id', $ref_id);
         $this->ctrl->setParameterByClass($class, 'cmd', $cmd);
         $this->ctrl->redirectByClass($path);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectParentCmd()

ilObjectOwnershipManagementGUI::redirectParentCmd	(	int	$ref_id,
		string	$cmd
	)

protected

Definition at line 150 of file class.ilObjectOwnershipManagementGUI.php.

References ILIAS\Repository\ctrl().

Referenced by delete(), and move().

                                                                   : void
     {
         $parent = $this->tree->getParentId($ref_id);
         $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', $parent);
         $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'item_ref_id', $ref_id);
         $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'cmd', $cmd);
         $this->ctrl->redirectByClass(ilRepositoryGUI::class);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilObjectOwnershipManagementGUI::resetFilter ( )

Definition at line 142 of file class.ilObjectOwnershipManagementGUI.php.

References listObjects().

                                  : void
     {
         $tbl = new ilObjectOwnershipManagementTableGUI($this, 'listObjects', $this->user_id);
         $tbl->resetOffset();
         $tbl->resetFilter();
         $this->listObjects();
     }