ilObjectCopyGUI Class Reference

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

Collaboration diagram for ilObjectCopyGUI:

Public Member Functions
	__construct ($a_parent_gui)
	Constructor. More...
	executeCommand ()
	Control class handling. More...
	showTargetSelectionTree ()
	Show target selection. More...
	showSourceSelectionTree ()
	Show target selection. More...
	setMode ($a_mode)
	set copy mode More...
	getMode ()
	get copy mode More...
	setSubMode ($a_mode)
	getSubMode ()
	getParentObject ()
	Get parent gui object. More...
	getType ()
	Returns $type. More...
	setType ($type)
	Sets $type. More...
	setSource (array $a_source_ids)
	Set source id. More...
	getSources ()
	Get sources. More...
	getFirstSource ()
	setTarget ($a_ref_id)
	Set single object target. More...
	setTargets (array $a_target)
	Set target id. More...
	getTargets ()
	Get copy target. More...
	getFirstTarget ()
	Get first target. More...
	keepObjectsInClipboard ()
	Keep objects in clipboard. More...
	copyMultipleNonContainer ($a_sources)
	Copy multiple non container. More...
	showSourceSearch ($a_tplvar)
	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 ()
	Init return, mode. More...
	initTabs ()
	Init tabs General. More...
	setTabs ($a_tab_group, $a_active_tab)
	Set tabs. More...
	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 ()
	Init source selection. More...
	showSourceSelectionMembership ()
	show target selection membership More...
	saveTarget ()
	Save target selection. More...
	cancel ()
	Cancel workflow. More...
	searchSource ()
	Search source. More...
	saveSource ()
	select source object More...
	saveSourceMembership ()
	Save selected source from membership screen. More...
	showItemSelection ()
	copySingleObject ()
	Start cloning a single (not container) object. More...
	copyContainerToTargets ()
	Copy to multiple targets. More...
	showCopyProgress ()
	Show progress for copying. More...
	updateProgress ()
	Update progress. More...
	copyContainer ($a_target)
	Copy a container. More...
	sourceExists ()
	Check if there is any source object. More...
	initFormSearch ()
	Init search form. More...
	unsetSession ()
	Unset session variables. More...

Protected Attributes
	$ctrl
	$tree
	$tabs
	$toolbar
	$tpl
	$obj_definition
	$obj_data_cache
	$access
	$error
	$rbacsystem
	$user
	$rbacreview

Private Attributes
	$mode = 0
	$sub_mode = self::SUBMODE_COMPLETE
	$lng
	$parent_obj = null
	$type = ''
	$sources = array()
	$targets = array()
	$targets_copy_id = array()
	$log = null

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

Version

$Id$

ilObjectCopyGUI:

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

Constructor & Destructor Documentation

__construct()

ilObjectCopyGUI::__construct

(

$a_parent_gui

)

Constructor.

Returns

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

References $DIC, $ilCtrl, $lng, ilLoggerFactory\getLogger(), and user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tree = $DIC->repositoryTree();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->tpl = $DIC["tpl"];
        $this->obj_definition = $DIC["objDefinition"];
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->access = $DIC->access();
        $this->error = $DIC["ilErr"];
        $this->rbacsystem = $DIC->rbac()->system();
        $this->user = $DIC->user();
        $this->rbacreview = $DIC->rbac()->review();
        $this->log = $DIC["ilLog"];
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        
        $this->lng = $lng;
        $this->lng->loadLanguageModule('search');
        $this->lng->loadLanguageModule('obj');

        $this->parent_obj = $a_parent_gui;
        
        $this->log = ilLoggerFactory::getLogger('obj');
    }

Here is the call graph for this function:

Member Function Documentation

adoptContent()

ilObjectCopyGUI::adoptContent ( )

protected

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

Returns

type

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

References $_GET, $ctrl, $ilCtrl, initSourceSelection(), setMode(), setSubMode(), and setTarget().

    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter($this, 'smode', self::SUBMODE_CONTENT_ONLY);
        $ilCtrl->setParameter($this, 'selectMode', self::SOURCE_SELECTION);
        
        
        $this->setSubMode(self::SUBMODE_CONTENT_ONLY);
        $this->setMode(self::SOURCE_SELECTION);
        $this->setTarget((int) $_GET['ref_id']);
        
        
        return $this->initSourceSelection();
    }

Here is the call graph for this function:

cancel()

ilObjectCopyGUI::cancel ( )

protected

Cancel workflow.

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

References $ctrl, and $ilCtrl.

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

copyContainer()

ilObjectCopyGUI::copyContainer (   $a_target )

protected

Copy a container.

Returns

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

References $_COOKIE, $_POST, $access, $ctrl, $error, $ilCtrl, $ilErr, $ilLog, $ilUser, $log, PHPMailer\PHPMailer\$options, $rbacsystem, $result, $target_type, $tree, $user, ilObject\_lookupObjId(), ilObject\_lookupType(), getFirstSource(), ilObjectFactory\getInstanceByRefId(), ilLoggerFactory\getLogger(), getSources(), getSubMode(), getType(), and ilUtil\sendFailure().

Referenced by copyContainerToTargets().

    {
        $ilLog = $this->log;
        $ilCtrl = $this->ctrl;
        
        include_once('./Services/Link/classes/class.ilLink.php');
        include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
        
        $ilAccess = $this->access;
        $ilErr = $this->error;
        $rbacsystem = $this->rbacsystem;
        $tree = $this->tree;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        // Workaround for course in course copy

        $target_type = ilObject::_lookupType(ilObject::_lookupObjId($a_target));
        $source_type = ilObject::_lookupType(ilObject::_lookupObjId($this->getFirstSource()));
        
        if ($this->getSubMode() != self::SUBMODE_CONTENT_ONLY) {
            if (!$rbacsystem->checkAccess('create', $a_target, $this->getType())) {
                $this->log->notice('Permission denied for target: ' . $a_target . ' type: ' . $this->getType() . ' CREATE');
                ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
                $ilCtrl->returnToParent($this);
            }
        }
        if (!$this->getFirstSource()) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $ilCtrl->returnToParent($this);
            return false;
        }

        $options = $_POST['cp_options'] ? $_POST['cp_options'] : array();
        
        
        ilLoggerFactory::getLogger('obj')->debug('Copy container (sources): ' . print_r($this->getSources(), true));
        
        $orig = ilObjectFactory::getInstanceByRefId($this->getFirstSource());
        $result = $orig->cloneAllObject(
            $_COOKIE[session_name()],
            $_COOKIE['ilClientId'],
            $this->getType(),
            $a_target,
            $this->getFirstSource(),
            $options,
            false,
            $this->getSubMode()
        );
        
        $this->targets_copy_id[$a_target] = $result['copy_id'];

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyContainerToTargets()

