ilCopyWizardOptions Class Reference

Collaboration diagram for ilCopyWizardOptions:

Public Member Functions
	getRequiredSteps ()
	Get required steps. More...
	saveOwner ($a_user_id)
	Save owner for copy. More...
	saveRoot ($a_root)
	Save root node id. More...
	isRootNode ($a_root)
	Is root node. More...
	disableSOAP ()
	Disable soap calls. More...
	isSOAPEnabled ()
	Check if SOAP calls are disabled. More...
	checkOwner ($a_user_id)
	check owner More...
	getCopyId ()
	Get copy id. More...
	initContainer ($a_source_id, $a_target_id)
	Init container Add copy entry. More...
	storeTree ($a_source_id)
	Save tree Stores two copies of the tree structure: id 0 is used for recursive call of cloneObject() id -1 is used for recursive call of cloneDependencies() More...
	fetchFirstNode ()
	Fetch first node for cloneObject. More...
	fetchFirstDependenciesNode ()
	Fetch first dependencies node. More...
	dropFirstNodeById ($a_id)
	Drop first node by id. More...
	dropFirstNode ()
	Drop first node (for cloneObject()) More...
	dropFirstDependenciesNode ()
	Drop first node (for cloneDependencies()) More...
	getOptions ($a_source_id)
	Get entry by source. More...
	addEntry ($a_source_id, $a_options)
	Add new entry. More...
	appendMapping ($a_source_id, $a_target_id)
	Add mapping of source -> target. More...
	getMappings ()
	Get Mappings. More...
	deleteAll ()
	Delete all entries. More...
	read ()
	public More...

Static Public Member Functions
static	_getInstance ($a_copy_id)
	Get instance of copy wizard options. More...
static	_isFinished ($a_copy_id)
	check if copy is finished More...
static	_allocateCopyId ()
	Allocate a copy for further entries. More...

Data Fields
const	COPY_WIZARD_OMIT = 1
const	COPY_WIZARD_COPY = 2
const	COPY_WIZARD_LINK = 3
const	OWNER_KEY = -3
const	DISABLE_SOAP = -4
const	ROOT_NODE = -5

Private Member Functions
	__construct ($a_copy_id=0)
	Private Constructor (Singleton class) More...
	fetchFirstNodeById ($a_id)
	Get first node of stored tree. More...
	readTree ($a_source_id)
	Purge ommitted node recursively. More...

Private Attributes
	$db
	$copy_id
	$source_id
	$options = array()

Static Private Attributes
static	$instances = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCopyWizardOptions::__construct (   $a_copy_id = 0 )

private

Private Constructor (Singleton class)

private

Parameters

int

copy_id

Definition at line 57 of file class.ilCopyWizardOptions.php.

References $ilDB, and read().

        {
                global $ilDB;
                
                $this->db = $ilDB;
                $this->copy_id = $a_copy_id;
                
                if($this->copy_id)
                {
                        $this->read();
                }       
        }

Here is the call graph for this function:

Member Function Documentation

_allocateCopyId()

static ilCopyWizardOptions::_allocateCopyId ( )

static

Allocate a copy for further entries.

public

Definition at line 123 of file class.ilCopyWizardOptions.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilContainer\cloneAllObject(), ilObjectGUI\cloneAllObject(), ilObjectCopyGUI\copyMultipleNonContainer(), ilSoapObjectAdministration\copyObject(), and ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects().

        {
                global $ilDB;
                
                $query = "SELECT MAX(copy_id) latest FROM copy_wizard_options ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_OBJECT);
                
                $ilDB->insert("copy_wizard_options", array(
                        "copy_id" => array("integer", ((int) $row->latest) + 1),
                        "source_id" => array("integer", 0)
                        ));
                return ((int) $row->latest) + 1;
        }

Here is the caller graph for this function:

_getInstance()

static ilCopyWizardOptions::_getInstance (   $a_copy_id )

static

Get instance of copy wizard options.

public

Parameters

int

copy id

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

