Inheritance diagram for ilCalendarRessourceStorageCopyDefinition:

Collaboration diagram for ilCalendarRessourceStorageCopyDefinition:

Public Member Functions
	getCopyDefinitions ()
	Get copy definitions. More...

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

	getTempDir ()
	Get directory name located in /temp/ directory. More...

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

	addCopyDefinition (string $a_path, string $a_target)
	Add copy definition. More...

	addCopyDefinitionRId (string $a_ressource_id, string $a_target)

	equals (Value $other)
	@inheritDoc More...

	getHash ()
	@inheritDoc More...

	serialize ()
	@inheritDoc More...

	setValue ($value)
	@inheritDoc More...

	unserialize ($data)
	@inheritDoc 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_RESSOURCE_ID = 'ressource_id'

const	COPY_ABSOLUTE_PATH = 'absolute_path'

const	COPY_TARGET_DIR = 'target'

Private Attributes
array	$copy_definitions = []

string	$temp_dir

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

Detailed Description

Definition at line 24 of file class.ilCalendarRessourceStorageCopyDefinition.php.

Member Function Documentation

◆ addCopyDefinition()

ilCalendarRessourceStorageCopyDefinition::addCopyDefinition	(	string	$a_path,
		string	$a_target
	)

Add copy definition.

Definition at line 77 of file class.ilCalendarRessourceStorageCopyDefinition.php.

                                                                       : void
    {
        $this->copy_definitions[] =
            [
                self::COPY_RESSOURCE_ID => null,
                self::COPY_ABSOLUTE_PATH => $a_path,
                self::COPY_TARGET_DIR => $a_target
            ];
    }

Referenced by ilDownloadFilesBackgroundTask\collectFiles().

Here is the caller graph for this function:

◆ addCopyDefinitionRId()

ilCalendarRessourceStorageCopyDefinition::addCopyDefinitionRId	(	string	$a_ressource_id,
		string	$a_target
	)

Definition at line 87 of file class.ilCalendarRessourceStorageCopyDefinition.php.

                                                                                  : void
    {
        $this->copy_definitions[] =
            [
                self::COPY_RESSOURCE_ID => $a_ressource_id,
                self::COPY_ABSOLUTE_PATH => null,
                self::COPY_TARGET_DIR => $a_target
            ];
    }

Referenced by ilDownloadFilesBackgroundTask\collectFiles().

Here is the caller graph for this function:

◆ equals()

ilCalendarRessourceStorageCopyDefinition::equals ( Value $other )

@inheritDoc

Implements ILIAS\BackgroundTasks\Value.

Definition at line 100 of file class.ilCalendarRessourceStorageCopyDefinition.php.

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

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

Here is the call graph for this function:

◆ getCopyDefinitions()

ilCalendarRessourceStorageCopyDefinition::getCopyDefinitions ( )

Get copy definitions.

Returns: ilCalendarRessourceStorageCopyDefinition[]

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

                                        : array
    {
        return $this->copy_definitions;
    }

References $copy_definitions.

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

Here is the caller graph for this function:

◆ getHash()

ilCalendarRessourceStorageCopyDefinition::getHash ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Value.

Definition at line 108 of file class.ilCalendarRessourceStorageCopyDefinition.php.

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

References serialize().

Referenced by equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTempDir()

ilCalendarRessourceStorageCopyDefinition::getTempDir ( )

Get directory name located in /temp/ directory.

Returns: string

Definition at line 60 of file class.ilCalendarRessourceStorageCopyDefinition.php.

                                : string
    {
        return $this->temp_dir;
    }

References $temp_dir.

Referenced by serialize().

Here is the caller graph for this function:

◆ serialize()

ilCalendarRessourceStorageCopyDefinition::serialize ( )

@inheritDoc

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

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

References getCopyDefinitions(), getTempDir(), and serialize().

Referenced by getHash(), and serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCopyDefinitions()

ilCalendarRessourceStorageCopyDefinition::setCopyDefinitions ( array $a_definitions )

Set copy definitions.

Parameters

ilCalendarRessourceStorageCopyDefinition[] $a_definitions

Definition at line 51 of file class.ilCalendarRessourceStorageCopyDefinition.php.

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

Referenced by unserialize().

Here is the caller graph for this function:

◆ setTempDir()

ilCalendarRessourceStorageCopyDefinition::setTempDir ( string $temp_dir )

Set directory name located in /temp/ directory.

Parameters

string $temp_dir

Definition at line 69 of file class.ilCalendarRessourceStorageCopyDefinition.php.

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

References $temp_dir.

Referenced by unserialize().

Here is the caller graph for this function:

◆ setValue()

ilCalendarRessourceStorageCopyDefinition::setValue ( $value )

@inheritDoc

Implements ILIAS\BackgroundTasks\Value.

Definition at line 129 of file class.ilCalendarRessourceStorageCopyDefinition.php.

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

◆ unserialize()

ilCalendarRessourceStorageCopyDefinition::unserialize ( $data )

@inheritDoc

Definition at line 137 of file class.ilCalendarRessourceStorageCopyDefinition.php.

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