GUI class for the workflow of copying objects. More...

Collaboration diagram for ilObjectCopyGUI:

Public Member Functions
	executeCommand ()

	setMode (int $mode)

	getMode ()

	setSubMode (int $mode)

	getSubMode ()

	getParentObject ()
	Get parent gui object. More...

	getType ()

	setType (string $type)

	setSource (array $source_ids)

	getSources ()

	getFirstSource ()

	setTarget (int $ref_id)

	setTargets (array $targets)

	getTargets ()

	getFirstTarget ()

	keepObjectsInClipboard ()

	copyMultipleNonContainer (array $sources)
	Copy multiple non container. More...

	showSourceSearch (?string $tpl_var)
	Show init screen Normally shown below the create and import form when creating a new object. More...

Data Fields
const	SOURCE_SELECTION = 1

const	TARGET_SELECTION = 2

const	SEARCH_SOURCE = 3

const	SUBMODE_COMPLETE = 1

const	SUBMODE_CONTENT_ONLY = 2

const	TAB_SELECTION_TARGET_TREE = 1

const	TAB_SELECTION_SOURCE_TREE = 2

const	TAB_SELECTION_MEMBERSHIP = 3

const	TAB_GROUP_SC_SELECTION = 1

Protected Member Functions
	init ()

	initTabs ()

	setTabs (int $tab_group, int $active_tab)

	adoptContent ()
	Adopt content (crs in crs, grp in grp, crs in grp or grp in crs) More...

	initTargetSelection ()
	Init copy from repository/search list commands. More...

	initSourceSelection ()

	showSourceSelectionMembership ()
	show target selection membership More...

	showTargetSelectionTree ()

	showSourceSelectionTree ()

	saveTarget ()

	cancel ()

	searchSource ()

	saveSource ()

	saveSourceMembership ()
	Save selected source from membership screen. More...

	showCopyPageSelection ()

	saveCopyPage ()

	showItemSelection (bool $copy_page=false)

	copySingleObject ()
	Start cloning a single (not container) object. More...

	copyContainerToTargets ()

	showCopyProgress ()

	updateProgress ()

	copyContainer (int $target_ref_id)

	initFormSearch ()

	unsetSession ()
	Unset session variables. More...

Protected Attributes
ilCtrl	$ctrl

ilTree	$tree

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilObjectDefinition	$obj_definition

ilObjectDataCache	$obj_data_cache

ilAccessHandler	$access

ilErrorHandling	$error

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilRbacReview	$rbacreview

ilLogger	$log

ilLanguage	$lng

RequestWrapper	$request_wrapper

ArrayBasedRequestWrapper	$post_wrapper

Refinery	$refinery

ServerRequestInterface	$request

UIFactory	$ui_factory

UIRenderer	$ui_renderer

GlobalHttpState	$http

ContainerDBRepository	$container_repo

ImplementsCreationCallback	$parent_obj = null

ClipboardManager	$clipboard

int	$mode = 0

int	$sub_mode = self::SUBMODE_COMPLETE

string	$type = ''

array	$sources = []

array	$targets = []

array	$targets_copy_id = []

ilPropertyFormGUI	$form

Private Member Functions
	getPrimaryButtonLabel ()

	getOnLoadCode (string $cmd)

	getErrorMessageOnDisallowedObjectTypeForTarget (int $ref_id)

	executeNextStepAfterSourceSelection ()

	buildCopyPageSelectionForm ()

	isCopyingParentPageNeeded ()

	copyParentPage ()

Private Attributes
ilObjectRequestRetriever	$retriever

Detailed Description

GUI class for the workflow of copying objects.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de @ilCtrl_Calls ilObjectCopyGUI:

Definition at line 43 of file class.ilObjectCopyGUI.php.

Member Function Documentation

◆ adoptContent()

ilObjectCopyGUI::adoptContent ( )

protected

Adopt content (crs in crs, grp in grp, crs in grp or grp in crs)

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

                                     : void
    {
        $this->ctrl->setParameter($this, 'smode', self::SUBMODE_CONTENT_ONLY);
        $this->ctrl->setParameter($this, 'selectMode', self::SOURCE_SELECTION);
 
        $this->setSubMode(self::SUBMODE_CONTENT_ONLY);
        $this->setMode(self::SOURCE_SELECTION);
        $this->setTarget($this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int()));
 
        $this->initSourceSelection();
    }

References ILIAS\Repository\ctrl(), initSourceSelection(), setMode(), setSubMode(), and setTarget().

Here is the call graph for this function:

◆ buildCopyPageSelectionForm()

ilObjectCopyGUI::buildCopyPageSelectionForm ( )

private

Definition at line 785 of file class.ilObjectCopyGUI.php.

                                                 : Standard
    {
        $form_action = $this->ctrl->getFormAction($this, 'saveCopyPage');
 
        $input = [
            'copy_page' => $this->ui_factory->input()->field()
                ->radio(
                    $this->lng->txt('cntr_adopt_content')
                )
                ->withOption('1', $this->lng->txt('copy_container_page_yes_label'), $this->lng->txt('copy_container_page_yes_byline'))
                ->withOption('0', $this->lng->txt('copy_container_page_no_label'))
                ->withValue('1')
                ->withAdditionalTransformation($this->refinery->kindlyTo()->bool())
        ];
 
        return $this->ui_factory->input()->container()->form()
            ->standard($form_action, $input)
            ->withSubmitLabel($this->lng->txt('next'));
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by saveCopyPage(), and showCopyPageSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilObjectCopyGUI::cancel ( )

protected

Definition at line 619 of file class.ilObjectCopyGUI.php.

                               : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->setReturnByClass(get_class($this->parent_obj), 'cancel');
        $ilCtrl->returnToParent($this);
    }

References $ctrl, and ilCtrl\setReturnByClass().

Here is the call graph for this function:

◆ copyContainer()

ilObjectCopyGUI::copyContainer ( int $target_ref_id )

protected

Definition at line 1064 of file class.ilObjectCopyGUI.php.

                                                        : array
    {
        if ($this->getSubMode() != self::SUBMODE_CONTENT_ONLY) {
            if (!$this->rbacsystem->checkAccess('create', $target_ref_id, $this->getType())) {
                $this->log->notice(
                    'Permission denied for target: ' .
                    $target_ref_id .
                    ' type: ' .
                    $this->getType() .
                    ' CREATE'
                );
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
                $this->ctrl->returnToParent($this);
            }
        }
 
        if (!$this->getFirstSource()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->returnToParent($this);
        }
 
        $options = [];
        if ($this->post_wrapper->has("cp_options")) {
            $options = $this->post_wrapper->retrieve(
                "cp_options",
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string())
                )
            );
        }
 
        $this->log->debug('Copy container (sources): ' . print_r($this->getSources(), true));
 
        $orig = ilObjectFactory::getInstanceByRefId($this->getFirstSource());
        $result = $orig->cloneAllObject(
            $_COOKIE[session_name()],
            CLIENT_ID,
            $this->getType(),
            $target_ref_id,
            $this->getFirstSource(),
            $options,
            false,
            $this->getSubMode()
        );
 
        $this->targets_copy_id[$target_ref_id] = $result['copy_id'];
 
        $new_ref_id = (int) $result['ref_id'];
        if ($new_ref_id > 0) {
            $new_obj = ilObjectFactory::getInstanceByRefId((int) $result['ref_id'], false);
            if ($new_obj instanceof ilObject) {
                $this->parent_obj->callCreationCallback(
                    $new_obj,
                    $this->obj_definition,
                    $this->retriever->getMaybeInt('crtcb', 0)
                );
            }
        }
        return $result;
    }

