Description of class class. More...

Inheritance diagram for ilCalendarCopyDefinition:

Collaboration diagram for ilCalendarCopyDefinition:

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...

	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

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

Detailed Description

Description of class class.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Member Function Documentation

◆ addCopyDefinition()

ilCalendarCopyDefinition::addCopyDefinition	(	$a_source,
		$a_target
	)

Add copy definition.

Parameters

string	$a_source
string	$a_target

Definition at line 74 of file class.ilCalendarCopyDefinition.php.

Referenced by ilDownloadFilesBackgroundTask\collectFiles().

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

Here is the caller graph for this function:

◆ equals()

ilCalendarCopyDefinition::equals ( Value $other )

Check equality.

Parameters

Value $other

Returns: bool

Implements ILIAS\BackgroundTasks\Value.

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

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

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

Here is the call graph for this function:

◆ getCopyDefinitions()

ilCalendarCopyDefinition::getCopyDefinitions ( )

Get copy definitions.

Returns: string[]

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

References $copy_definitions.

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

     {
         return $this->copy_definitions;
     }

Here is the caller graph for this function:

◆ getHash()

ilCalendarCopyDefinition::getHash ( )

Get hash.

Returns: string

Implements ILIAS\BackgroundTasks\Value.

Definition at line 99 of file class.ilCalendarCopyDefinition.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:

◆ getTempDir()

ilCalendarCopyDefinition::getTempDir ( )

Get directory name located in /temp/ directory.

Returns: string

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

References $temp_dir.

Referenced by serialize().

     {
         return $this->temp_dir;
     }

Here is the caller graph for this function:

◆ serialize()

ilCalendarCopyDefinition::serialize ( )

Serialize content.

Definition at line 107 of file class.ilCalendarCopyDefinition.php.

References getCopyDefinitions(), and getTempDir().

Referenced by getHash().

     {
         return serialize(
             [
                 "copy_definition" => $this->getCopyDefinitions(),
                 "temp_dir" => $this->getTempDir()
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCopyDefinitions()

ilCalendarCopyDefinition::setCopyDefinitions ( $a_definitions )

Set copy definitions.

Parameters

string[] $a_definitions

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

Referenced by unserialize().

     {
         $this->copy_definitions = $a_definitions;
     }

Here is the caller graph for this function:

◆ setTempDir()

ilCalendarCopyDefinition::setTempDir ( $temp_dir )

Set directory name located in /temp/ directory.

Parameters

$temp_dir

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

References $temp_dir.

Referenced by unserialize().

     {
         $this->temp_dir = $temp_dir;
     }

Here is the caller graph for this function:

◆ setValue()

ilCalendarCopyDefinition::setValue ( $value )

Set value.

Parameters

string[] $value

Implements ILIAS\BackgroundTasks\Value.

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

     {
         $this->copy_definitions = $value;
     }

◆ unserialize()

ilCalendarCopyDefinition::unserialize ( $serialized )

Unserialize definitions.

Parameters

string $serialized

Definition at line 130 of file class.ilCalendarCopyDefinition.php.

References setCopyDefinitions(), and setTempDir().

     {
         $elements = unserialize($serialized);
 
         $this->setCopyDefinitions($elements["copy_definition"]);
         $this->setTempDir($elements['temp_dir']);
     }