Referenced by ilObjTest\_getAvailableTests(), ilObject\appendCopyInfo(), ilContainer\cloneAllObject(), ilObjectGUI\cloneAllObject(), ilLPCollection\cloneCollection(), ilLPCollectionOfRepositoryObjects\cloneCollection(), ilCourseObjectiveMaterials\cloneDependencies(), ilCourseStart\cloneDependencies(), ilCourseObjectiveQuestion\cloneDependencies(), ilObjCategory\cloneDependencies(), ilContainerStartObjects\cloneDependencies(), ilObjectActivation\cloneDependencies(), ilConditionHandler\cloneDependencies(), ilEventItems\cloneItems(), ilItemGroupItems\cloneItems(), ilObjSurveyQuestionPool\cloneObject(), ilObjBookingPool\cloneObject(), ilObjFileBasedLM\cloneObject(), ilObjMediaCast\cloneObject(), ilObjCourse\cloneObject(), ilObjWiki\cloneObject(), ilObjGlossary\cloneObject(), ilObjSAHSLearningModule\cloneObject(), ilObjQuestionPool\cloneObject(), ilObjContentObject\cloneObject(), ilObjSurvey\cloneObject(), ilTestFixedQuestionSetConfig\cloneQuestionSetRelatedData(), ilLOTestAssignment\cloneSettings(), ilLOSettings\cloneSettings(), ilContainerSorting\cloneSorting(), ilLORandomTestQuestionPools\copy(), ilObjContentObject\copyAllPagesAndChapters(), ilObjectCopyGUI\copyMultipleNonContainer(), ilSoapObjectAdministration\copyObject(), ilObjCloud\doClone(), ilObjPortfolioTemplate\doCloneObject(), ilObjDataCollection\doCloneObject(), ilObjPoll\doCloneObject(), ilObjBibliographic\doCloneObject(), ilObjItemGroup\fixContainerItemGroupRefsAfterCloning(), ilObjForum\getDiskUsage(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilObjectCopyProgressTableGUI\parse(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilTestRandomQuestionSetConfig\registerClonedSourcePoolDefinitionIdMapping(), and ilObjectCopyGUI\updateProgress().

        {
                if(is_array(self::$instances) and isset(self::$instances[$a_copy_id]))
                {
                        return self::$instances[$a_copy_id];
                }
                return self::$instances[$a_copy_id] = new ilCopyWizardOptions($a_copy_id);
        }

Here is the caller graph for this function:

_isFinished()

static ilCopyWizardOptions::_isFinished (   $a_copy_id )

static

check if copy is finished

public

Parameters

int

copy id

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

References $ilDB, $query, and $res.

Referenced by ilContainerGUI\cloneAllObject(), and ilObjectCopyGUI\copyContainerToTargets().

        {
                global $ilDB;
                
                $query = "SELECT * FROM copy_wizard_options ".
                        "WHERE copy_id  = ".$ilDB->quote($a_copy_id ,'integer')." ";
                $res = $ilDB->query($query);
                return $res->numRows() ? false : true;
        }

Here is the caller graph for this function:

addEntry()

ilCopyWizardOptions::addEntry	(		$a_source_id,
			$a_options
	)

Add new entry.

public

Parameters

int	ref_id of source
array	array of options

Definition at line 424 of file class.ilCopyWizardOptions.php.

References $ilDB, $query, and $res.

Referenced by initContainer().

        {
                global $ilDB;

                if(!is_array($a_options))
                {
                        return false;
                }
                
                $query = "DELETE FROM copy_wizard_options ".
                        "WHERE copy_id = ".$this->db->quote($this->copy_id ,'integer')." ".
                        "AND source_id = ".$this->db->quote($a_source_id ,'integer');
                $res = $ilDB->manipulate($query);

                $ilDB->insert('copy_wizard_options',array(
                        'copy_id'       => array('integer',$this->copy_id),
                        'source_id'     => array('integer',$a_source_id),
                        'options'       => array('clob',serialize($a_options))
                ));
                return true;
        }

Here is the caller graph for this function:

appendMapping()

ilCopyWizardOptions::appendMapping	(		$a_source_id,
			$a_target_id
	)

Add mapping of source -> target.

public

Parameters

int | string	$a_source_id	array key of mapping entry
mixed	$a_target_id	array value of mapping entry

Definition at line 454 of file class.ilCopyWizardOptions.php.

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and getCopyId().

Referenced by initContainer().

        {
                global $ilDB;
                
                $query = "SELECT * FROM copy_wizard_options ".
                        "WHERE copy_id = ".$this->db->quote($this->copy_id ,'integer')." ".
                        "AND source_id = -2 ";
                $res = $this->db->query($query);
                $mappings = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $mappings = unserialize($row->options);
                }
                $mappings[$a_source_id] = $a_target_id;
                
                $query = "DELETE FROM copy_wizard_options ".
                        "WHERE copy_id = ".$ilDB->quote($this->getCopyId(),'integer')." ".
                        "AND source_id = -2 ";
                $res = $ilDB->manipulate($query);
                
                
                $ilDB->insert('copy_wizard_options', array(
                        'copy_id'       => array('integer',$this->getCopyId()),
                        'source_id'     => array('integer',-2),
                        'options'       => array('clob',serialize($mappings))
                ));
                
                return true;                            
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkOwner()

ilCopyWizardOptions::checkOwner

(

$a_user_id

)

check owner

public

Parameters

int

user_id

Definition at line 235 of file class.ilCopyWizardOptions.php.

References getOptions().

        {
                return in_array($a_user_id,$this->getOptions(self::OWNER_KEY));
        }

Here is the call graph for this function:

deleteAll()

ilCopyWizardOptions::deleteAll

(

)

Delete all entries.

public

Definition at line 505 of file class.ilCopyWizardOptions.php.

References $ilDB, $query, and $res.

        {
                global $ilDB;
                
                $query = "DELETE FROM copy_wizard_options ".
                        "WHERE copy_id = ".$this->db->quote($this->copy_id ,'integer');
                $res = $ilDB->manipulate($query);
        }

disableSOAP()

ilCopyWizardOptions::disableSOAP

(

)

Disable soap calls.

Recursive call of ilClone and ilCloneDependencies

public

Parameters

Definition at line 198 of file class.ilCopyWizardOptions.php.

References $ilDB, and getCopyId().

        {
                global $ilDB;
                
                $this->options[self::DISABLE_SOAP] = 1;
                
                $ilDB->insert("copy_wizard_options", array(
                        "copy_id"       => array("integer", $this->getCopyId()),
                        "source_id" => array("integer", self::DISABLE_SOAP),
                        "options"       => array('clob',serialize(array(1)))
                        ));
        }

Here is the call graph for this function:

dropFirstDependenciesNode()

ilCopyWizardOptions::dropFirstDependenciesNode

(

)

Drop first node (for cloneDependencies())

public

Definition at line 395 of file class.ilCopyWizardOptions.php.

References dropFirstNodeById().

        {
                return $this->dropFirstNodeById(-1);
        }

Here is the call graph for this function:

dropFirstNode()

ilCopyWizardOptions::dropFirstNode

(

)

Drop first node (for cloneObject())

public

Definition at line 384 of file class.ilCopyWizardOptions.php.

References dropFirstNodeById().

        {
                return $this->dropFirstNodeById(0);
        }

Here is the call graph for this function:

dropFirstNodeById()

ilCopyWizardOptions::dropFirstNodeById

(

$a_id

)

Drop first node by id.

private

Definition at line 348 of file class.ilCopyWizardOptions.php.

References $ilDB, fetchFirstNodeById(), getCopyId(), and read().

Referenced by dropFirstDependenciesNode(), and dropFirstNode().

        {
                global $ilDB;
                
                if(!isset($this->options[$a_id]) or !is_array($this->options[$a_id]))
                {
                        return false;
                }
                
                $this->options[$a_id] = array_slice($this->options[$a_id],1);
                
                $ilDB->update('copy_wizard_options',array(
                        'options'       => array('clob',serialize($this->options[$a_id]))
                        ),array(
                        'copy_id'       => array('integer',$this->getCopyId()),
                        'source_id'     => array('integer',$a_id)));
                
                $this->read();
                // check for role_folder
                if(($node = $this->fetchFirstNodeById($a_id)) === false)
                {
                        return true;
                }
                if($node['type'] == 'rolf')
                {
                        $this->dropFirstNodeById($a_id);
                }
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchFirstDependenciesNode()

ilCopyWizardOptions::fetchFirstDependenciesNode

(

)

Fetch first dependencies node.

public

Definition at line 337 of file class.ilCopyWizardOptions.php.

References fetchFirstNodeById().

        {
                return $this->fetchFirstNodeById(-1);
        }

Here is the call graph for this function:

fetchFirstNode()

ilCopyWizardOptions::fetchFirstNode

(

)

Fetch first node for cloneObject.

public

Parameters

Definition at line 326 of file class.ilCopyWizardOptions.php.

References fetchFirstNodeById().

        {
                return $this->fetchFirstNodeById(0);
        }

Here is the call graph for this function:

fetchFirstNodeById()

ilCopyWizardOptions::fetchFirstNodeById (   $a_id )

private

Get first node of stored tree.

private

Definition at line 309 of file class.ilCopyWizardOptions.php.

References getOptions().

Referenced by dropFirstNodeById(), fetchFirstDependenciesNode(), and fetchFirstNode().

        {
                $tree = $this->getOptions($a_id);
                if(isset($tree[0]) and is_array($tree[0]))
                {
                        return $tree[0];
                }
                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getCopyId()

ilCopyWizardOptions::getCopyId

(

)

Get copy id.

public

Definition at line 246 of file class.ilCopyWizardOptions.php.

References $copy_id.

Referenced by appendMapping(), disableSOAP(), dropFirstNodeById(), saveOwner(), saveRoot(), and storeTree().

        {
                return $this->copy_id;
        }

Here is the caller graph for this function:

getMappings()

ilCopyWizardOptions::getMappings

(

)

Get Mappings.

public

Definition at line 490 of file class.ilCopyWizardOptions.php.

        {
                if(isset($this->options[-2]) and is_array($this->options[-2]))
                {
                        return $this->options[-2];
                }
                return array();
        }

getOptions()

ilCopyWizardOptions::getOptions

(

$a_source_id

)

Get entry by source.

public

Parameters

int	source ref_id

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

Referenced by checkOwner(), fetchFirstNodeById(), and isRootNode().

        {
                if(isset($this->options[$a_source_id]) and is_array($this->options[$a_source_id]))
                {
                        return $this->options[$a_source_id];
                }
                return array();
        }

Here is the caller graph for this function:

getRequiredSteps()

ilCopyWizardOptions::getRequiredSteps

(

)

Get required steps.

Returns

type

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

        {
                return count($this->options[0]) + count($this->options[-1]);
        }

initContainer()

ilCopyWizardOptions::initContainer	(		$a_source_id,
			$a_target_id
	)

Init container Add copy entry.

public

Parameters

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

References addEntry(), appendMapping(), and COPY_WIZARD_COPY.

        {
                global $tree;
                
                $mapping_source = $tree->getParentId($a_source_id);
                $this->addEntry($a_source_id,array('type' => ilCopyWizardOptions::COPY_WIZARD_COPY));
                $this->appendMapping($mapping_source,$a_target_id);
        }

Here is the call graph for this function:

isRootNode()

ilCopyWizardOptions::isRootNode

(

$a_root

)

Is root node.

public

Parameters

int	ref_id of copy

Definition at line 186 of file class.ilCopyWizardOptions.php.

References getOptions().

         {
                return in_array($a_root,$this->getOptions(self::ROOT_NODE));
         }

Here is the call graph for this function:

isSOAPEnabled()

ilCopyWizardOptions::isSOAPEnabled

(

)

Check if SOAP calls are disabled.

public

Definition at line 217 of file class.ilCopyWizardOptions.php.

        {
                if(isset($this->options[self::DISABLE_SOAP]) and $this->options[self::DISABLE_SOAP])
                {
                        return false;
                }
                return true;
        }

read()

ilCopyWizardOptions::read

(

)

public

Parameters

Definition at line 521 of file class.ilCopyWizardOptions.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by __construct(), and dropFirstNodeById().

        {
                global $ilDB;
                
                $query = "SELECT * FROM copy_wizard_options ".
                        "WHERE copy_id = ".$this->db->quote($this->copy_id ,'integer');
                $res = $this->db->query($query);
                
                $this->options = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->options[$row->source_id] = unserialize($row->options);
                }

                return true;
        }

Here is the caller graph for this function:

readTree()

ilCopyWizardOptions::readTree (   $a_source_id )

private

Purge ommitted node recursively.

private

Parameters

array

current node

Definition at line 545 of file class.ilCopyWizardOptions.php.

References $options.

Referenced by storeTree().

        {
                global $tree;
                
                $this->tmp_tree[] = $tree->getNodeData($a_source_id);
                
                
                foreach($tree->getChilds($a_source_id) as $sub_nodes)
                {
                        $sub_node_ref_id = $sub_nodes['child'];
                        // check ommited, linked ...
                        $options = $this->options[$sub_node_ref_id];
                        if($options['type'] == self::COPY_WIZARD_COPY or
                                $options['type'] == self::COPY_WIZARD_LINK)
                        {
                                $this->readTree($sub_node_ref_id);
                        }
                }
        }

Here is the caller graph for this function:

saveOwner()

ilCopyWizardOptions::saveOwner

(

$a_user_id

)

Save owner for copy.

It will be checked against this user id in all soap calls

public

Parameters

Definition at line 145 of file class.ilCopyWizardOptions.php.

References $ilDB, and getCopyId().

        {
                global $ilDB;

                $ilDB->insert("copy_wizard_options", array(
                        "copy_id"       => array("integer", $this->getCopyId()),
                        "source_id" => array("integer", self::OWNER_KEY),
                        "options"       => array('clob',serialize(array($a_user_id)))
                        ));

                return true;
        }

Here is the call graph for this function:

saveRoot()

ilCopyWizardOptions::saveRoot

(

$a_root

)

Save root node id.

public

Parameters

int	ref_id of copy source

Definition at line 165 of file class.ilCopyWizardOptions.php.

References $ilDB, and getCopyId().

        {
                global $ilDB;

                $ilDB->insert("copy_wizard_options", array(
                        "copy_id"       => array("integer", $this->getCopyId()),
                        "source_id" => array("integer", self::ROOT_NODE),
                        "options"       => array('clob',serialize(array($a_root)))
                        ));

                return true;
                
        }

Here is the call graph for this function:

storeTree()

ilCopyWizardOptions::storeTree

(

$a_source_id

)

Save tree Stores two copies of the tree structure: id 0 is used for recursive call of cloneObject() id -1 is used for recursive call of cloneDependencies()

public

Parameters

int

source id

Definition at line 279 of file class.ilCopyWizardOptions.php.

References $ilDB, getCopyId(), and readTree().

        {
                global $ilDB;
                
                $this->tmp_tree = array();
                $this->readTree($a_source_id);
                $a_tree_structure = $this->tmp_tree;
                
                $ilDB->update("copy_wizard_options", array(
                        "options"       => array('clob',serialize($a_tree_structure))
                        ), array(
                        "copy_id"       => array('integer',$this->getCopyId()),
                        "source_id"     => array('integer',0
                )));

                $ilDB->insert('copy_wizard_options',array(
                        'copy_id'       => array('integer',$this->getCopyId()),
                        'source_id'     => array('integer',-1),
                        'options'       => array('clob',serialize($a_tree_structure))
                        ));

                return true; 
        }

Here is the call graph for this function:

Field Documentation

$copy_id

ilCopyWizardOptions::$copy_id

private

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

Referenced by getCopyId().

$db

ilCopyWizardOptions::$db

private

Definition at line 44 of file class.ilCopyWizardOptions.php.

$instances

ilCopyWizardOptions::$instances = null

staticprivate

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

$options

ilCopyWizardOptions::$options = array()

private

Definition at line 48 of file class.ilCopyWizardOptions.php.

Referenced by readTree().

$source_id

ilCopyWizardOptions::$source_id

private

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

COPY_WIZARD_COPY

const ilCopyWizardOptions::COPY_WIZARD_COPY = 2

Definition at line 37 of file class.ilCopyWizardOptions.php.

Referenced by ilCopyWizardExplorer\buildSelect(), ilCopyWizardPage\fetchSelected(), ilCopyWizardPage\fillItemBlock(), ilCopyWizardPage\fillMainBlock(), ilObjectCopySelectionTableGUI\fillRow(), ilCopyWizardPage\fillTreeSelection(), ilCopyWizardSettingsXMLParser\getActionForString(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), and initContainer().

COPY_WIZARD_LINK

const ilCopyWizardOptions::COPY_WIZARD_LINK = 3

Definition at line 38 of file class.ilCopyWizardOptions.php.

Referenced by ilCopyWizardExplorer\buildSelect(), ilCopyWizardPage\fillItemBlock(), ilCopyWizardPage\fillMainBlock(), ilObjectCopySelectionTableGUI\fillRow(), ilCopyWizardPage\fillTreeSelection(), ilCopyWizardSettingsXMLParser\getActionForString(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapUtils\ilClone(), and ilSoapUtils\ilCloneDependencies().

COPY_WIZARD_OMIT

const ilCopyWizardOptions::COPY_WIZARD_OMIT = 1

Definition at line 36 of file class.ilCopyWizardOptions.php.

Referenced by ilCopyWizardExplorer\buildSelect(), ilCopyWizardPage\fillItemBlock(), ilCopyWizardPage\fillMainBlock(), ilObjectCopySelectionTableGUI\fillRow(), ilCopyWizardPage\fillTreeSelection(), ilCopyWizardSettingsXMLParser\getActionForString(), ilSoapUtils\ilClone(), and ilSoapUtils\ilCloneDependencies().

DISABLE_SOAP

const ilCopyWizardOptions::DISABLE_SOAP = -4

Definition at line 41 of file class.ilCopyWizardOptions.php.

OWNER_KEY

const ilCopyWizardOptions::OWNER_KEY = -3

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

ROOT_NODE

const ilCopyWizardOptions::ROOT_NODE = -5

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

---

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

• Services/CopyWizard/classes/class.ilCopyWizardOptions.php