References $_COOKIE, ILIAS\UI\Implementation\Component\Input\Field\$options, CLIENT_ID, ILIAS\Repository\ctrl(), getFirstSource(), ilObjectFactory\getInstanceByRefId(), getSources(), getSubMode(), getType(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by copyContainerToTargets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyContainerToTargets()

ilObjectCopyGUI::copyContainerToTargets ( )

protected

Definition at line 934 of file class.ilObjectCopyGUI.php.

                                               : void
    {
        $this->log->debug('Copy container to targets: ' . print_r($_REQUEST, true));
        $this->log->debug('Source(s): ' . print_r($this->getSources(), true));
        $this->log->debug('Target(s): ' . print_r($this->getTargets(), true));
 
        if ($this->isCopyingParentPageNeeded()) {
            $this->copyParentPage();
        }
 
        $result = 1;
        foreach ($this->getTargets() as $target_ref_id) {
            $result = $this->copyContainer((int) $target_ref_id);
        }
 
        $this->clipboard->clear();
 
        if (ilCopyWizardOptions::_isFinished($result['copy_id'])) {
            $this->log->info('Object copy completed.');
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_duplicated"), true);
            if ($this->getSubMode() == self::SUBMODE_CONTENT_ONLY) {
                $this->ctrl->returnToParent($this);
            }
            $link = ilLink::_getLink($result['ref_id']);
            $this->ctrl->redirectToURL($link);
        } else {
            $this->log->debug('Object copy in progress.');
            $this->showCopyProgress();
        }
    }

References ilCopyWizardOptions\_isFinished(), copyContainer(), copyParentPage(), ILIAS\Repository\ctrl(), getSources(), getSubMode(), getTargets(), isCopyingParentPageNeeded(), ILIAS\Repository\lng(), and showCopyProgress().

Here is the call graph for this function:

◆ copyMultipleNonContainer()

ilObjectCopyGUI::copyMultipleNonContainer ( array $sources )

Copy multiple non container.

Parameters

array $sources array of source ref ids

Definition at line 845 of file class.ilObjectCopyGUI.php.

                                                            : void
    {
        // check permissions
        foreach ($sources as $source_ref_id) {
            $source_type = ilObject::_lookupType($source_ref_id, true);
 
            // Create permission
            // begin-patch mc
            foreach ($this->getTargets() as $target_ref_id) {
                if (!$this->rbacsystem->checkAccess('create', $target_ref_id, $source_type)) {
                    $this->log->notice(
                        'Permission denied for target_id: ' .
                        $target_ref_id .
                        ' source_type: ' .
                        $source_type .
                        ' CREATE'
                    );
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
                    $this->ctrl->returnToParent($this);
                }
            }
 
            // Copy permission
            if (!$this->access->checkAccess('copy', '', $source_ref_id)) {
                $this->log->notice('Permission denied for source_ref_id: ' . $source_ref_id . ' COPY');
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
                $this->ctrl->returnToParent($this);
            }
 
            // check that these objects are really not containers
            if ($this->obj_definition->isContainer($source_type) and $this->getSubMode() != self::SUBMODE_CONTENT_ONLY) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cntr_container_only_on_their_own'), true);
                $this->ctrl->returnToParent($this);
            }
        }
 
        reset($sources);
 
 
        ilLoggerFactory::getLogger('obj')->debug('Copy multiple non containers. Sources: ' . print_r($sources, true));
 
        $new_obj = null;
        // clone
        foreach ($sources as $source_ref_id) {
            ilLoggerFactory::getLogger('obj')->debug('Copying source ref_id : ' . $source_ref_id);
 
            // begin-patch mc
            foreach ($this->getTargets() as $target_ref_id) {
                // Save wizard options
                $copy_id = ilCopyWizardOptions::_allocateCopyId();
                $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
                $wizard_options->saveOwner($this->user->getId());
                $wizard_options->saveRoot((int) $source_ref_id);
                $wizard_options->read();
 
                $orig = ilObjectFactory::getInstanceByRefId((int) $source_ref_id);
                $new_obj = $orig->cloneObject($target_ref_id, $copy_id);
 
                // Delete wizard options
                $wizard_options->deleteAll();
                $this->parent_obj->callCreationCallback(
                    $new_obj,
                    $this->obj_definition,
                    $this->retriever->getMaybeInt('crtcb', 0)
                );
 
                // rbac log
                if (ilRbacLog::isActive()) {
                    $rbac_log_roles = $this->rbacreview->getParentRoleIds($new_obj->getRefId());
                    $rbac_log = ilRbacLog::gatherFaPa($new_obj->getRefId(), array_keys($rbac_log_roles), true);
                    ilRbacLog::add(ilRbacLog::COPY_OBJECT, $new_obj->getRefId(), $rbac_log, (bool) $source_ref_id);
                }
            }
        }
 
        $this->clipboard->clear();
        $this->log->info('Object copy completed.');
        if (count($sources) == 1) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_duplicated"), true);
            $ref_id = $new_obj->getRefId();
        } else {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("objects_duplicated"), true);
            $ref_id = $this->getFirstTarget();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("objects_duplicated"), true);
        ilUtil::redirect(ilLink::_getLink($ref_id));
    }

References $ref_id, $sources, ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), ilObject\_lookupType(), ILIAS\Repository\access(), ilRbacLog\add(), ilRbacLog\COPY_OBJECT, ILIAS\Repository\ctrl(), ilRbacLog\gatherFaPa(), getFirstTarget(), ilObjectFactory\getInstanceByRefId(), ilLoggerFactory\getLogger(), getTargets(), ilRbacLog\isActive(), ILIAS\Repository\lng(), ilUtil\redirect(), and ILIAS\Repository\user().

Referenced by copySingleObject(), and saveTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyParentPage()

ilObjectCopyGUI::copyParentPage ( )

private

Definition at line 971 of file class.ilObjectCopyGUI.php.

                                     : void
    {
        $source_object = ilObjectFactory::getInstanceByRefId($this->getFirstSource());
        $target_object = $this->getParentObject()->getObject();
        if (ilContainerPage::_exists(
            "cont",
            $source_object->getId()
        )) {
            $orig_page = new ilContainerPage($source_object->getId());
            $orig_page->copy($target_object->getId(), "cont", $target_object->getId());
        }
 
        $style_id = ilObjStyleSheet::lookupObjectStyle($source_object->getId());
        if ($style_id <= 0) {
            return;
        }
        if (ilObjStyleSheet::_lookupStandard($style_id)) {
            ilObjStyleSheet::writeStyleUsage($target_object->getId(), $style_id);
            return;
        }
        $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
        $new_id = $style_obj->ilClone();
        ilObjStyleSheet::writeStyleUsage($target_object->getId(), $new_id);
        ilObjStyleSheet::writeOwner($target_object->getId(), $new_id);
        $reuse = $this->container_repo->readReuse($source_object->getRefId());
        $this->container_repo->updateReuse($target_object->getRefId(), $reuse);
    }

References ilPageObject\_exists(), ilObjStyleSheet\_lookupStandard(), getFirstSource(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), getParentObject(), ilObjStyleSheet\lookupObjectStyle(), ilObjStyleSheet\writeOwner(), and ilObjStyleSheet\writeStyleUsage().

Referenced by copyContainerToTargets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copySingleObject()

ilObjectCopyGUI::copySingleObject ( )

protected

