ilWorkspaceCopyDefinition Class Reference

Copy definition for worspace folders. More...

Inheritance diagram for ilWorkspaceCopyDefinition:

Collaboration diagram for ilWorkspaceCopyDefinition:

Public Member Functions
	getCopyDefinitions ()
	Get copy definitions. More...
	setCopyDefinitions ($a_definitions)
	Set copy definitions. More...
	getTempDir ()
	Get directory name located in /temp/ directory. More...
	setTempDir ($temp_dir)
	Set directory name located in /temp/ directory. More...
	getObjectWspIds ()
	setObjectWspIds ($object_wps_ids, $append=false)
	getNumFiles ()
	setNumFiles ($num_files)
	getSumFileSizes ()
	setSumFileSizes ($sum_file_sizes)
	getAdheresToLimit ()
	setAdheresToLimit ($adheres_to_limit)
	addCopyDefinition ($a_source, $a_target)
	Add copy definition. More...
	equals (Value $other)
	Check equality. More...
	getHash ()
	Get hash. More...
	serialize ()
	Serialize content. More...
	setValue ($value)
	Set value. More...
	unserialize ($serialized)
	Unserialize definitions. More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Values\AbstractValue
	getType ()
	getParentTask ()
	setParentTask (Task $parentTask)
	hasParentTask ()

Data Fields
const	COPY_SOURCE_DIR = 'source'
const	COPY_TARGET_DIR = 'target'

Private Attributes
	$copy_definitions = []
	Copy Jobs: source file => relative target file in zip directory. More...
	$temp_dir
	$object_wsp_ids = []
	$num_files = 0
	$sum_file_sizes = 0
	$adheres_to_limit = false

Additional Inherited Members
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Values\AbstractValue
	$parentTask

Detailed Description

Copy definition for worspace folders.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 14 of file class.ilWorkspaceCopyDefinition.php.

Member Function Documentation

addCopyDefinition()

ilWorkspaceCopyDefinition::addCopyDefinition	(		$a_source,
			$a_target
	)

Add copy definition.

Parameters

string	$a_source
string	$a_target

Definition at line 168 of file class.ilWorkspaceCopyDefinition.php.

    {
        $this->copy_definitions[] =
            [
                self::COPY_SOURCE_DIR => $a_source,
                self::COPY_TARGET_DIR => $a_target
            ];
    }

equals()

ilWorkspaceCopyDefinition::equals

(

Value

$other

)

Check equality.

Parameters

Value

$other

Returns

bool

Implements ILIAS\BackgroundTasks\Value.

Definition at line 183 of file class.ilWorkspaceCopyDefinition.php.

References ILIAS\BackgroundTasks\Value\getHash(), and getHash().

    {
        return strcmp($this->getHash(), $other->getHash());
    }

Here is the call graph for this function:

getAdheresToLimit()

ilWorkspaceCopyDefinition::getAdheresToLimit

(

)

Returns

bool

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

References $adheres_to_limit.

Referenced by serialize().

    {
        return $this->adheres_to_limit;
    }

Here is the caller graph for this function:

getCopyDefinitions()

ilWorkspaceCopyDefinition::getCopyDefinitions

(

)

Get copy definitions.

Returns

string[]

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

References $copy_definitions.

Referenced by ilCopyWorkspaceFilesToTempDirectoryJob\copyFiles(), and serialize().

    {
        return $this->copy_definitions;
    }

Here is the caller graph for this function:

getHash()

ilWorkspaceCopyDefinition::getHash

(

)

Get hash.

Returns

string

Implements ILIAS\BackgroundTasks\Value.

Definition at line 193 of file class.ilWorkspaceCopyDefinition.php.

References serialize().