ilObjectCopyGUI::copyContainerToTargets ( )

protected

Copy to multiple targets.

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

References $_SESSION, $ctrl, $ilCtrl, $result, ilLink\_getLink(), ilCopyWizardOptions\_isFinished(), copyContainer(), ilLoggerFactory\getLogger(), getSources(), getSubMode(), getTargets(), and showCopyProgress().

    {
        $ilCtrl = $this->ctrl;
        
        ilLoggerFactory::getLogger('obj')->debug('Copy container to targets: ' . print_r($_REQUEST, true));
        ilLoggerFactory::getLogger('obj')->debug('Source(s): ' . print_r($this->getSources(), true));
        ilLoggerFactory::getLogger('obj')->debug('Target(s): ' . print_r($this->getTargets(), true));
        
        
        $last_target = 0;
        $result = 1;
        foreach ($this->getTargets() as $target_ref_id) {
            $result = $this->copyContainer($target_ref_id);
            $last_target = $target_ref_id;
        }
        
        unset($_SESSION["clipboard"]["ref_ids"]);
        unset($_SESSION["clipboard"]["cmd"]);
        
        include_once './Services/CopyWizard/classes/class.ilCopyWizardOptions.php';
        if (ilCopyWizardOptions::_isFinished($result['copy_id'])) {
            ilLoggerFactory::getLogger('obj')->info('Object copy completed.');
            ilUtil::sendSuccess($this->lng->txt("object_duplicated"), true);
            if ($this->getSubMode() == self::SUBMODE_CONTENT_ONLY) {
                // return to parent container
                return $this->ctrl->returnToParent($this);
            }
            // return to last target
            $link = ilLink::_getLink($result['ref_id']);
            $ilCtrl->redirectToUrl($link);
        } else {
            // show progress
            ilLoggerFactory::getLogger('obj')->debug('Object copy in progress.');
            return $this->showCopyProgress();
        }
    }

Here is the call graph for this function:

copyMultipleNonContainer()

ilObjectCopyGUI::copyMultipleNonContainer

(

$a_sources

)

Copy multiple non container.

Parameters

array

$a_sources

array of source ref ids

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

References $_SESSION, $access, $ctrl, $ilCtrl, $ilUser, $obj_definition, $rbacreview, $rbacsystem, $user, ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), ilLink\_getLink(), ilObject\_lookupType(), ilRbacLog\add(), ilRbacLog\COPY_OBJECT, ilRbacLog\gatherFaPa(), getFirstTarget(), ilObjectFactory\getInstanceByRefId(), ilLoggerFactory\getLogger(), getSubMode(), getTargets(), ilRbacLog\isActive(), ilUtil\redirect(), and ilUtil\sendFailure().

Referenced by copySingleObject(), and saveTarget().

    {
        $ilAccess = $this->access;
        $objDefinition = $this->obj_definition;
        $rbacsystem = $this->rbacsystem;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $rbacreview = $this->rbacreview;


        include_once('./Services/Link/classes/class.ilLink.php');
        include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');

        // check permissions
        foreach ($a_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 (!$rbacsystem->checkAccess('create', $target_ref_id, $source_type)) {
                    $this->log->notice('Permission denied for target_id: ' . $target_ref_id . ' source_type: ' . $source_type . ' CREATE');
                    ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
                    $ilCtrl->returnToParent($this);
                }
            }

            // Copy permission
            if (!$ilAccess->checkAccess('copy', '', $source_ref_id)) {
                $this->log->notice('Permission denied for source_ref_id: ' . $source_ref_id . ' COPY');
                ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
                $ilCtrl->returnToParent($this);
            }

            // check that these objects are really not containers
            if ($objDefinition->isContainer($source_type) and $this->getSubMode() != self::SUBMODE_CONTENT_ONLY) {
                ilUtil::sendFailure($this->lng->txt('cntr_container_only_on_their_own'), true);
                $ilCtrl->returnToParent($this);
            }
        }

        reset($a_sources);
        
        
        ilLoggerFactory::getLogger('obj')->debug('Copy multiple non containers. Sources: ' . print_r($a_sources, true));

        // clone
        foreach ($a_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($ilUser->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();

                // rbac log
                include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                if (ilRbacLog::isActive()) {
                    $rbac_log_roles = $rbacreview->getParentRoleIds($new_obj->getRefId(), false);
                    $rbac_log = ilRbacLog::gatherFaPa($new_obj->getRefId(), array_keys($rbac_log_roles), true);
                    ilRbacLog::add(ilRbacLog::COPY_OBJECT, $new_obj->getRefId(), $rbac_log, (int) $source_ref_id);
                }
            }
        }

        unset($_SESSION["clipboard"]["ref_ids"]);
        unset($_SESSION["clipboard"]["cmd"]);

        if (count($a_sources) == 1) {
            ilLoggerFactory::getLogger('obj')->info('Object copy completed.');
            ilUtil::sendSuccess($this->lng->txt("object_duplicated"), true);
            $ref_id = $new_obj->getRefId();
        } else {
            ilLoggerFactory::getLogger('obj')->info('Object copy completed.');
            ilUtil::sendSuccess($this->lng->txt("objects_duplicated"), true);
            $ref_id = $this->getFirstTarget();
        }

        ilUtil::sendSuccess($this->lng->txt("objects_duplicated"), true);
        ilUtil::redirect(ilLink::_getLink($ref_id));

        // see bug discussion 24472
        /*
        $gui_fac = new ilObjectGUIFactory();
        $obj_gui = $gui_fac->getInstanceByRefId($ref_id);
        $obj_gui->redirectAfterCreation();
        */
    }

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.