Start cloning a single (not container) object.

Definition at line 829 of file class.ilObjectCopyGUI.php.

                                         : void
    {
        // Source defined
        if ($this->getSources() === []) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->returnToParent($this);
        }
 
        $this->copyMultipleNonContainer($this->getSources());
    }

References copyMultipleNonContainer(), ILIAS\Repository\ctrl(), getSources(), and ILIAS\Repository\lng().

Referenced by executeNextStepAfterSourceSelection(), and saveTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjectCopyGUI::executeCommand ( )

Definition at line 138 of file class.ilObjectCopyGUI.php.

                                    : void
    {
        $this->init();
        $this->initTabs();
 
        $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->$cmd();
    }

References ILIAS\Repository\ctrl(), init(), and initTabs().

Here is the call graph for this function:

◆ executeNextStepAfterSourceSelection()

ilObjectCopyGUI::executeNextStepAfterSourceSelection ( )

private

Definition at line 751 of file class.ilObjectCopyGUI.php.

                                                          : void
    {
        if (!$this->obj_definition->isContainer($this->getType())) {
            $this->copySingleObject();
            return;
        }
 
        if (count($this->getSources()) === 1
            && ilContainerPage::_exists(
                'cont',
                ilObject::_lookupObjId($this->getFirstSource())
            )
        ) {
            $this->showCopyPageSelection();
            return;
        }
 
        $this->showItemSelection();
    }

References ilPageObject\_exists(), ilObject\_lookupObjId(), copySingleObject(), getFirstSource(), getSources(), showCopyPageSelection(), and showItemSelection().

Referenced by saveSource(), and saveSourceMembership().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getErrorMessageOnDisallowedObjectTypeForTarget()

ilObjectCopyGUI::getErrorMessageOnDisallowedObjectTypeForTarget ( int $ref_id )

private

Definition at line 707 of file class.ilObjectCopyGUI.php.

                                                                                : string
    {
        foreach ($this->getTargets() as $target_ref_id) {
            $target_type = ilObject::_lookupType($target_ref_id, true);
            $target_class_name = ilObjectFactory::getClassByType($target_type);
            $target_object = new $target_class_name($target_ref_id);
            $possible_subtypes = $target_object->getPossibleSubObjects();
 
            $source_type = ilObject::_lookupType($ref_id, true);
 
            if (!array_key_exists($source_type, $possible_subtypes)
                && $this->getSubMode() != self::SUBMODE_CONTENT_ONLY
                && ($source_type !== 'crs' || $target_type !== 'crs')
            ) {
                return sprintf(
                    $this->lng->txt('msg_obj_may_not_contain_objects_of_type'),
                    $this->lng->txt('obj_' . $target_type),
                    $this->lng->txt('obj_' . $source_type)
                );
            }
        }
 
        return '';
    }

References $ref_id, ilObject\_lookupType(), ilObjectFactory\getClassByType(), getSubMode(), getTargets(), and ILIAS\Repository\lng().

Referenced by saveSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirstSource()

ilObjectCopyGUI::getFirstSource ( )

Definition at line 583 of file class.ilObjectCopyGUI.php.

                                    : int
    {
        if (count($this->sources)) {
            return (int) $this->sources[0];
        }
        return 0;
    }

Referenced by copyContainer(), copyParentPage(), executeNextStepAfterSourceSelection(), init(), saveSourceMembership(), saveTarget(), searchSource(), and showItemSelection().

Here is the caller graph for this function:

◆ getFirstTarget()

ilObjectCopyGUI::getFirstTarget ( )

Definition at line 609 of file class.ilObjectCopyGUI.php.

                                    : int
    {
        if (array_key_exists(0, $this->getTargets())) {
            $targets = $this->getTargets();
            return (int) $targets[0];
        }
        return 0;
    }

References getTargets().

Referenced by copyMultipleNonContainer(), init(), and showSourceSelectionTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

ilObjectCopyGUI::getMode ( )

Definition at line 538 of file class.ilObjectCopyGUI.php.

                             : int
    {
        return $this->mode;
    }

References $mode.

Referenced by setTabs().

Here is the caller graph for this function:

◆ getOnLoadCode()

ilObjectCopyGUI::getOnLoadCode ( string $cmd )

private

Definition at line 396 of file class.ilObjectCopyGUI.php.

                                               : Closure
    {
        return function ($id) use ($cmd) {
            return "document.getElementById('$id')"
                . '.addEventListener("click", '
                . '(e) => {e.preventDefault();'
                . 'e.target.setAttribute("name", "cmd[' . $cmd . ']");'
                . 'e.target.form.requestSubmit(e.target);});';
        };
    }

References $id.

Referenced by showTargetSelectionTree().

Here is the caller graph for this function:

◆ getParentObject()

ilObjectCopyGUI::getParentObject ( )

Get parent gui object.

Definition at line 556 of file class.ilObjectCopyGUI.php.

                                     : ?ilObjectGUI
    {
        return $this->parent_obj;
    }

References $parent_obj.

Referenced by copyParentPage(), and init().

Here is the caller graph for this function:

◆ getPrimaryButtonLabel()

ilObjectCopyGUI::getPrimaryButtonLabel ( )

private

Definition at line 387 of file class.ilObjectCopyGUI.php.

                                            : string
    {
        if ($this->obj_definition->isContainer($this->getType())) {
            return $this->lng->txt('btn_next');
        }
 
        return $this->lng->txt('paste');
    }

References ILIAS\Repository\lng().

Referenced by showTargetSelectionTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSources()

ilObjectCopyGUI::getSources ( )

Definition at line 578 of file class.ilObjectCopyGUI.php.

                                : array
    {
        return $this->sources;
    }

References $sources.

Referenced by copyContainer(), copyContainerToTargets(), copySingleObject(), executeNextStepAfterSourceSelection(), init(), initTargetSelection(), keepObjectsInClipboard(), saveSource(), saveTarget(), showItemSelection(), and showSourceSelectionTree().

Here is the caller graph for this function:

◆ getSubMode()

ilObjectCopyGUI::getSubMode ( )

Definition at line 548 of file class.ilObjectCopyGUI.php.

                                : int
    {
        return $this->sub_mode;
    }

References $sub_mode.

Referenced by copyContainer(), copyContainerToTargets(), getErrorMessageOnDisallowedObjectTypeForTarget(), init(), and setTabs().

Here is the caller graph for this function:

◆ getTargets()

ilObjectCopyGUI::getTargets ( )

Definition at line 604 of file class.ilObjectCopyGUI.php.

                                : array
    {
        return $this->targets;
    }

References $targets.

Referenced by copyContainerToTargets(), copyMultipleNonContainer(), getErrorMessageOnDisallowedObjectTypeForTarget(), getFirstTarget(), init(), initSourceSelection(), saveTarget(), and showItemSelection().

Here is the caller graph for this function:

◆ getType()

ilObjectCopyGUI::getType ( )

Definition at line 561 of file class.ilObjectCopyGUI.php.

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by copyContainer(), init(), initFormSearch(), searchSource(), and showItemSelection().

Here is the caller graph for this function:

◆ init()

ilObjectCopyGUI::init ( )

protected

