Copy definition for workspace folders. More...

Inheritance diagram for ilWorkspaceCopyDefinition:

Collaboration diagram for ilWorkspaceCopyDefinition:

Public Member Functions
	__construct ()

	getCopyDefinitions ()

	setCopyDefinitions (array $a_definitions)
	Set copy definitions. More...

	getTempDir ()

	setTempDir (string $temp_dir)
	Set directory name located in /temp/ directory. More...

	getObjectWspIds ()

	setObjectWspIds (array $object_wps_ids, bool $append=false)

	getNumFiles ()

	setNumFiles (int $num_files)

	getSumFileSizes ()

	setSumFileSizes (int $sum_file_sizes)

	getAdheresToLimit ()

	setAdheresToLimit (BooleanValue $adheres_to_limit)

	addCopyDefinition (string $a_source, string $a_target)

	equals (Value $other)

	getHash ()

	serialize ()

	setValue ($value)
	Set value. More...

	unserialize (?string $data)
	Unserialize definitions. More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Values\AbstractValue
	getType ()

	getParentTask ()

	setParentTask (Task $parentTask)

	hasParentTask ()

	__serialize ()

	__unserialize (array $data)

	getHash ()

	equals (Value $other)

	getType ()

	setParentTask (Task $parentTask)

	getParentTask ()

	hasParentTask ()

	setValue ($value)

	__serialize ()

	__unserialize (array $data)

Data Fields
const	COPY_SOURCE_DIR = 'source'

const	COPY_TARGET_DIR = 'target'

Private Attributes
array	$copy_definitions = []
	Copy Jobs: source file => relative target file in zip directory. More...

string	$temp_dir

array	$object_wsp_ids = []

int	$num_files = 0

int	$sum_file_sizes = 0

BooleanValue	$adheres_to_limit

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

Detailed Description

Copy definition for workspace folders.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilWorkspaceCopyDefinition::__construct ( )

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

    {
        $adheres_to_limit = new BooleanValue();
        $adheres_to_limit->setValue(false);
        $this->adheres_to_limit = $adheres_to_limit;
    }

References $adheres_to_limit, and ILIAS\BackgroundTasks\Implementation\Values\ScalarValues\BooleanValue\setValue().

Here is the call graph for this function:

Member Function Documentation

◆ addCopyDefinition()

ilWorkspaceCopyDefinition::addCopyDefinition	(	string	$a_source,
		string	$a_target
	)

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

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

◆ equals()

ilWorkspaceCopyDefinition::equals ( Value $other )

Implements ILIAS\BackgroundTasks\Value.

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

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

References ILIAS\BackgroundTasks\Value\getHash().

Here is the call graph for this function:

◆ getAdheresToLimit()

ilWorkspaceCopyDefinition::getAdheresToLimit ( )

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

                                       : BooleanValue
    {
        return $this->adheres_to_limit;
    }

◆ getCopyDefinitions()

ilWorkspaceCopyDefinition::getCopyDefinitions ( )

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

                                        : array
    {
        return $this->copy_definitions;
    }

References $copy_definitions.

◆ getHash()

ilWorkspaceCopyDefinition::getHash ( )

Returns: string Gets a hash for this Value. If two objects are the same the hash must be the same! if two objects are different you need to have as view collisions as possible.

Implements ILIAS\BackgroundTasks\Value.

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

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

◆ getNumFiles()

ilWorkspaceCopyDefinition::getNumFiles ( )

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

                                 : int
    {
        return $this->num_files;
    }

◆ getObjectWspIds()

ilWorkspaceCopyDefinition::getObjectWspIds ( )

Returns: string[]

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

                                     : array
    {
        return $this->object_wsp_ids;
    }

References $object_wsp_ids.

◆ getSumFileSizes()

ilWorkspaceCopyDefinition::getSumFileSizes ( )

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

                                     : int
    {
        return $this->sum_file_sizes;
    }

◆ getTempDir()

ilWorkspaceCopyDefinition::getTempDir ( )

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

                                : string
    {
        return $this->temp_dir;
    }

References $temp_dir.

◆ serialize()

ilWorkspaceCopyDefinition::serialize ( )

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

                               : string
    {
        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()
            ]
        );
    }

◆ setAdheresToLimit()

ilWorkspaceCopyDefinition::setAdheresToLimit ( BooleanValue $adheres_to_limit )

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

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

◆ setCopyDefinitions()

ilWorkspaceCopyDefinition::setCopyDefinitions ( array $a_definitions )

Set copy definitions.

Parameters

string[] $a_definitions

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

                                                            : void
    {
        $this->copy_definitions = $a_definitions;
    }

◆ setNumFiles()

ilWorkspaceCopyDefinition::setNumFiles ( int $num_files )

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

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

◆ setObjectWspIds()

ilWorkspaceCopyDefinition::setObjectWspIds	(	array	$object_wps_ids,
		bool	$append = `false`
	)

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

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

◆ setSumFileSizes()

ilWorkspaceCopyDefinition::setSumFileSizes ( int $sum_file_sizes )

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

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

◆ setTempDir()

ilWorkspaceCopyDefinition::setTempDir ( string $temp_dir )

Set directory name located in /temp/ directory.

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

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

References $temp_dir.

◆ setValue()

ilWorkspaceCopyDefinition::setValue ( $value )

Set value.

Parameters

$value

Implements ILIAS\BackgroundTasks\Value.

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

                                    : void
    {
        $this->copy_definitions = $value;
    }

◆ unserialize()

ilWorkspaceCopyDefinition::unserialize ( ?string $data )

Unserialize definitions.

Parameters

string $data

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

                                              : void
    {
        $elements = unserialize((string) $data, ['allowed_classes' => false]);
 
        $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"]);
    }