Returns

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

References $access, $ctrl, $error, $ilCtrl, $ilErr, $ilUser, $rbacreview, $rbacsystem, $user, copyMultipleNonContainer(), getSources(), and ilUtil\sendFailure().

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

    {
        include_once('./Services/Link/classes/class.ilLink.php');
        include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
        
        $ilAccess = $this->access;
        $ilErr = $this->error;
        $rbacsystem = $this->rbacsystem;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $rbacreview = $this->rbacreview;

        // Source defined
        if (!count($this->getSources())) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $ilCtrl->returnToParent($this);
        }

        $this->copyMultipleNonContainer($this->getSources());
        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjectCopyGUI::executeCommand

(

)

Control class handling.

Returns

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

References $ctrl, $ilCtrl, init(), and initTabs().

    {
        $ilCtrl = $this->ctrl;
        
        $this->init();
        $this->initTabs();

        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();

        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getFirstSource()

ilObjectCopyGUI::getFirstSource

(

)

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

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

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

Here is the caller graph for this function:

getFirstTarget()

ilObjectCopyGUI::getFirstTarget

(

)

Get first target.

Returns

int

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

References $targets, and getTargets().

Referenced by copyMultipleNonContainer(), and init().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getMode()

ilObjectCopyGUI::getMode

(

)

get copy mode

Returns

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

References $mode.

Referenced by setTabs(), and showItemSelection().

    {
        return $this->mode;
    }

Here is the caller graph for this function:

getParentObject()

ilObjectCopyGUI::getParentObject

(

)

Get parent gui object.

Returns

object parent gui

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

References $parent_obj.

Referenced by init().

    {
        return $this->parent_obj;
    }

Here is the caller graph for this function:

getSources()

ilObjectCopyGUI::getSources

(

)

Get sources.

Returns

array

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

References $sources.

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

    {
        return (array) $this->sources;
    }

Here is the caller graph for this function:

getSubMode()

ilObjectCopyGUI::getSubMode

(

)

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

References $sub_mode.

Referenced by copyContainer(), copyContainerToTargets(), copyMultipleNonContainer(), init(), saveSource(), and setTabs().

    {
        return $this->sub_mode;
    }

Here is the caller graph for this function:

getTargets()

ilObjectCopyGUI::getTargets

(

)

Get copy target.

Returns

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

References $targets.

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

    {
        return (array) $this->targets;
    }

Here is the caller graph for this function:

getType()

ilObjectCopyGUI::getType

(

)

Returns $type.

See also

ilObjectCopyGUI::$type

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

References $type.

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

    {
        return $this->type;
    }

Here is the caller graph for this function:

init()

ilObjectCopyGUI::init ( )

protected

Init return, mode.

Returns

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

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

Referenced by executeCommand().

    {
        $ilCtrl = $this->ctrl;
        
        if ((int) $_REQUEST['smode']) {
            $this->setSubMode((int) $_REQUEST['smode']);
            $ilCtrl->setParameter($this, 'smode', $this->getSubMode());
            ilLoggerFactory::getLogger('obj')->debug('Submode is: ' . $this->getSubMode());
        }

        // save sources
        if ($_REQUEST['source_ids']) {
            $this->setSource(explode('_', $_REQUEST['source_ids']));
            $ilCtrl->setParameter($this, 'source_ids', implode('_', $this->getSources()));
            ilLoggerFactory::getLogger('obj')->debug('Multiple sources: ' . implode('_', $this->getSources()));
        }
        if ($_REQUEST['source_id']) {
            $this->setSource(array((int) $_REQUEST['source_id']));
            $ilCtrl->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 ($_REQUEST['new_type']) {
            $this->setMode(self::SEARCH_SOURCE);
            $this->setType($_REQUEST['new_type']);
            $this->setTarget((int) $_GET['ref_id']);

            $ilCtrl->setParameter($this, 'new_type', $this->getType());
            $ilCtrl->setParameterByClass(get_class($this->getParentObject()), 'new_type', $this->getType());
            $ilCtrl->setParameterByClass(get_class($this->getParentObject()), 'cpfl', 1);
            $ilCtrl->setReturnByClass(get_class($this->getParentObject()), 'create');
            
            ilLoggerFactory::getLogger('obj')->debug('Copy from object creation for type: ' . $this->getType());
            return true;
        }
        // adopt content, and others?
        elseif ($_REQUEST['selectMode'] == self::SOURCE_SELECTION) {
            $this->setMode(self::SOURCE_SELECTION);

            $ilCtrl->setParameterByClass(get_class($this->parent_obj), 'selectMode', self::SOURCE_SELECTION);
            $this->setTarget((int) $_GET['ref_id']);
            $ilCtrl->setReturnByClass(get_class($this->parent_obj), '');
            
            ilLoggerFactory::getLogger('obj')->debug('Source selection mode. Target is: ' . $this->getFirstTarget());
        } elseif ($_REQUEST['selectMode'] == self::TARGET_SELECTION) {
            $this->setMode(self::TARGET_SELECTION);
            $ilCtrl->setReturnByClass(get_class($this->parent_obj), '');
            ilLoggerFactory::getLogger('obj')->debug('Target selection mode.');
        }
        
        
        // save targets
        if ($_REQUEST['target_ids']) {
            $this->setTargets(explode('_', $_REQUEST['target_ids']));
            ilLoggerFactory::getLogger('obj')->debug('targets are: ' . print_r($this->getTargets(), true));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormSearch()

ilObjectCopyGUI::initFormSearch ( )

protected

Init search form.

Returns

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

References $ctrl, $ilCtrl, $lng, getType(), and ilTextInputGUI\setSize().

Referenced by searchSource(), and showSourceSearch().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $this->form = new ilPropertyFormGUI();
        $this->form->setTableWidth('600px');

        $ilCtrl->setParameter($this, 'new_type', $this->getType());
        
        #$ilCtrl->setParameter($this, 'cp_mode', self::SOURCE_SELECTION);
        $this->form->setFormAction($ilCtrl->getFormAction($this));
        $this->form->setTitle($lng->txt($this->getType() . '_copy'));
        
        $this->form->addCommandButton('searchSource', $lng->txt('btn_next'));
        $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
        
        $tit = new ilTextInputGUI($lng->txt('title'), 'tit');
        $tit->setSize(40);
        $tit->setMaxLength(70);
        $tit->setRequired(true);
        $tit->setInfo($lng->txt('wizard_title_info'));
        $this->form->addItem($tit);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSourceSelection()

ilObjectCopyGUI::initSourceSelection ( )

protected

Init source selection.

Returns

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

References $_SESSION, $ctrl, $ilCtrl, $path, $tree, getTargets(), setTabs(), and showSourceSelectionTree().

Referenced by adoptContent().

    {
        $ilCtrl = $this->ctrl;
        $tree = $this->tree;

        // empty session on init
        $_SESSION['paste_copy_repexpand'] = array();

        // copy opened nodes from repository explorer
        $_SESSION['paste_copy_repexpand'] = is_array($_SESSION['repexpand']) ? $_SESSION['repexpand'] : array();

        $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 = $tree->getPathId($target_ref_id);
            foreach ((array) $path as $node_id) {
                if (!in_array($node_id, $_SESSION['paste_copy_repexpand'])) {
                    $_SESSION['paste_copy_repexpand'][] = $node_id;
                }
            }
        }
        // end-patch multi copy
        $ilCtrl->setReturnByClass(get_class($this->parent_obj), '');
        $this->showSourceSelectionTree();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTabs()

ilObjectCopyGUI::initTabs ( )

protected

Init tabs General.

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

References $ctrl, $ilCtrl, $lng, and $tabs.

Referenced by executeCommand().

    {
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;

        $lng->loadLanguageModule('cntr');
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt('tab_back_to_repository'),
            $ilCtrl->getParentReturn($this->parent_obj)
        );
    }

Here is the caller graph for this function:

initTargetSelection()

ilObjectCopyGUI::initTargetSelection ( )

protected

Init copy from repository/search list commands.

Returns

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

References $_SESSION, $ctrl, $ilCtrl, $path, $tree, getSources(), setTargets(), and showTargetSelectionTree().

    {
        $ilCtrl = $this->ctrl;
        $tree = $this->tree;
        $ilCtrl->setParameter($this, 'selectMode', self::TARGET_SELECTION);
        // empty session on init
        $_SESSION['paste_copy_repexpand'] = array();
        
        // copy opened nodes from repository explorer
        $_SESSION['paste_copy_repexpand'] = is_array($_SESSION['repexpand']) ? $_SESSION['repexpand'] : array();

        // begin-patch mc
        $this->setTargets(array());
        // cognos-blu-patch: end

        // open current position
        
        foreach ($this->getSources() as $source_id) {
            if ($source_id) {
                $path = $tree->getPathId($source_id);
                foreach ((array) $path as $node_id) {
                    if (!in_array($node_id, $_SESSION['paste_copy_repexpand'])) {
                        $_SESSION['paste_copy_repexpand'][] = $node_id;
                    }
                }
            }
        }

        $ilCtrl->setReturnByClass(get_class($this->parent_obj), '');
        $this->showTargetSelectionTree();
    }

Here is the call graph for this function:

keepObjectsInClipboard()

ilObjectCopyGUI::keepObjectsInClipboard

(

)

Keep objects in clipboard.

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

References $_SESSION, $ctrl, $ilCtrl, and getSources().

    {
        ilUtil::sendSuccess($this->lng->txt("obj_inserted_clipboard"), true);
        $ilCtrl = $this->ctrl;
        $_SESSION['clipboard']['cmd'] = "copy";
        $_SESSION['clipboard']['ref_ids'] = $this->getSources();
        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

saveSource()

ilObjectCopyGUI::saveSource ( )

protected

select source object

Returns

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

References $_POST, $ctrl, $ilCtrl, $obj_definition, $target_type, ilObject\_lookupType(), copySingleObject(), ilObjectFactory\getClassByType(), getSources(), getSubMode(), getTargets(), searchSource(), ilUtil\sendFailure(), setSource(), setType(), and showItemSelection().

    {
        $objDefinition = $this->obj_definition;
        $ilCtrl = $this->ctrl;
        
        if (isset($_POST['source'])) {
            $this->setSource(array((int) $_REQUEST['source']));
            $this->setType(ilObject::_lookupType((int) $_REQUEST['source'], true));
            $ilCtrl->setParameter($this, 'source_id', (int) $_REQUEST['source']);
        } else {
            ilUtil::sendFailure($this->lng->txt('select_one'));
            $this->searchSource();
            return false;
        }
        
        // validate allowed subtypes
        foreach ($this->getSources() as $source_ref_id) {
            foreach ((array) $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($source_ref_id, true);
                
                if (!array_key_exists($source_type, $possible_subtypes)) {
                    #ilLoggerFactory::getLogger('obj')->debug('Source type: '.  $source_type);
                    #ilLoggerFactory::getLogger('obj')->debug('Target type: '.  $target_type);
                    #ilLoggerFactory::getLogger('obj')->debug('Submode: '.  $this->getSubMode());
                    
                    // adopt content mode
                    if (
                        $this->getSubMode() != self::SUBMODE_CONTENT_ONLY and
                        ($source_type != 'crs' or $target_type != 'crs')
                    ) {
                        ilUtil::sendFailure(
                            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->searchSource();
                        return false;
                    }
                }
            }
        }
        
        
        if ($objDefinition->isContainer($this->getType())) {
            $this->showItemSelection();
        } else {
            $this->copySingleObject();
        }
    }

Here is the call graph for this function:

saveSourceMembership()

ilObjectCopyGUI::saveSourceMembership ( )

protected

Save selected source from membership screen.

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

References $ctrl, $ilCtrl, $obj_definition, ilObject\_lookupType(), copySingleObject(), getFirstSource(), ilUtil\sendFailure(), setSource(), setType(), and showItemSelection().

    {
        $objDefinition = $this->obj_definition;
        $ilCtrl = $this->ctrl;
        
        if (!isset($_REQUEST['source'])) {
            ilUtil::sendFailure($this->lng->txt('select_one'));
            $ilCtrl->redirect($this, 'showSourceSelectionMembership');
            return false;
        }
        
        $this->setSource(array((int) $_REQUEST['source']));
        $this->setType(ilObject::_lookupType((int) $this->getFirstSource(), true));
        $ilCtrl->setParameter($this, 'source_id', (int) $_REQUEST['source']);
        
        if ($objDefinition->isContainer($this->getType())) {
            $this->showItemSelection();
        } else {
            $this->copySingleObject();
        }
    }

Here is the call graph for this function:

saveTarget()

ilObjectCopyGUI::saveTarget ( )

protected

Save target selection.

Returns

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

References $ctrl, $ilCtrl, $obj_definition, $target_type, $tree, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), copyMultipleNonContainer(), copySingleObject(), ilObjectFactory\getClassByType(), getFirstSource(), getSources(), getTargets(), ilUtil\sendFailure(), setTarget(), setTargets(), showItemSelection(), and showTargetSelectionTree().

    {
        $objDefinition = $this->obj_definition;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;


        // begin-patch mc
        if (is_array($_REQUEST['target']) and $_REQUEST['target']) {
            $this->setTargets($_REQUEST['target']);
            $ilCtrl->setParameter($this, 'target_ids', implode('_', $this->getTargets()));
        }
        // paste from clipboard
        elseif ((int) $_REQUEST['target']) {
            $this->setTarget($_REQUEST['target']);
            $ilCtrl->setParameter($this, 'target_ids', implode('_', $this->getTargets()));
        }
        // end-patch multi copy
        else {
            $ilCtrl->setParameter($this, 'selectMode', self::TARGET_SELECTION);
            ilUtil::sendFailure($this->lng->txt('select_one'));
            $this->showTargetSelectionTree();
            return false;
        }
        
        // validate allowed subtypes
        foreach ($this->getSources() as $source_ref_id) {
            foreach ((array) $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($source_ref_id, true);

                if (!array_key_exists($source_type, (array) $possible_subtypes)) {
                    ilUtil::sendFailure(
                        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 false;
                }
            }
        }
        
        if (count($this->getSources()) == 1 && $objDefinition->isContainer($this->getType())) {
            // check, if object should be copied into itself
            // begin-patch mc
            $is_child = array();
            foreach ($this->getTargets() as $target_ref_id) {
                if ($tree->isGrandChild($this->getFirstSource(), $target_ref_id)) {
                    $is_child[] = ilObject::_lookupTitle(ilObject::_lookupObjId($this->getFirstSource()));
                }
                if ($this->getFirstSource() == $target_ref_id) {
                    $is_child[] = ilObject::_lookupTitle(ilObject::_lookupObjId($this->getFirstSource()));
                }
            }
            // end-patch multi copy
            if (count($is_child) > 0) {
                ilUtil::sendFailure($this->lng->txt("msg_not_in_itself") . " " . implode(',', $is_child));
                $this->showTargetSelectionTree();
                return false;
            }

            $this->showItemSelection();
        } else {
            if (count($this->getSources()) == 1) {
                $this->copySingleObject();
            } else {
                $this->copyMultipleNonContainer($this->getSources());
            }
        }
    }

Here is the call graph for this function:

searchSource()

ilObjectCopyGUI::searchSource ( )

protected

Search source.

Returns

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

References $_POST, $_SESSION, $ctrl, $ilCtrl, $lng, $obj_data_cache, $res, $results, $table, $tpl, $tree, getFirstSource(), getType(), initFormSearch(), QP_COMBINATION_AND, ilUtil\sendFailure(), ilUtil\sendInfo(), and ilQueryParser\setMinWordLength().

Referenced by saveSource(), and showItemSelection().

    {
        $tree = $this->tree;
        $ilObjDataCache = $this->obj_data_cache;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        
        if (isset($_POST['tit'])) {
            ilUtil::sendInfo($this->lng->txt('wizard_search_list'));
            $_SESSION['source_query'] = $_POST['tit'];
        } else {
            $_POST['tit'] = $_SESSION['source_query'];
        }
        
        $this->initFormSearch();
        $this->form->setValuesByPost();
        
        if (!$this->form->checkInput()) {
            ilUtil::sendFailure($lng->txt('msg_no_search_string'), true);
            $ilCtrl->returnToParent($this);
            return false;
        }
        
        include_once './Services/Search/classes/class.ilQueryParser.php';
        $query_parser = new ilQueryParser($this->form->getInput('tit'));
        $query_parser->setMinWordLength(1, true);
        $query_parser->setCombination(QP_COMBINATION_AND);
        $query_parser->parse();
        if (!$query_parser->validate()) {
            ilUtil::sendFailure($query_parser->getMessage(), true);
            $ilCtrl->returnToParent($this);
        }

        // only like search since fulltext does not support search with less than 3 characters
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($query_parser);
        $object_search->setFilter(array($_REQUEST['new_type']));
        $res = $object_search->performSearch();
        $res->setRequiredPermission('copy');
        $res->filter(ROOT_FOLDER_ID, true);
        
        if (!count($results = $res->getResultsByObjId())) {
            ilUtil::sendFailure($this->lng->txt('search_no_match'), true);
            $ilCtrl->returnToParent($this);
        }
        
    
        include_once './Services/Object/classes/class.ilObjectCopySearchResultTableGUI.php';
        $table = new ilObjectCopySearchResultTableGUI($this, 'searchSource', $this->getType());
        $table->setFormAction($ilCtrl->getFormAction($this));
        $table->setSelectedReference($this->getFirstSource());
        $table->parseSearchResults($results);
        $tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setMode()

ilObjectCopyGUI::setMode

(

$a_mode

)

set copy mode

Parameters

int

$a_mode

Returns

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

Referenced by adoptContent(), and init().

    {
        $this->mode = $a_mode;
    }

Here is the caller graph for this function:

setSource()

ilObjectCopyGUI::setSource

(

array

$a_source_ids

)

Set source id.

Parameters

array

$a_source_id

Returns

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

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

    {
        $this->sources = $a_source_ids;
    }

Here is the caller graph for this function:

setSubMode()

ilObjectCopyGUI::setSubMode

(

$a_mode

)

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

Referenced by adoptContent(), and init().

    {
        $this->sub_mode = $a_mode;
    }

Here is the caller graph for this function:

setTabs()

ilObjectCopyGUI::setTabs (   $a_tab_group,   $a_active_tab  )

protected

Set tabs.

Parameters

type	$a_tab_group
type	$a_active_tab

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

References $ctrl, $ilCtrl, $lng, $tabs, getMode(), and getSubMode().

Referenced by initSourceSelection(), and showSourceSelectionMembership().

    {
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;

        if ($a_tab_group == self::TAB_GROUP_SC_SELECTION) {
            if ($this->getSubMode() == self::SUBMODE_CONTENT_ONLY) {
                if ($this->getMode() == self::SOURCE_SELECTION) {
                    $ilTabs->addTab(
                        self::TAB_SELECTION_SOURCE_TREE,
                        $lng->txt('cntr_copy_repo_tree'),
                        $ilCtrl->getLinkTarget($this, 'initSourceSelection')
                    );
                    $ilTabs->addTab(
                        self::TAB_SELECTION_MEMBERSHIP,
                        $lng->txt('cntr_copy_crs_grp'),
                        $ilCtrl->getLinkTarget($this, 'showSourceSelectionMembership')
                    );
                }
            }
        }
        $ilTabs->activateTab($a_active_tab);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTarget()

ilObjectCopyGUI::setTarget

(

$a_ref_id

)

Set single object target.

Parameters

type

$a_ref_id

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

References setTargets().

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

    {
        $this->setTargets(array($a_ref_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTargets()

ilObjectCopyGUI::setTargets

(

array

$a_target

)

Set target id.

Parameters

int

$a_target

Returns

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

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

    {
        $this->targets = $a_target;
    }

Here is the caller graph for this function:

setType()

ilObjectCopyGUI::setType

(

$type

)

Sets $type.

Parameters

object

$type

See also

ilObjectCopyGUI::$type

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

References $type.

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

    {
        $this->type = $type;
    }

Here is the caller graph for this function:

showCopyProgress()

ilObjectCopyGUI::showCopyProgress ( )

protected

Show progress for copying.

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

References $_GET, $ctrl, $ilCtrl, and $tpl.

Referenced by copyContainerToTargets().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        include_once './Services/Object/classes/class.ilObjectCopyProgressTableGUI.php';
        $progress = new ilObjectCopyProgressTableGUI(
            $this,
            'showCopyProgress',
            (int) $_GET['ref_id']
        );
        $progress->setObjectInfo($this->targets_copy_id);
        $progress->parse();
        $progress->init();
        $progress->setRedirectionUrl($ilCtrl->getParentReturn($this->parent_obj));

        $tpl->setContent($progress->getHTML());
    }

Here is the caller graph for this function:

showItemSelection()

ilObjectCopyGUI::showItemSelection ( )

protected

Returns

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

References $table, $tpl, getFirstSource(), ilLoggerFactory\getLogger(), getMode(), getSources(), getTargets(), getType(), searchSource(), ilUtil\sendFailure(), and ilUtil\sendInfo().

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

    {
        $tpl = $this->tpl;
        
        if (!count($this->getSources())) {
            ilUtil::sendFailure($this->lng->txt('select_one'));
            $this->searchSource();
            return false;
        }
        
        ilLoggerFactory::getLogger('obj')->debug('Source(s): ' . print_r($this->getSources(), true));
        ilLoggerFactory::getLogger('obj')->debug('Target(s): ' . print_r($this->getTargets(), true));

        ilUtil::sendInfo($this->lng->txt($this->getType() . '_copy_threads_info'));
        include_once './Services/Object/classes/class.ilObjectCopySelectionTableGUI.php';
        
        $tpl->addJavaScript('./Services/CopyWizard/js/ilContainer.js');
        $tpl->setVariable('BODY_ATTRIBUTES', 'onload="ilDisableChilds(\'cmd\');"');

        switch ($this->getMode()) {
            case self::SOURCE_SELECTION:
                $back_cmd = 'showSourceSelectionTree';
                break;

            case self::TARGET_SELECTION:
                $back_cmd = 'showTargetSelectionTree';
                break;

            case self::SEARCH_SOURCE:
                $back_cmd = 'searchSource';
                break;
        }

        $table = new ilObjectCopySelectionTableGUI($this, 'showItemSelection', $this->getType(), $back_cmd);
        $table->parseSource($this->getFirstSource());
        
        $tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSourceSearch()

ilObjectCopyGUI::showSourceSearch

(

$a_tplvar

)

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

Parameters

string

$a_tplvar

The tpl variable to fill

Returns

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

References $form, $tpl, initFormSearch(), and unsetSession().

    {
        $tpl = $this->tpl;
        
        // Disabled for performance
        #if(!$this->sourceExists())
        #{
        #       return false;
        #}

        $this->unsetSession();
        $this->initFormSearch();

        if ($a_tplvar) {
            $tpl->setVariable($a_tplvar, $this->form->getHTML());
        } else {
            return $this->form;
        }
    }

Here is the call graph for this function:

showSourceSelectionMembership()

ilObjectCopyGUI::showSourceSelectionMembership ( )

protected

show target selection membership

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

References $tpl, $user, ilParticipants\_getMembershipByType(), ilUtil\sendInfo(), and setTabs().

    {
        $user = $this->user;
        $tpl = $this->tpl;

        ilUtil::sendInfo($this->lng->txt('msg_copy_clipboard_source'));
        $this->setTabs(self::TAB_GROUP_SC_SELECTION, self::TAB_SELECTION_MEMBERSHIP);
        
        include_once './Services/Object/classes/class.ilObjectCopyCourseGroupSelectionTableGUI.php';
        $cgs = new ilObjectCopyCourseGroupSelectionTableGUI($this, 'showSourceSelectionMembership', 'copy_selection_membership');
        $cgs->init();
        $cgs->setObjects(
            array_merge(
                ilParticipants::_getMembershipByType($user->getId(), 'crs', false),
                ilParticipants::_getMembershipByType($user->getId(), 'grp', false)
                )
        );
        $cgs->parse();

        $tpl->setContent($cgs->getHTML());
    }

Here is the call graph for this function:

showSourceSelectionTree()

ilObjectCopyGUI::showSourceSelectionTree

(

)

Show target selection.

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

References $_GET, $container, $ctrl, $ilCtrl, $obj_definition, Sabre\VObject\$output, $tabs, $toolbar, $tpl, $tree, getSources(), ilPasteIntoMultipleItemsExplorer\SEL_TYPE_RADIO, and ilUtil\sendInfo().

Referenced by initSourceSelection().

    {
        $ilTabs = $this->tabs;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $tree = $this->tree;
        $tpl = $this->tpl;
        $objDefinition = $this->obj_definition;
    
        $this->tpl = $tpl;
        $this->tpl->addBlockfile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.paste_into_multiple_objects.html',
            "Services/Object"
        );
        
        ilUtil::sendInfo($this->lng->txt('msg_copy_clipboard_source'));
        include_once './Services/Object/classes/class.ilPasteIntoMultipleItemsExplorer.php';
        $exp = new ilPasteIntoMultipleItemsExplorer(
            ilPasteIntoMultipleItemsExplorer::SEL_TYPE_RADIO,
            'ilias.php?baseClass=ilRepositoryGUI&cmd=goto',
            'paste_copy_repexpand'
        );
        $exp->setRequiredFormItemPermission('visible,read,copy');

        $ilCtrl->setParameter($this, 'selectMode', self::SOURCE_SELECTION);
        $exp->setExpandTarget($ilCtrl->getLinkTarget($this, 'showSourceSelectionTree'));
        $exp->setTargetGet('ref_id');
        $exp->setPostVar('source');
        $exp->setCheckedItems($this->getSources());
        
        // Filter to container
        foreach (array('cat','root','fold') as $container) {
            $exp->removeFormItemForType($container);
        }
        
        
        if ($_GET['paste_copy_repexpand'] == '') {
            $expanded = $tree->readRootId();
        } else {
            $expanded = $_GET['paste_copy_repexpand'];
        }
        
        $this->tpl->setVariable('FORM_TARGET', '_self');
        $this->tpl->setVariable('FORM_ACTION', $ilCtrl->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'));
        
        $ilToolbar->addButton($this->lng->txt('cancel'), $ilCtrl->getLinkTarget($this, 'cancel'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showTargetSelectionTree()

ilObjectCopyGUI::showTargetSelectionTree

(

)

Show target selection.

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

References $ctrl, $ilCtrl, $lng, $obj_definition, Sabre\VObject\$output, $t, $tabs, $toolbar, $tpl, $tree, ilUtil\getImagePath(), ilSubmitButton\getInstance(), and ilUtil\sendInfo().

Referenced by initTargetSelection(), and saveTarget().

    {
        $ilTabs = $this->tabs;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $tree = $this->tree;
        $tpl = $this->tpl;
        $objDefinition = $this->obj_definition;
        $lng = $this->lng;
    
        $this->tpl = $tpl;
        
        if ($objDefinition->isContainer($this->getType())) {
            ilUtil::sendInfo($this->lng->txt('msg_copy_clipboard_container'));
        } else {
            ilUtil::sendInfo($this->lng->txt('msg_copy_clipboard'));
        }

        //
        include_once("./Services/Repository/classes/class.ilRepositorySelectorExplorerGUI.php");
        $exp = new ilRepositorySelectorExplorerGUI($this, "showTargetSelectionTree");
        $exp->setTypeWhiteList(array("root", "cat", "grp", "crs", "fold", "lso", "prg"));
        $exp->setSelectMode("target", true);
        if ($exp->handleCommand()) {
            return;
        }
        $output = $exp->getHTML();

        // toolbars
        $t = new ilToolbarGUI();
        $t->setFormAction($ilCtrl->getFormAction($this, "saveTarget"));
        if ($objDefinition->isContainer($this->getType())) {
            $btn = ilSubmitButton::getInstance();
            $btn->setCaption('btn_next');
            $btn->setCommand('saveTarget');
            $btn->setPrimary(true);
            $t->addButtonInstance($btn);
        } else {
            $btn = ilSubmitButton::getInstance();
            $btn->setCaption('paste');
            $btn->setCommand('saveTarget');
            $btn->setPrimary(true);
            $t->addButtonInstance($btn);
        }
        $t->addSeparator();
        $clipboard_btn = ilSubmitButton::getInstance();
        $clipboard_btn->setCaption('obj_insert_into_clipboard');
        $clipboard_btn->setCommand('keepObjectsInClipboard');
        $t->addButtonInstance($clipboard_btn);
        $cancel_btn = ilSubmitButton::getInstance();
        $cancel_btn->setCaption('cancel');
        $cancel_btn->setCommand('cancel');
        $t->addButtonInstance($cancel_btn);
        $t->setCloseFormTag(false);
        $t->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), " ");
        $output = $t->getHTML() . $output;
        $t->setLeadingImage(ilUtil::getImagePath("arrow_downright.svg"), " ");
        $t->setCloseFormTag(true);
        $t->setOpenFormTag(false);
        $output.= "<br />" . $t->getHTML();

        $this->tpl->setContent($output);

        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sourceExists()

ilObjectCopyGUI::sourceExists ( )

protected

Check if there is any source object.

Returns

bool

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

References $ilUser, $user, ilUtil\_getObjectsByOperations(), and getType().

    {
        $ilUser = $this->user;

        return (bool) ilUtil::_getObjectsByOperations($this->getType(), 'copy', $ilUser->getId(), 1);
    }

Here is the call graph for this function:

unsetSession()

ilObjectCopyGUI::unsetSession ( )

protected

Unset session variables.

Returns

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

References $_SESSION, and setSource().

Referenced by showSourceSearch().

    {
        unset($_SESSION['source_query']);
        $this->setSource(array());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateProgress()

ilObjectCopyGUI::updateProgress ( )

protected

Update progress.

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

References PHPMailer\PHPMailer\$options, ilCopyWizardOptions\_getInstance(), exit, and ilLoggerFactory\getLogger().

    {
        $json = new stdClass();
        $json->percentage = null;
        $json->performed_steps = null;
        
        include_once './Services/CopyWizard/classes/class.ilCopyWizardOptions.php';
        $options = ilCopyWizardOptions::_getInstance((int) $_REQUEST['copy_id']);
        $json->required_steps = $options->getRequiredSteps();
        $json->id = (int) $_REQUEST['copy_id'];
        
        ilLoggerFactory::getLogger('obj')->debug('Update copy progress: ' . json_encode($json));
        
        echo json_encode($json);
        exit;
    }

Here is the call graph for this function:

Field Documentation

$access

ilObjectCopyGUI::$access

protected

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

Referenced by copyContainer(), copyMultipleNonContainer(), and copySingleObject().

$ctrl

ilObjectCopyGUI::$ctrl

protected

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

Referenced by adoptContent(), cancel(), copyContainer(), copyContainerToTargets(), copyMultipleNonContainer(), copySingleObject(), executeCommand(), init(), initFormSearch(), initSourceSelection(), initTabs(), initTargetSelection(), keepObjectsInClipboard(), saveSource(), saveSourceMembership(), saveTarget(), searchSource(), setTabs(), showCopyProgress(), showSourceSelectionTree(), and showTargetSelectionTree().

$error

ilObjectCopyGUI::$error

protected

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

Referenced by copyContainer(), and copySingleObject().

$lng

ilObjectCopyGUI::$lng

private

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

Referenced by __construct(), initFormSearch(), initTabs(), searchSource(), setTabs(), and showTargetSelectionTree().

$log

ilObjectCopyGUI::$log = null

private

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

Referenced by copyContainer().

$mode

ilObjectCopyGUI::$mode = 0

private

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

Referenced by getMode().

$obj_data_cache

ilObjectCopyGUI::$obj_data_cache

protected

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

Referenced by searchSource().

$obj_definition

ilObjectCopyGUI::$obj_definition

protected

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

Referenced by copyMultipleNonContainer(), saveSource(), saveSourceMembership(), saveTarget(), showSourceSelectionTree(), and showTargetSelectionTree().

$parent_obj

ilObjectCopyGUI::$parent_obj = null

private

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

Referenced by getParentObject().

$rbacreview

ilObjectCopyGUI::$rbacreview

protected

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

Referenced by copyMultipleNonContainer(), and copySingleObject().

$rbacsystem

ilObjectCopyGUI::$rbacsystem

protected

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

Referenced by copyContainer(), copyMultipleNonContainer(), and copySingleObject().

$sources

ilObjectCopyGUI::$sources = array()

private

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

Referenced by getSources().

$sub_mode

ilObjectCopyGUI::$sub_mode = self::SUBMODE_COMPLETE

private

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

Referenced by getSubMode().

$tabs

ilObjectCopyGUI::$tabs

protected

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

Referenced by initTabs(), setTabs(), showSourceSelectionTree(), and showTargetSelectionTree().

$targets

ilObjectCopyGUI::$targets = array()

private

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

Referenced by getFirstTarget(), and getTargets().

$targets_copy_id

ilObjectCopyGUI::$targets_copy_id = array()

private

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

$toolbar

ilObjectCopyGUI::$toolbar

protected

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

Referenced by showSourceSelectionTree(), and showTargetSelectionTree().

$tpl

ilObjectCopyGUI::$tpl

protected

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

Referenced by searchSource(), showCopyProgress(), showItemSelection(), showSourceSearch(), showSourceSelectionMembership(), showSourceSelectionTree(), and showTargetSelectionTree().

$tree

ilObjectCopyGUI::$tree

protected

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

Referenced by copyContainer(), initSourceSelection(), initTargetSelection(), saveTarget(), searchSource(), showSourceSelectionTree(), and showTargetSelectionTree().

$type

ilObjectCopyGUI::$type = ''

private

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

Referenced by getType(), and setType().

$user

ilObjectCopyGUI::$user

protected

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

Referenced by copyContainer(), copyMultipleNonContainer(), copySingleObject(), showSourceSelectionMembership(), and sourceExists().

SEARCH_SOURCE

const ilObjectCopyGUI::SEARCH_SOURCE = 3

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

SOURCE_SELECTION

const ilObjectCopyGUI::SOURCE_SELECTION = 1

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

SUBMODE_COMPLETE

const ilObjectCopyGUI::SUBMODE_COMPLETE = 1

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

SUBMODE_CONTENT_ONLY

const ilObjectCopyGUI::SUBMODE_CONTENT_ONLY = 2

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

Referenced by ilContainer\cloneAllObject().

TAB_GROUP_SC_SELECTION

const ilObjectCopyGUI::TAB_GROUP_SC_SELECTION = 1

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

TAB_SELECTION_MEMBERSHIP

const ilObjectCopyGUI::TAB_SELECTION_MEMBERSHIP = 3

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

TAB_SELECTION_SOURCE_TREE

const ilObjectCopyGUI::TAB_SELECTION_SOURCE_TREE = 2

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

TAB_SELECTION_TARGET_TREE

const ilObjectCopyGUI::TAB_SELECTION_TARGET_TREE = 1

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

TARGET_SELECTION

const ilObjectCopyGUI::TARGET_SELECTION = 2

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

---

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

• Services/Object/classes/class.ilObjectCopyGUI.php