Definition at line 149 of file class.ilObjectCopyGUI.php.

                             : void
    {
        if ($this->retriever->has('smode')) {
            $this->setSubMode($this->retriever->getMaybeInt('smode') ?? 0);
            $this->ctrl->setParameter($this, 'smode', $this->getSubMode());
            ilLoggerFactory::getLogger('obj')->debug('Submode is: ' . $this->getSubMode());
        }
 
        // save sources
        if ($this->retriever->has('source_ids')) {
            $this->setSource(explode('_', $this->retriever->getMaybeString('source_ids')));
            $this->ctrl->setParameter($this, 'source_ids', implode('_', $this->getSources()));
            ilLoggerFactory::getLogger('obj')->debug('Multiple sources: ' . implode('_', $this->getSources()));
        }
        if ($this->retriever->has('source_id')) {
            $this->setSource([$this->retriever->getMaybeInt('source_id')]);
            $this->ctrl->setParameter($this, 'source_ids', implode('_', $this->getSources()));
            ilLoggerFactory::getLogger('obj')->debug('source_id is set: ' . implode('_', $this->getSources()));
        }
        if ($this->getFirstSource()) {
            $this->setType(
                ilObject::_lookupType(ilObject::_lookupObjId($this->getFirstSource()))
            );
        }
 
        // creation screen: copy section
        if ($this->retriever->has('new_type')) {
            $this->setMode(self::SEARCH_SOURCE);
            $this->setType($this->retriever->getMaybeString('new_type'));
            $this->setTarget($this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int()));
 
            $this->ctrl->setParameter($this, 'new_type', $this->getType());
            $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'new_type', $this->getType());
            $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'cpfl', 1);
            $this->ctrl->setReturnByClass(get_class($this->getParentObject()), 'create');
 
            ilLoggerFactory::getLogger('obj')->debug('Copy from object creation for type: ' . $this->getType());
            return;
        }
        // adopt content, and others?
        elseif ($this->retriever->getMaybeInt('selectMode') === self::SOURCE_SELECTION) {
            $this->setMode(self::SOURCE_SELECTION);
 
            $this->ctrl->setParameterByClass(get_class($this->parent_obj), 'selectMode', self::SOURCE_SELECTION);
            $this->setTarget($this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int()));
            $this->ctrl->setReturnByClass(get_class($this->parent_obj), '');
 
            ilLoggerFactory::getLogger('obj')->debug('Source selection mode. Target is: ' . $this->getFirstTarget());
        } elseif ($this->retriever->getMaybeInt('selectMode') === self::TARGET_SELECTION) {
            $this->setMode(self::TARGET_SELECTION);
            $this->ctrl->setReturnByClass(get_class($this->parent_obj), '');
            ilLoggerFactory::getLogger('obj')->debug('Target selection mode.');
        }
 
        // save targets
        if ($this->retriever->has('target_ids')) {
            $this->setTargets(explode('_', $this->retriever->getMaybeString('target_ids')));
            ilLoggerFactory::getLogger('obj')->debug('targets are: ' . print_r($this->getTargets(), true));
        }
    }

References ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), getFirstSource(), getFirstTarget(), ilLoggerFactory\getLogger(), getParentObject(), getSources(), getSubMode(), getTargets(), getType(), setMode(), setSource(), setSubMode(), setTarget(), setTargets(), and setType().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormSearch()

ilObjectCopyGUI::initFormSearch ( )

protected

Definition at line 1144 of file class.ilObjectCopyGUI.php.

                                       : void
    {
        $this->form = new ilPropertyFormGUI();
        $this->form->setTableWidth('600px');
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        $this->form->setTitle($this->lng->txt($this->getType() . '_copy'));
        $this->form->addCommandButton('searchSource', $this->lng->txt('search_for'));
        $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
 
        $tit = new ilTextInputGUI($this->lng->txt('title'), 'tit');
        $tit->setSize(40);
        $tit->setMaxLength(70);
        $tit->setRequired(true);
        $tit->setInfo($this->lng->txt('wizard_title_info'));
        $this->form->addItem($tit);
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getType(), and ILIAS\Repository\lng().

Referenced by searchSource(), and showSourceSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSourceSelection()

ilObjectCopyGUI::initSourceSelection ( )

protected

Definition at line 288 of file class.ilObjectCopyGUI.php.

                                            : void
    {
        // copy opened nodes from repository explorer
        $node_ids = is_array(ilSession::get('repexpand')) ? ilSession::get('repexpand') : [];
 
        $this->setTabs(self::TAB_GROUP_SC_SELECTION, self::TAB_SELECTION_SOURCE_TREE);
 
        // open current position
        // begin-patch mc
        foreach ($this->getTargets() as $target_ref_id) {
            $path = $this->tree->getPathId($target_ref_id);
            foreach ($path as $node_id) {
                if (!in_array($node_id, $node_ids)) {
                    $node_ids[] = $node_id;
                }
            }
        }
        // end-patch multi copy
 
        ilSession::set('paste_copy_repexpand', $node_ids);
 
        $this->ctrl->setReturnByClass(get_class($this->parent_obj), '');
        $this->showSourceSelectionTree();
    }

References $path, ILIAS\Repository\ctrl(), ilSession\get(), getTargets(), ilSession\set(), setTabs(), and showSourceSelectionTree().

Referenced by adoptContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initTabs()

ilObjectCopyGUI::initTabs ( )

protected

Definition at line 210 of file class.ilObjectCopyGUI.php.

                                 : void
    {
        $this->lng->loadLanguageModule('cntr');
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('cancel'),
            (string) $this->ctrl->getParentReturn($this->parent_obj)
        );
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initTargetSelection()

ilObjectCopyGUI::initTargetSelection ( )

protected

Init copy from repository/search list commands.

Definition at line 259 of file class.ilObjectCopyGUI.php.

                                            : void
    {
        $this->ctrl->setParameter($this, 'selectMode', self::TARGET_SELECTION);
 
        // copy opened nodes from repository explorer
        $node_ids = is_array(ilSession::get('repexpand')) ? ilSession::get('repexpand') : [];
 
        // begin-patch mc
        $this->setTargets([]);
        // cognos-blu-patch: end
 
        // open current position
        foreach ($this->getSources() as $source_id) {
            if ($source_id) {
                $path = $this->tree->getPathId($source_id);
                foreach ($path as $node_id) {
                    if (!in_array($node_id, $node_ids)) {
                        $node_ids[] = $node_id;
                    }
                }
            }
        }
 
        ilSession::set('paste_copy_repexpand', $node_ids);
 
        $this->ctrl->setReturnByClass(get_class($this->parent_obj), '');
        $this->showTargetSelectionTree();
    }

References $path, ILIAS\Repository\ctrl(), ilSession\get(), getSources(), ilSession\set(), setTargets(), and showTargetSelectionTree().

Here is the call graph for this function:

◆ isCopyingParentPageNeeded()

ilObjectCopyGUI::isCopyingParentPageNeeded ( )

private

Definition at line 965 of file class.ilObjectCopyGUI.php.

                                                : bool
    {
        return $this->post_wrapper->has('copy_page')
            && $this->post_wrapper->retrieve('copy_page', $this->refinery->kindlyTo()->bool());
    }

References ILIAS\Repository\refinery().

Referenced by copyContainerToTargets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keepObjectsInClipboard()

ilObjectCopyGUI::keepObjectsInClipboard ( )

Definition at line 626 of file class.ilObjectCopyGUI.php.

                                            : void
    {
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("obj_inserted_clipboard"), true);
        $ilCtrl = $this->ctrl;
        $this->clipboard->setCmd("copy");
        $this->clipboard->setRefIds($this->getSources());
        $ilCtrl->returnToParent($this);
    }

References $ctrl, getSources(), ILIAS\Repository\lng(), and ilCtrl\returnToParent().

Here is the call graph for this function:

