ilCopyDefinition Class Reference

Description of class class. More...

Inheritance diagram for ilCopyDefinition:

Collaboration diagram for ilCopyDefinition:

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...
	getObjectRefIds ()
	setObjectRefIds (array $object_ref_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)
	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
array	$copy_definitions = []
string	$temp_dir
	Temporary directory using the normalized title of the bucket. More...
array	$object_ref_ids = []
int	$num_files = 0
int	$sum_file_sizes = 0
BooleanValue	$adheres_to_limit
	States if the sum of all file sizes adheres to the global limit. More...

Additional Inherited Members
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Values\AbstractValue
Task	$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 27 of file class.ilCopyDefinition.php.

Member Function Documentation

addCopyDefinition()

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

Definition at line 144 of file class.ilCopyDefinition.php.

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

equals()

ilCopyDefinition::equals

(

Value

$other

)

Check equality.

Implements ILIAS\BackgroundTasks\Value.

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

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

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

Here is the call graph for this function:

getAdheresToLimit()

ilCopyDefinition::getAdheresToLimit

(

)

Definition at line 132 of file class.ilCopyDefinition.php.

Referenced by serialize().

                                       : BooleanValue
    {
        $fallback = new BooleanValue();
        $fallback->setValue(false);
        return $this->adheres_to_limit ?? $fallback;
    }

Here is the caller graph for this function:

getCopyDefinitions()

ilCopyDefinition::getCopyDefinitions

(

)

Get copy definitions.

Returns

array<string, string>[]|string[]

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

References $copy_definitions.

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

                                        : array
    {
        return $this->copy_definitions;
    }

Here is the caller graph for this function:

getHash()

ilCopyDefinition::getHash

(

)

Get hash.

Implements ILIAS\BackgroundTasks\Value.

Definition at line 164 of file class.ilCopyDefinition.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()

ilCopyDefinition::getNumFiles

(

)

Definition at line 112 of file class.ilCopyDefinition.php.

References $num_files.

Referenced by serialize().

                                 : int
    {
        return $this->num_files;
    }

Here is the caller graph for this function:

getObjectRefIds()

ilCopyDefinition::getObjectRefIds

(

)

Returns

int[]

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

References $object_ref_ids.

Referenced by serialize().

                                     : array
    {
        return $this->object_ref_ids;
    }

Here is the caller graph for this function:

getSumFileSizes()

ilCopyDefinition::getSumFileSizes

(

)

Definition at line 122 of file class.ilCopyDefinition.php.

Referenced by serialize().

                                     : int
    {
        return $this->sum_file_sizes ?? 0;
    }

Here is the caller graph for this function:

getTempDir()

ilCopyDefinition::getTempDir

(

)

Get directory name located in /temp/ directory.

Definition at line 82 of file class.ilCopyDefinition.php.

References $temp_dir.

Referenced by serialize().

                                : string
    {
        return $this->temp_dir;
    }

Here is the caller graph for this function:

serialize()

ilCopyDefinition::serialize

(

)

Serialize content.

Returns

string

Definition at line 173 of file class.ilCopyDefinition.php.

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

Referenced by getHash().

    {
        return serialize(
            [
                "copy_definition" => $this->getCopyDefinitions(),
                "temp_dir" => $this->getTempDir(),
                "object_ref_ids" => implode(",", $this->getObjectRefIds()),
                "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()

ilCopyDefinition::setAdheresToLimit

(

BooleanValue

$adheres_to_limit

)

Definition at line 139 of file class.ilCopyDefinition.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()

ilCopyDefinition::setCopyDefinitions

(

array

$a_definitions

)

Set copy definitions.

Parameters

string[]

$a_definitions

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

Referenced by unserialize().

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

Here is the caller graph for this function:

setNumFiles()

ilCopyDefinition::setNumFiles

(

int

$num_files

)

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

References $num_files.

Referenced by unserialize().

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

Here is the caller graph for this function:

setObjectRefIds()

ilCopyDefinition::setObjectRefIds	(	array	$object_ref_ids,
		bool	$append = false
	)

Parameters

int[]

$object_ref_ids

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

References $object_ref_ids.

Referenced by unserialize().

                                                                                : void
    {
        $this->object_ref_ids = $append ? array_merge($this->object_ref_ids, $object_ref_ids) : $object_ref_ids;
    }

Here is the caller graph for this function:

setSumFileSizes()

ilCopyDefinition::setSumFileSizes

(

int

$sum_file_sizes

)

Definition at line 127 of file class.ilCopyDefinition.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()

ilCopyDefinition::setTempDir

(

string

$temp_dir

)

Set directory name located in /temp/ directory.

Parameters

$temp_dir

Definition at line 91 of file class.ilCopyDefinition.php.

References $temp_dir.

Referenced by unserialize().

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

Here is the caller graph for this function:

setValue()

ilCopyDefinition::setValue

(

$value

)

Set value.

Parameters

$value

Implements ILIAS\BackgroundTasks\Value.

Definition at line 191 of file class.ilCopyDefinition.php.

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

unserialize()

ilCopyDefinition::unserialize

(

$serialized

)

Unserialize definitions.

Parameters

string

$serialized

Definition at line 200 of file class.ilCopyDefinition.php.

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

    {
        $elements = unserialize($serialized);

        $this->setCopyDefinitions($elements["copy_definition"]);
        $this->setTempDir($elements['temp_dir']);
        $this->setObjectRefIds(explode(",", $elements["object_ref_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

BooleanValue ilCopyDefinition::$adheres_to_limit

private

States if the sum of all file sizes adheres to the global limit.

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

Referenced by setAdheresToLimit().

$copy_definitions

array ilCopyDefinition::$copy_definitions = []

private

Definition at line 36 of file class.ilCopyDefinition.php.

Referenced by getCopyDefinitions().

$num_files

int ilCopyDefinition::$num_files = 0

private

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

Referenced by getNumFiles(), and setNumFiles().

$object_ref_ids

array ilCopyDefinition::$object_ref_ids = []

private

Definition at line 45 of file class.ilCopyDefinition.php.

Referenced by getObjectRefIds(), and setObjectRefIds().

$sum_file_sizes

int ilCopyDefinition::$sum_file_sizes = 0

private

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

Referenced by setSumFileSizes().

$temp_dir

string ilCopyDefinition::$temp_dir

private

Temporary directory using the normalized title of the bucket.

Definition at line 40 of file class.ilCopyDefinition.php.

Referenced by getTempDir(), and setTempDir().

COPY_SOURCE_DIR

const ilCopyDefinition::COPY_SOURCE_DIR = 'source'

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

Referenced by ilCopyFilesToTempDirectoryJob\copyFiles().

COPY_TARGET_DIR

const ilCopyDefinition::COPY_TARGET_DIR = 'target'

Definition at line 30 of file class.ilCopyDefinition.php.

Referenced by ilCopyFilesToTempDirectoryJob\copyFiles().

---

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

• Services/BackgroundTasks/classes/class.ilCopyDefinition.php