Copy definition for workspace folders. More...

Inheritance diagram for ilWorkspaceCopyDefinition:

Collaboration diagram for ilWorkspaceCopyDefinition:

Public Member Functions
	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 ($data)
	Unserialize definitions. More...

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

	getParentTask ()

	setParentTask (Task $parentTask)

	hasParentTask ()

	__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 = null

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.

Member Function Documentation

◆ addCopyDefinition()

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

Definition at line 119 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 128 of file class.ilWorkspaceCopyDefinition.php.

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

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

Here is the call graph for this function:

◆ getAdheresToLimit()

ilWorkspaceCopyDefinition::getAdheresToLimit ( )

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

References $adheres_to_limit.

Referenced by serialize().

                                        : BooleanValue
     {
         return $this->adheres_to_limit;
     }

Here is the caller graph for this function:

◆ getCopyDefinitions()

ilWorkspaceCopyDefinition::getCopyDefinitions ( )

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

References $copy_definitions.

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

                                         : array
     {
         return $this->copy_definitions;
     }

Here is the caller graph for this function:

◆ 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 133 of file class.ilWorkspaceCopyDefinition.php.

References serialize().

Referenced by equals().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumFiles()

ilWorkspaceCopyDefinition::getNumFiles ( )

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

References $num_files.

Referenced by serialize().

                                  : int
     {
         return $this->num_files;
     }

Here is the caller graph for this function:

◆ getObjectWspIds()

ilWorkspaceCopyDefinition::getObjectWspIds ( )

Returns: string[]

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

References $object_wsp_ids.

Referenced by serialize().

                                      : array
     {
         return $this->object_wsp_ids;
     }

Here is the caller graph for this function:

◆ getSumFileSizes()

ilWorkspaceCopyDefinition::getSumFileSizes ( )

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

References $sum_file_sizes.

Referenced by serialize().

                                      : int
     {
         return $this->sum_file_sizes;
     }

Here is the caller graph for this function:

◆ getTempDir()

ilWorkspaceCopyDefinition::getTempDir ( )

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

References $temp_dir.

Referenced by serialize().

                                 : string
     {
         return $this->temp_dir;
     }

Here is the caller graph for this function:

◆ serialize()

ilWorkspaceCopyDefinition::serialize ( )

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

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

Referenced by getHash().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdheresToLimit()

ilWorkspaceCopyDefinition::setAdheresToLimit ( BooleanValue $adheres_to_limit )

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

References $adheres_to_limit.

Referenced by unserialize().

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

Here is the caller graph for this function:

◆ setCopyDefinitions()

ilWorkspaceCopyDefinition::setCopyDefinitions ( array $a_definitions )

Set copy definitions.

Parameters

string[] $a_definitions

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

Referenced by unserialize().

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

Here is the caller graph for this function:

◆ setNumFiles()

ilWorkspaceCopyDefinition::setNumFiles ( int $num_files )

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

References $num_files.

Referenced by unserialize().

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

Here is the caller graph for this function:

◆ setObjectWspIds()

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

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

Referenced by unserialize().

      : void {
         if ($append) {
             $this->object_wsp_ids = 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 ( int $sum_file_sizes )

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

References $sum_file_sizes.

Referenced by unserialize().

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

Here is the caller graph for this function:

◆ setTempDir()

ilWorkspaceCopyDefinition::setTempDir ( string $temp_dir )

Set directory name located in /temp/ directory.

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

References $temp_dir.

Referenced by unserialize().

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

Here is the caller graph for this function:

◆ setValue()

ilWorkspaceCopyDefinition::setValue ( $value )

Set value.

Parameters

$value

Implements ILIAS\BackgroundTasks\Value.

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

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

◆ unserialize()

ilWorkspaceCopyDefinition::unserialize ( $data )

Unserialize definitions.

Parameters

string $data

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

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

     {
         $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"]);
     }