◆ saveCopyPage()

ilObjectCopyGUI::saveCopyPage ( )

protected

Definition at line 777 of file class.ilObjectCopyGUI.php.

                                     : void
    {
        $form = $this->buildCopyPageSelectionForm();
        $data = $form->withRequest($this->request)->getData();
 
        $this->showItemSelection($data['copy_page']);
    }

References $data, $form, buildCopyPageSelectionForm(), and showItemSelection().

Here is the call graph for this function:

◆ saveSource()

ilObjectCopyGUI::saveSource ( )

protected

Definition at line 683 of file class.ilObjectCopyGUI.php.

                                   : void
    {
        if (!$this->post_wrapper->has("source")) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->searchSource();
            return;
        }
 
        $source = $this->post_wrapper->retrieve("source", $this->refinery->kindlyTo()->int());
        $this->setSource([$source]);
        $this->setType(ilObject::_lookupType($source, true));
        $this->ctrl->setParameter($this, 'source_id', $source);
 
        foreach ($this->getSources() as $source_ref_id) {
            if (($message = $this->getErrorMessageOnDisallowedObjectTypeForTarget($source_ref_id)) !== '') {
                $this->tpl->setOnScreenMessage('failure', $message);
                $this->searchSource();
                return;
            }
        }
 
        $this->executeNextStepAfterSourceSelection();
    }

References ilObject\_lookupType(), ILIAS\Repository\ctrl(), executeNextStepAfterSourceSelection(), getErrorMessageOnDisallowedObjectTypeForTarget(), getSources(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), searchSource(), setSource(), and setType().

Here is the call graph for this function:

◆ saveSourceMembership()

ilObjectCopyGUI::saveSourceMembership ( )

protected

Save selected source from membership screen.

Definition at line 735 of file class.ilObjectCopyGUI.php.

                                             : void
    {
        $source = $this->retriever->getMaybeInt('source');
        if ($source === null) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->ctrl->redirect($this, 'showSourceSelectionMembership');
            return;
        }
 
        $this->setSource([$source]);
        $this->setType(ilObject::_lookupType($this->getFirstSource(), true));
        $this->ctrl->setParameter($this, 'source_id', $source);
 
        $this->executeNextStepAfterSourceSelection();
    }

References ilObject\_lookupType(), ILIAS\Repository\ctrl(), executeNextStepAfterSourceSelection(), getFirstSource(), ILIAS\Repository\lng(), setSource(), and setType().

Here is the call graph for this function:

◆ saveTarget()

ilObjectCopyGUI::saveTarget ( )

protected

Definition at line 455 of file class.ilObjectCopyGUI.php.

                                   : void
    {
        if (!$this->retriever->has('target')) {
            $this->ctrl->setParameter($this, 'selectMode', self::TARGET_SELECTION);
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->showTargetSelectionTree();
            return;
        }
 
        try {
            $targets = $this->retriever->getArrayOfInt('target');
        } catch (ConstraintViolationException $e) {
            $possible_target = $this->retriever->getMaybeInt('target');
            $targets = $possible_target === null ? [] : [$possible_target];
        }
 
        if ($targets !== []) {
            $this->setTargets($targets);
            $this->ctrl->setParameter($this, 'target_ids', implode('_', $this->getTargets()));
        } elseif (($target = $this->retriever->getMaybeInt('target')) !== null) {
            $this->setTarget($target);
            $this->ctrl->setParameter($this, 'target_ids', implode('_', $this->getTargets()));
        }
 
        // validate allowed subtypes
        foreach ($this->getSources() as $source_ref_id) {
            foreach ($this->getTargets() as $target_ref_id) {
                $target_type = ilObject::_lookupType((int) $target_ref_id, true);
                $target_class_name = ilObjectFactory::getClassByType($target_type);
                $target_object = new $target_class_name((int) $target_ref_id);
                $possible_subtypes = $target_object->getPossibleSubObjects();
 
                $source_type = ilObject::_lookupType((int) $source_ref_id, true);
 
                if (!array_key_exists($source_type, (array) $possible_subtypes)) {
                    $this->tpl->setOnScreenMessage('failure', sprintf(
                        $this->lng->txt('msg_obj_may_not_contain_objects_of_type'),
                        $this->lng->txt('obj_' . $target_type),
                        $this->lng->txt('obj_' . $source_type)
                    ));
                    $this->showTargetSelectionTree();
                    return;
                }
            }
        }
 
        if (count($this->getSources()) == 1 && $this->obj_definition->isContainer($this->getType())) {
            // check, if object should be copied into itself
            // begin-patch mc
            $is_child = [];
            foreach ($this->getTargets() as $target_ref_id) {
                if ($this->tree->isGrandChild($this->getFirstSource(), (int) $target_ref_id)) {
                    $is_child[] = ilObject::_lookupTitle(ilObject::_lookupObjId($this->getFirstSource()));
                }
                if ($this->getFirstSource() == (int) $target_ref_id) {
                    $is_child[] = ilObject::_lookupTitle(ilObject::_lookupObjId($this->getFirstSource()));
                }
            }
            // end-patch multi copy
            if (count($is_child) > 0) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt("msg_not_in_itself") . " " . implode(',', $is_child)
                );
                $this->showTargetSelectionTree();
                return;
            }
 
            $this->showItemSelection();
        } else {
            if (count($this->getSources()) == 1) {
                $this->copySingleObject();
            } else {
                $this->copyMultipleNonContainer($this->getSources());
            }
        }
    }

References Vendor\Package\$e, $targets, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), copyMultipleNonContainer(), copySingleObject(), ILIAS\Repository\ctrl(), ilObjectFactory\getClassByType(), getFirstSource(), getSources(), getTargets(), ILIAS\Repository\lng(), setTarget(), setTargets(), showItemSelection(), and showTargetSelectionTree().

Here is the call graph for this function:

◆ searchSource()

ilObjectCopyGUI::searchSource ( )

protected

Definition at line 635 of file class.ilObjectCopyGUI.php.

                                     : void
    {
        if ($this->post_wrapper->has('tit')) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('wizard_search_list'));
            ilSession::set('source_query', $this->post_wrapper->retrieve("tit", $this->refinery->kindlyTo()->string()));
        }
 
        $this->initFormSearch();
        $this->form->setValuesByPost();
 
        if (!$this->form->checkInput()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_search_string'), true);
            $this->ctrl->returnToParent($this);
            return;
        }
 
        $tit = $this->form->getInput('tit');
        if ($tit === "") {
            $tit = ilSession::get('source_query', '');
        }
        $query_parser = new ilQueryParser($tit);
        $query_parser->setMinWordLength(1);
        $query_parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
        $query_parser->parse();
        if (!$query_parser->validate()) {
            $this->tpl->setOnScreenMessage('failure', $query_parser->getMessage(), true);
            $this->ctrl->returnToParent($this);
        }
 
        // only like search since fulltext does not support search with less than 3 characters
        $object_search = new ilLikeObjectSearch($query_parser);
        $object_search->setFilter([$this->retriever->getMaybeString('new_type')]);
        $res = $object_search->performSearch();
        $res->setRequiredPermission('copy');
        $res->filter(ROOT_FOLDER_ID, true);
 
        if (!count($results = $res->getResultsByObjId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('search_no_match'), true);
            $this->ctrl->returnToParent($this);
        }
 
        $table = new ilObjectCopySearchResultTableGUI($this, 'searchSource', $this->getType());
        $table->setFormAction($this->ctrl->getFormAction($this));
        $table->setSelectedReference($this->getFirstSource());
        $table->parseSearchResults($results);
        $this->tpl->setContent($table->getHTML());
    }

