ilObjectOwnershipManagementGUI Class Reference

Collaboration diagram for ilObjectOwnershipManagementGUI:

Public Member Functions
	__construct (protected InternalDomainService $domain, protected InternalGUIService $gui, ?int $user_id=null, bool $read_only=false)
	executeCommand ()
	listObjects ()
	delete (int $id)
	show (int $id)
	move (int $id)
	export (int $id)
	changeOwner (int $id)
	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
ilCtrl	$ctrl
ilLanguage	$lng
int	$user_id
int	$own_id = 0
bool	$read_only

Private Member Functions
	getLabelForObjectType (string $type)

Private Attributes
ilObjectRequestRetriever	$retriever

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjectOwnershipManagementGUI::__construct	(	protected InternalDomainService	$domain,
		protected InternalGUIService	$gui,
		?int	$user_id = null,
		bool	$read_only = false
	)

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

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

      {
        $this->ctrl = $this->gui->ctrl();
        $this->lng = $this->domain->lng();
        $this->retriever = new ilObjectRequestRetriever(
            $this->gui->http()->wrapper(),
            $this->domain->refinery()
        );

        $this->lng->loadLanguageModule('obj');

        $this->user_id = $domain->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

changeOwner()

ilObjectOwnershipManagementGUI::changeOwner

(

int

$id

)

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

References checkReadOnly(), and redirectCmd().

                                        : void
    {
        $this->checkReadOnly();

        $this->redirectCmd(
            $id,
            ilPermissionGUI::class,
            'owner'
        );
    }

Here is the call graph for this function:

checkReadOnly()

ilObjectOwnershipManagementGUI::checkReadOnly ( )

protected

Definition at line 239 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

(

int

$id

)

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

References $id, checkReadOnly(), and redirectParentCmd().

                                   : void
    {
        $this->checkReadOnly();

        $this->redirectParentCmd(
            $id,
            'delete'
        );
    }

Here is the call graph for this function:

executeCommand()

ilObjectOwnershipManagementGUI::executeCommand

(

)

Definition at line 57 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

(

int

$id

)

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

References checkReadOnly(), and redirectCmd().

                                   : void
    {
        $this->checkReadOnly();

        $this->redirectCmd(
            $id,
            ilExportGUI::class
        );
    }

Here is the call graph for this function:

getLabelForObjectType()

ilObjectOwnershipManagementGUI::getLabelForObjectType ( string  $type )

private

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

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

Referenced by listObjects().

                                                        : string
    {
        $obj_definition = $this->domain->objectDefinition();
        if ($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 234 of file class.ilObjectOwnershipManagementGUI.php.

References $read_only.

                                : bool
    {
        return $this->read_only;
    }

listObjects()

ilObjectOwnershipManagementGUI::listObjects

(

)

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

References Vendor\Package\$f, ILIAS\Repository\ctrl(), ilObject\fixMissingTitles(), ilObject\getAllOwnedRepositoryObjects(), getLabelForObjectType(), and ILIAS\Repository\lng().

                                 : void
    {
        $objects = ilObject::getAllOwnedRepositoryObjects($this->user_id);
        $mt = $this->gui->mainTemplate();
        $toolbar = $this->gui->toolbar();
        $f = $this->gui->ui()->factory();

        if ($objects === []) {
            $table_builder = $this->gui->ownership()->ownershipManagementTableBuilder(
                $this->user_id,
                $this->lng->txt('user_owns_no_objects'),
                [],
                '',
                $this,
                'listObjects'
            );
            $mt->setContent($table_builder->getTable()->render());
            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] = $f->button()->shy($label, $target);
        }
        asort($options);

        $selected_type = $this->retriever->getMaybeString('type') ?? array_keys($options)[0];
        unset($options[$selected_type]);

        $dropdown = $f->dropdown()->standard($options)->withLabel(
            $this->lng->txt('select_object_type')
        );

        $toolbar->addStickyItem($dropdown);

        if (is_array($objects[$selected_type])
            && $objects[$selected_type] !== []) {
            ilObject::fixMissingTitles($selected_type, $objects[$selected_type]);
        }

        $table_builder = $this->gui->ownership()->ownershipManagementTableBuilder(
            $this->user_id,
            $this->getLabelForObjectType($selected_type),
            $objects,
            $selected_type,
            $this,
            'listObjects'
        );

        $this->ctrl->setParameterByClass(self::class, 'type', $selected_type);

        if ($table_builder->getTable()->handleCommand()) {
            return;
        }

        $mt->setContent($table_builder->getTable()->render());
    }

Here is the call graph for this function:

move()

ilObjectOwnershipManagementGUI::move

(

int

$id

)

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

References checkReadOnly(), and redirectParentCmd().

                                 : void
    {
        $this->checkReadOnly();

        $this->redirectParentCmd(
            $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 152 of file class.ilObjectOwnershipManagementGUI.php.

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

Referenced by changeOwner(), and export().

                                                                                   : void
    {
        $tree = $this->domain->repositoryTree();
        $obj_definition = $this->domain->objectDefinition();

        $node = $tree->getNodeData($ref_id);
        $gui_class = 'ilObj' . $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 142 of file class.ilObjectOwnershipManagementGUI.php.

References ILIAS\Repository\ctrl().

Referenced by delete(), and move().

                                                                  : void
    {
        $tree = $this->domain->repositoryTree();
        $parent = $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:

show()

ilObjectOwnershipManagementGUI::show

(

int

$id

)

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

References ILIAS\Repository\ctrl().

                                 : void
    {
        $link = \ilLink::_getLink($id);
        $this->ctrl->redirectToURL($link);
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilObjectOwnershipManagementGUI::$ctrl

protected

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

$lng

ilLanguage ilObjectOwnershipManagementGUI::$lng

protected

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

$own_id

int ilObjectOwnershipManagementGUI::$own_id = 0

protected

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

$read_only

bool ilObjectOwnershipManagementGUI::$read_only

protected

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

Referenced by __construct(), and isReadOnly().

$retriever

ilObjectRequestRetriever ilObjectOwnershipManagementGUI::$retriever

private

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

$user_id

int ilObjectOwnershipManagementGUI::$user_id

protected

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

Referenced by __construct().

P_OWNID

const ilObjectOwnershipManagementGUI::P_OWNID = 'ownid'

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

---

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

• components/ILIAS/Repository/Ownership/class.ilObjectOwnershipManagementGUI.php