Referenced by equals().

    {
        return md5($this->serialize());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNumFiles()

ilWorkspaceCopyDefinition::getNumFiles

(

)

Returns

int

Definition at line 117 of file class.ilWorkspaceCopyDefinition.php.

References $num_files.

Referenced by serialize().

    {
        return $this->num_files;
    }

Here is the caller graph for this function:

getObjectWspIds()

ilWorkspaceCopyDefinition::getObjectWspIds

(

)

Returns

string[]

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

References $object_wsp_ids.

Referenced by serialize().

    {
        return $this->object_wsp_ids;
    }

Here is the caller graph for this function:

getSumFileSizes()

ilWorkspaceCopyDefinition::getSumFileSizes

(

)

Returns

int

Definition at line 133 of file class.ilWorkspaceCopyDefinition.php.

References $sum_file_sizes.

Referenced by serialize().

    {
        return $this->sum_file_sizes;
    }

Here is the caller graph for this function:

getTempDir()

ilWorkspaceCopyDefinition::getTempDir

(

)

Get directory name located in /temp/ directory.

Returns

string

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

References $temp_dir.

Referenced by serialize().

    {
        return $this->temp_dir;
    }

Here is the caller graph for this function:

serialize()

ilWorkspaceCopyDefinition::serialize

(

)

Serialize content.

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

References getAdheresToLimit(), getCopyDefinitions(), getNumFiles(), getObjectWspIds(), getSumFileSizes(), and getTempDir().

Referenced by getHash().

    {
        return serialize(
            [
                "copy_definition" => $this->getCopyDefinitions(),
                "temp_dir" => $this->getTempDir(),
                "object_wsp_ids" => implode(",", $this->getObjectWspIds()),
                "num_files" => $this->getNumFiles(),
                "sum_file_sizes" => $this->getSumFileSizes(),
                "adheres_to_limit" => $this->getAdheresToLimit()
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAdheresToLimit()

ilWorkspaceCopyDefinition::setAdheresToLimit

(

$adheres_to_limit

)

Parameters

bool

$adheres_to_limit

Definition at line 157 of file class.ilWorkspaceCopyDefinition.php.

References $adheres_to_limit.

Referenced by unserialize().

    {
        $this->adheres_to_limit = $adheres_to_limit;
    }

Here is the caller graph for this function:

setCopyDefinitions()

ilWorkspaceCopyDefinition::setCopyDefinitions

(

$a_definitions

)

Set copy definitions.

Parameters

string[]

$a_definitions

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

Referenced by unserialize().

    {
        $this->copy_definitions = $a_definitions;
    }

Here is the caller graph for this function:

setNumFiles()

ilWorkspaceCopyDefinition::setNumFiles

(

$num_files

)

Parameters

$num_files

Definition at line 125 of file class.ilWorkspaceCopyDefinition.php.

References $num_files.

Referenced by unserialize().

    {
        $this->num_files = $num_files;
    }

Here is the caller graph for this function:

setObjectWspIds()

ilWorkspaceCopyDefinition::setObjectWspIds	(		$object_wps_ids,
			$append = false
	)

Parameters

$object_wsp_ids
$append

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

Referenced by unserialize().

    {
        if ($append) {
            array_merge($this->object_wsp_ids, $object_wps_ids);
        } else {
            $this->object_wsp_ids = $object_wps_ids;
        }
    }

Here is the caller graph for this function:

setSumFileSizes()

ilWorkspaceCopyDefinition::setSumFileSizes

(

$sum_file_sizes

)

Parameters

int

$sum_file_sizes

Definition at line 141 of file class.ilWorkspaceCopyDefinition.php.

References $sum_file_sizes.

Referenced by unserialize().

    {
        $this->sum_file_sizes = $sum_file_sizes;
    }

Here is the caller graph for this function:

setTempDir()

ilWorkspaceCopyDefinition::setTempDir

(

$temp_dir

)

Set directory name located in /temp/ directory.

Parameters

$temp_dir

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

References $temp_dir.

Referenced by unserialize().

    {
        $this->temp_dir = $temp_dir;
    }

Here is the caller graph for this function:

setValue()

ilWorkspaceCopyDefinition::setValue

(

$value

)

Set value.

Parameters

string[]

$value

Implements ILIAS\BackgroundTasks\Value.

Definition at line 219 of file class.ilWorkspaceCopyDefinition.php.

    {
        $this->copy_definitions = $value;
    }

unserialize()

ilWorkspaceCopyDefinition::unserialize

(

$serialized

)

Unserialize definitions.

Parameters

string

$serialized

Definition at line 228 of file class.ilWorkspaceCopyDefinition.php.

References setAdheresToLimit(), setCopyDefinitions(), setNumFiles(), setObjectWspIds(), setSumFileSizes(), and setTempDir().

    {
        $elements = unserialize($serialized);

        $this->setCopyDefinitions($elements["copy_definition"]);
        $this->setTempDir($elements['temp_dir']);
        $this->setObjectWspIds(explode(",", $elements["object_wsp_ids"]));
        $this->setNumFiles($elements["num_files"]);
        $this->setSumFileSizes($elements["sum_file_sizes"]);
        $this->setAdheresToLimit($elements["adheres_to_limit"]);
    }

Here is the call graph for this function:

Field Documentation

$adheres_to_limit

ilWorkspaceCopyDefinition::$adheres_to_limit = false

private

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

Referenced by getAdheresToLimit(), and setAdheresToLimit().

$copy_definitions

ilWorkspaceCopyDefinition::$copy_definitions = []

private

Copy Jobs: source file => relative target file in zip directory.

Parameters

string[]

Definition at line 23 of file class.ilWorkspaceCopyDefinition.php.

Referenced by getCopyDefinitions().

$num_files

ilWorkspaceCopyDefinition::$num_files = 0

private

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

Referenced by getNumFiles(), and setNumFiles().

$object_wsp_ids

ilWorkspaceCopyDefinition::$object_wsp_ids = []

private

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

Referenced by getObjectWspIds().

$sum_file_sizes

ilWorkspaceCopyDefinition::$sum_file_sizes = 0

private

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

Referenced by getSumFileSizes(), and setSumFileSizes().

$temp_dir

ilWorkspaceCopyDefinition::$temp_dir

private

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

Referenced by getTempDir(), and setTempDir().

COPY_SOURCE_DIR

const ilWorkspaceCopyDefinition::COPY_SOURCE_DIR = 'source'

Definition at line 16 of file class.ilWorkspaceCopyDefinition.php.

Referenced by ilCopyWorkspaceFilesToTempDirectoryJob\copyFiles().

COPY_TARGET_DIR

const ilWorkspaceCopyDefinition::COPY_TARGET_DIR = 'target'

Definition at line 17 of file class.ilWorkspaceCopyDefinition.php.

Referenced by ilCopyWorkspaceFilesToTempDirectoryJob\copyFiles().

---

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

• Modules/WorkspaceFolder/BackgroundTask/classes/class.ilWorkspaceCopyDefinition.php