References $res, $results, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilSession\get(), getFirstSource(), getType(), initFormSearch(), ILIAS\Repository\lng(), ilQueryParser\QP_COMBINATION_AND, ROOT_FOLDER_ID, and ilSession\set().

Referenced by saveSource(), and showItemSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMode()

ilObjectCopyGUI::setMode ( int $mode )

Definition at line 533 of file class.ilObjectCopyGUI.php.

                                      : void
    {
        $this->mode = $mode;
    }

References $mode.

Referenced by adoptContent(), and init().

Here is the caller graph for this function:

◆ setSource()

ilObjectCopyGUI::setSource ( array $source_ids )

Definition at line 571 of file class.ilObjectCopyGUI.php.

                                                : void
    {
        $this->sources = $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())->transform(
            $source_ids
        );
    }

References ILIAS\Repository\refinery().

Referenced by init(), saveSource(), saveSourceMembership(), and unsetSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubMode()

ilObjectCopyGUI::setSubMode ( int $mode )

Definition at line 543 of file class.ilObjectCopyGUI.php.

                                         : void
    {
        $this->sub_mode = $mode;
    }

References $mode.

Referenced by adoptContent(), and init().

Here is the caller graph for this function:

◆ setTabs()

ilObjectCopyGUI::setTabs	(	int	$tab_group,
		int	$active_tab
	)

protected

Definition at line 220 of file class.ilObjectCopyGUI.php.

                                                               : void
    {
        if ($tab_group == self::TAB_GROUP_SC_SELECTION) {
            if ($this->getSubMode() == self::SUBMODE_CONTENT_ONLY) {
                if ($this->getMode() == self::SOURCE_SELECTION) {
                    $this->tabs->addTab(
                        (string) self::TAB_SELECTION_SOURCE_TREE,
                        $this->lng->txt('cntr_copy_repo_tree'),
                        $this->ctrl->getLinkTarget($this, 'initSourceSelection')
                    );
                    $this->tabs->addTab(
                        (string) self::TAB_SELECTION_MEMBERSHIP,
                        $this->lng->txt('cntr_copy_crs_grp'),
                        $this->ctrl->getLinkTarget($this, 'showSourceSelectionMembership')
                    );
                }
            }
        }
        $this->tabs->activateTab((string) $active_tab);
    }

References getMode(), getSubMode(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by initSourceSelection(), and showSourceSelectionMembership().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTarget()

ilObjectCopyGUI::setTarget ( int $ref_id )

Definition at line 592 of file class.ilObjectCopyGUI.php.

                                          : void
    {
        $this->setTargets([$ref_id]);
    }

References setTargets().

Referenced by adoptContent(), init(), and saveTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTargets()

ilObjectCopyGUI::setTargets ( array $targets )

Definition at line 597 of file class.ilObjectCopyGUI.php.

                                              : void
    {
        $this->targets = $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())->transform(
            $targets
        );
    }

References ILIAS\Repository\refinery().

Referenced by init(), initTargetSelection(), saveTarget(), and setTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType()

ilObjectCopyGUI::setType ( string $type )

Definition at line 566 of file class.ilObjectCopyGUI.php.

                                         : void
    {
        $this->type = $type;
    }

References $type.

Referenced by init(), saveSource(), and saveSourceMembership().

Here is the caller graph for this function:

◆ showCopyPageSelection()

ilObjectCopyGUI::showCopyPageSelection ( )

protected

Definition at line 771 of file class.ilObjectCopyGUI.php.

                                              : void
    {
        $form = $this->buildCopyPageSelectionForm();
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

References $form, and buildCopyPageSelectionForm().

Referenced by executeNextStepAfterSourceSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showCopyProgress()

ilObjectCopyGUI::showCopyProgress ( )

protected

Definition at line 999 of file class.ilObjectCopyGUI.php.

                                         : void
    {
        $ref_id = ROOT_FOLDER_ID;
        if ($this->request_wrapper->has('ref_id')) {
            $ref_id = $this->request_wrapper->retrieve(
                'ref_id',
                $this->refinery->kindlyTo()->int()
            );
        }
 
        $this->tabs->setBackTarget(
            $this->lng->txt('tab_back_to_repository'),
            (string) $this->ctrl->getParentReturn($this->parent_obj)
        );
 
        $progress = new ilObjectCopyProgressTableGUI(
            new DataFactory(),
            $this->ui_renderer,
            $this->ui_factory,
            $this,
            'showCopyProgress',
            $ref_id
        );
        $progress->setObjectInfo($this->targets_copy_id);
        $progress->parse();
        $progress->init();
        $link = ilLink::_getLink($ref_id);
        $progress->setRedirectionUrl($link);
 
        $this->tpl->setContent($progress->getHTML());
    }

References $ref_id, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, and ILIAS\Repository\tabs().

Referenced by copyContainerToTargets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showItemSelection()

ilObjectCopyGUI::showItemSelection ( bool $copy_page = false )

protected

Definition at line 805 of file class.ilObjectCopyGUI.php.

                                                                 : void
    {
        if (!count($this->getSources())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->searchSource();
            return;
        }
 
        $this->log->debug('Source(s): ' . print_r($this->getSources(), true));
        $this->log->debug('Target(s): ' . print_r($this->getTargets(), true));
 
        $this->tpl->setOnScreenMessage('info', $this->lng->txt($this->getType() . '_copy_threads_info'));
        $this->tpl->addJavaScript('assets/js/ilContainer.js');
        $this->tpl->setVariable('BODY_ATTRIBUTES', 'onload="ilDisableChilds(\'cmd\');"');
 
        $table = new ilObjectCopySelectionTableGUI($this, 'showItemSelection', $this->getType(), $copy_page);
        $table->parseSource($this->getFirstSource());
 
        $this->tpl->setContent($table->getHTML());
    }

References getFirstSource(), getSources(), getTargets(), getType(), ILIAS\Repository\lng(), and searchSource().

Referenced by executeNextStepAfterSourceSelection(), saveCopyPage(), and saveTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSourceSearch()

ilObjectCopyGUI::showSourceSearch ( ?string $tpl_var )

Show init screen Normally shown below the create and import form when creating a new object.

Parameters

?string $tpl_var The tpl variable to fill

Definition at line 1131 of file class.ilObjectCopyGUI.php.

                                                      : ?ilPropertyFormGUI
    {
        $this->unsetSession();
        $this->initFormSearch();
 
        if ($tpl_var) {
            $this->tpl->setVariable($tpl_var, $this->form->getHTML());
            return null;
        }
 
        return $this->form;
    }

References $form, ILIAS\Repository\form(), initFormSearch(), and unsetSession().

Here is the call graph for this function:

◆ showSourceSelectionMembership()

ilObjectCopyGUI::showSourceSelectionMembership ( )

protected

show target selection membership

Definition at line 317 of file class.ilObjectCopyGUI.php.

                                                      : void
    {
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('msg_copy_clipboard_source'));
        $this->setTabs(self::TAB_GROUP_SC_SELECTION, self::TAB_SELECTION_MEMBERSHIP);
 
        $cgs = new ilObjectCopyCourseGroupSelectionTableGUI(
            $this,
            'showSourceSelectionMembership',
            'copy_selection_mmbrs'
        );
        $cgs->init();
        $cgs->setObjects(
            array_merge(
                ilParticipants::_getMembershipByType($this->user->getId(), ['crs']),
                ilParticipants::_getMembershipByType($this->user->getId(), ['grp'])
            )
        );
        $cgs->parse();
 
        $this->tpl->setContent($cgs->getHTML());
    }

References ilParticipants\_getMembershipByType(), ILIAS\Repository\lng(), setTabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ showSourceSelectionTree()

ilObjectCopyGUI::showSourceSelectionTree ( )

protected

Definition at line 407 of file class.ilObjectCopyGUI.php.

                                                : void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.paste_into_multiple_objects.html',
            "components/ILIAS/ILIASObject"
        );
 
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('msg_copy_clipboard_source'));
        $exp = new ilPasteIntoMultipleItemsExplorer(
            ilPasteIntoMultipleItemsExplorer::SEL_TYPE_RADIO,
            'ilias.php?baseClass=ilRepositoryGUI&amp;cmd=goto',
            'paste_copy_repexpand'
        );
        $exp->setRequiredFormItemPermission('visible,read,copy');
 
        $this->ctrl->setParameter($this, 'selectMode', self::SOURCE_SELECTION);
        $exp->setExpandTarget($this->ctrl->getLinkTarget($this, 'showSourceSelectionTree'));
        $exp->setTargetGet('ref_id');
        $exp->setPostVar('source');
        $exp->setCheckedItems($this->getSources());
        $exp->highlightNode((string) $this->getFirstTarget());
 
        // Filter to container
        foreach (['cat', 'root', 'fold'] as $container) {
            $exp->removeFormItemForType($container);
        }
 
        if (!$this->request_wrapper->has("paste_copy_repexpand")) {
            $expanded = $this->tree->readRootId();
        } else {
            $expanded = $this->request_wrapper->retrieve("paste_copy_repexpand", $this->refinery->kindlyTo()->int());
        }
 
        $this->tpl->setVariable('FORM_TARGET', '_self');
        $this->tpl->setVariable('FORM_ACTION', $this->ctrl->getFormAction($this, 'copySelection'));
 
        $exp->setExpand($expanded);
        // build html-output
        $exp->setOutput(0);
        $output = $exp->getOutput();
 
        $this->tpl->setVariable('OBJECT_TREE', $output);
        $this->tpl->setVariable('CMD_SUBMIT', 'saveSource');
        $this->tpl->setVariable('TXT_SUBMIT', $this->lng->txt('btn_next'));
    }

References $container, ILIAS\Repository\ctrl(), getFirstTarget(), getSources(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilPasteIntoMultipleItemsExplorer\SEL_TYPE_RADIO.

Referenced by initSourceSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showTargetSelectionTree()

ilObjectCopyGUI::showTargetSelectionTree ( )

protected

Definition at line 339 of file class.ilObjectCopyGUI.php.

                                                : void
    {
        if ($this->obj_definition->isContainer($this->getType())) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('msg_copy_clipboard_container'));
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('msg_copy_clipboard'));
        }
 
        $exp = new ilRepositorySelectorExplorerGUI($this, "showTargetSelectionTree");
        $exp->setTypeWhiteList(["root", "cat", "grp", "crs", "fold", "lso", "prg"]);
        $exp->setSelectMode("target", true);
        if ($exp->handleCommand()) {
            return;
        }
        $output = $exp->getHTML();
 
        $t = new ilToolbarGUI();
        $t->setFormAction($this->ctrl->getFormAction($this, "saveTarget"));
        $primary_button = $this->ui_factory->button()->primary(
            $this->getPrimaryButtonLabel(),
            ''
        )->withOnLoadCode($this->getOnLoadCode('saveTarget'));
        $t->addComponent($primary_button);
        $t->addSeparator();
 
        $clipboard_btn = $this->ui_factory->button()->standard(
            $this->lng->txt('obj_insert_into_clipboard'),
            ''
        )->withOnLoadCode($this->getOnLoadCode('keepObjectsInClipboard'));
        $t->addComponent($clipboard_btn);
 
        $cancel_btn = $this->ui_factory->button()->standard(
            $this->lng->txt('cancel'),
            ''
        )->withOnLoadCode($this->getOnLoadCode('cancel'));
        $t->addComponent($cancel_btn);
 
        $t->setCloseFormTag(false);
        $t->setLeadingImage(ilUtil::getImagePath("nav/arrow_upright.svg"), " ");
        $output = $t->getHTML() . $output;
        $t->setLeadingImage(ilUtil::getImagePath("nav/arrow_downright.svg"), " ");
        $t->setCloseFormTag(true);
        $t->setOpenFormTag(false);
        $output .= "<br />" . $t->getHTML();
 
        $this->tpl->setContent($output);
    }

References ILIAS\Repository\ctrl(), ilUtil\getImagePath(), getOnLoadCode(), getPrimaryButtonLabel(), and ILIAS\Repository\lng().

Referenced by initTargetSelection(), and saveTarget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsetSession()

ilObjectCopyGUI::unsetSession ( )

protected

Unset session variables.

Definition at line 1165 of file class.ilObjectCopyGUI.php.

                                     : void
    {
        ilSession::clear('source_query');
        $this->setSource([]);
    }

References ilSession\clear(), and setSource().

Referenced by showSourceSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateProgress()

ilObjectCopyGUI::updateProgress ( )

protected

Definition at line 1031 of file class.ilObjectCopyGUI.php.

                                       : void
    {
        $max_steps = $this->retriever->getMaybeInt('_max_steps');
        $copy_id = $this->retriever->getMaybeInt('_copy_id');
        $options = ilCopyWizardOptions::_getInstance($copy_id);
        $required_steps = $options->getRequiredSteps();
 
        if ($required_steps === 0) {
            $state = $this->ui_factory->progress()->state()->bar()
                ->success($this->lng->txt('obj_copy_progress_success'));
            $this->log->debug('Update copy progress: 100%');
        } else {
            $completed_steps = $max_steps - $required_steps;
            $percentage = (int) min(
                floor(($completed_steps / $max_steps) * 100),
                99
            );
            $state = $this->ui_factory->progress()->state()->bar()
                ->determinate($percentage);
            $this->log->debug("Update copy progress: {$percentage}%");
        }
 
        $html = $this->ui_renderer->renderAsync($state);
 
        $this->http->saveResponse(
            $this->http->response()
                ->withHeader('Content-Type', 'text/html; charset=utf-8')
                ->withBody(Streams::ofString($html))
        );
        $this->http->sendResponse();
        $this->http->close();
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ilCopyWizardOptions\_getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilObjectCopyGUI::$access

protected

Definition at line 66 of file class.ilObjectCopyGUI.php.

◆ $clipboard

ClipboardManager ilObjectCopyGUI::$clipboard

protected

Definition at line 84 of file class.ilObjectCopyGUI.php.

◆ $container_repo

ContainerDBRepository ilObjectCopyGUI::$container_repo

protected

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

◆ $ctrl

ilCtrl ilObjectCopyGUI::$ctrl

protected

Definition at line 60 of file class.ilObjectCopyGUI.php.

Referenced by cancel(), and keepObjectsInClipboard().

◆ $error

ilErrorHandling ilObjectCopyGUI::$error

protected

Definition at line 67 of file class.ilObjectCopyGUI.php.

◆ $form

ilPropertyFormGUI ilObjectCopyGUI::$form

protected

Definition at line 92 of file class.ilObjectCopyGUI.php.

Referenced by saveCopyPage(), showCopyPageSelection(), and showSourceSearch().

◆ $http

GlobalHttpState ilObjectCopyGUI::$http

protected

Definition at line 79 of file class.ilObjectCopyGUI.php.

◆ $lng

ilLanguage ilObjectCopyGUI::$lng

protected

Definition at line 72 of file class.ilObjectCopyGUI.php.

◆ $log

ilLogger ilObjectCopyGUI::$log

protected

Definition at line 71 of file class.ilObjectCopyGUI.php.

◆ $mode

int ilObjectCopyGUI::$mode = 0

protected

Definition at line 86 of file class.ilObjectCopyGUI.php.

Referenced by getMode(), setMode(), and setSubMode().

◆ $obj_data_cache

ilObjectDataCache ilObjectCopyGUI::$obj_data_cache

protected

Definition at line 65 of file class.ilObjectCopyGUI.php.

◆ $obj_definition

ilObjectDefinition ilObjectCopyGUI::$obj_definition

protected

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

◆ $parent_obj

ImplementsCreationCallback ilObjectCopyGUI::$parent_obj = null

protected

Definition at line 83 of file class.ilObjectCopyGUI.php.

Referenced by getParentObject().

◆ $post_wrapper

ArrayBasedRequestWrapper ilObjectCopyGUI::$post_wrapper

protected

Definition at line 74 of file class.ilObjectCopyGUI.php.

◆ $rbacreview

ilRbacReview ilObjectCopyGUI::$rbacreview

protected

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

◆ $rbacsystem

ilRbacSystem ilObjectCopyGUI::$rbacsystem

protected

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

◆ $refinery

Refinery ilObjectCopyGUI::$refinery

protected

Definition at line 75 of file class.ilObjectCopyGUI.php.

◆ $request

ServerRequestInterface ilObjectCopyGUI::$request

protected

Definition at line 76 of file class.ilObjectCopyGUI.php.

◆ $request_wrapper

RequestWrapper ilObjectCopyGUI::$request_wrapper

protected

Definition at line 73 of file class.ilObjectCopyGUI.php.

◆ $retriever

ilObjectRequestRetriever ilObjectCopyGUI::$retriever

private

Definition at line 93 of file class.ilObjectCopyGUI.php.

◆ $sources

array ilObjectCopyGUI::$sources = []

protected

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

Referenced by copyMultipleNonContainer(), and getSources().

◆ $sub_mode

int ilObjectCopyGUI::$sub_mode = self::SUBMODE_COMPLETE

protected

Definition at line 87 of file class.ilObjectCopyGUI.php.

Referenced by getSubMode().

◆ $tabs

ilTabsGUI ilObjectCopyGUI::$tabs

protected

Definition at line 62 of file class.ilObjectCopyGUI.php.

◆ $targets

array ilObjectCopyGUI::$targets = []

protected

Definition at line 90 of file class.ilObjectCopyGUI.php.

Referenced by getTargets(), and saveTarget().

◆ $targets_copy_id

array ilObjectCopyGUI::$targets_copy_id = []

protected

Definition at line 91 of file class.ilObjectCopyGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilObjectCopyGUI::$tpl

protected

Definition at line 63 of file class.ilObjectCopyGUI.php.

◆ $tree

ilTree ilObjectCopyGUI::$tree

protected

Definition at line 61 of file class.ilObjectCopyGUI.php.

◆ $type

string ilObjectCopyGUI::$type = ''

protected

Definition at line 88 of file class.ilObjectCopyGUI.php.

Referenced by getType(), and setType().

◆ $ui_factory

UIFactory ilObjectCopyGUI::$ui_factory

protected

Definition at line 77 of file class.ilObjectCopyGUI.php.

◆ $ui_renderer

UIRenderer ilObjectCopyGUI::$ui_renderer

protected

Definition at line 78 of file class.ilObjectCopyGUI.php.

◆ $user

ilObjUser ilObjectCopyGUI::$user

protected

Definition at line 69 of file class.ilObjectCopyGUI.php.

◆ SEARCH_SOURCE

const ilObjectCopyGUI::SEARCH_SOURCE = 3

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

◆ SOURCE_SELECTION

const ilObjectCopyGUI::SOURCE_SELECTION = 1

Definition at line 45 of file class.ilObjectCopyGUI.php.

◆ SUBMODE_COMPLETE

const ilObjectCopyGUI::SUBMODE_COMPLETE = 1

Definition at line 49 of file class.ilObjectCopyGUI.php.

◆ SUBMODE_CONTENT_ONLY

const ilObjectCopyGUI::SUBMODE_CONTENT_ONLY = 2

Definition at line 50 of file class.ilObjectCopyGUI.php.

Referenced by ilObjectCopySelectionTableGUI\__construct().

◆ TAB_GROUP_SC_SELECTION

const ilObjectCopyGUI::TAB_GROUP_SC_SELECTION = 1

Definition at line 58 of file class.ilObjectCopyGUI.php.

◆ TAB_SELECTION_MEMBERSHIP

const ilObjectCopyGUI::TAB_SELECTION_MEMBERSHIP = 3

Definition at line 55 of file class.ilObjectCopyGUI.php.

◆ TAB_SELECTION_SOURCE_TREE

const ilObjectCopyGUI::TAB_SELECTION_SOURCE_TREE = 2

Definition at line 54 of file class.ilObjectCopyGUI.php.

◆ TAB_SELECTION_TARGET_TREE

const ilObjectCopyGUI::TAB_SELECTION_TARGET_TREE = 1

Definition at line 53 of file class.ilObjectCopyGUI.php.

◆ TARGET_SELECTION

const ilObjectCopyGUI::TARGET_SELECTION = 2

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

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

components/ILIAS/ILIASObject/classes/class.ilObjectCopyGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ adoptContent()

◆ buildCopyPageSelectionForm()

◆ cancel()

◆ copyContainer()

◆ copyContainerToTargets()

◆ copyMultipleNonContainer()

◆ copyParentPage()

◆ copySingleObject()

◆ executeCommand()

◆ executeNextStepAfterSourceSelection()

◆ getErrorMessageOnDisallowedObjectTypeForTarget()

◆ getFirstSource()

◆ getFirstTarget()

◆ getMode()

◆ getOnLoadCode()

◆ getParentObject()

◆ getPrimaryButtonLabel()

◆ getSources()

◆ getSubMode()

◆ getTargets()

◆ getType()

◆ init()

◆ initFormSearch()

◆ initSourceSelection()

◆ initTabs()

◆ initTargetSelection()

◆ isCopyingParentPageNeeded()

◆ keepObjectsInClipboard()

◆ saveCopyPage()

◆ saveSource()

◆ saveSourceMembership()

◆ saveTarget()

◆ searchSource()

◆ setMode()

◆ setSource()

◆ setSubMode()

◆ setTabs()

◆ setTarget()

◆ setTargets()

◆ setType()

◆ showCopyPageSelection()

◆ showCopyProgress()

◆ showItemSelection()

◆ showSourceSearch()

◆ showSourceSelectionMembership()

◆ showSourceSelectionTree()

◆ showTargetSelectionTree()

◆ unsetSession()

◆ updateProgress()

Field Documentation

◆ $access

◆ $clipboard

◆ $container_repo

◆ $ctrl

◆ $error

◆ $form

◆ $http

◆ $lng

◆ $log

◆ $mode

◆ $obj_data_cache

◆ $obj_definition

◆ $parent_obj

◆ $post_wrapper

◆ $rbacreview

◆ $rbacsystem

◆ $refinery

◆ $request

◆ $request_wrapper

◆ $retriever

◆ $sources

◆ $sub_mode