class.ilCopyDefinition.php

Go to the documentation of this file.

<?php
 
use ILIAS\BackgroundTasks\Implementation\Values\AbstractValue;
use ILIAS\BackgroundTasks\Implementation\Values\ScalarValues\BooleanValue;
use ILIAS\BackgroundTasks\Value;
 
class ilCopyDefinition extends AbstractValue
{
    public const COPY_SOURCE_DIR = 'source';
    public const COPY_TARGET_DIR = 'target';
    private array $copy_definitions = [];
    private string $temp_dir;
    private array $object_ref_ids = [];
    private int $num_files = 0;
    private ?int $sum_file_sizes = 0;
    private ?BooleanValue $adheres_to_limit = null;
 
    public function getCopyDefinitions(): array
    {
        return $this->copy_definitions;
    }
 
    public function setCopyDefinitions(array $a_definitions): void
    {
        $this->copy_definitions = $a_definitions;
    }
 
    public function getTempDir(): string
    {
        return $this->temp_dir;
    }
 
    public function setTempDir(string $temp_dir): void
    {
        $this->temp_dir = $temp_dir;
    }
 
    public function getObjectRefIds(): array
    {
        return $this->object_ref_ids;
    }
 
    public function setObjectRefIds(array $object_ref_ids, bool $append = false): void
    {
        $this->object_ref_ids = $append ? array_merge($this->object_ref_ids, $object_ref_ids) : $object_ref_ids;
    }
 
    public function getNumFiles(): int
    {
        return $this->num_files;
    }
 
    public function setNumFiles(int $num_files): void
    {
        $this->num_files = $num_files;
    }
 
    public function getSumFileSizes(): int
    {
        return $this->sum_file_sizes ?? 0;
    }
 
    public function setSumFileSizes(int $sum_file_sizes): void
    {
        $this->sum_file_sizes = $sum_file_sizes;
    }
 
    public function getAdheresToLimit(): BooleanValue
    {
        $fallback = new BooleanValue();
        $fallback->setValue(false);
        return $this->adheres_to_limit ?? $fallback;
    }
 
    public function setAdheresToLimit(BooleanValue $adheres_to_limit): void
    {
        $this->adheres_to_limit = $adheres_to_limit;
    }
 
    public function addCopyDefinition(string $a_source, string $a_target): void
    {
        $this->copy_definitions[]
            = [
            self::COPY_SOURCE_DIR => $a_source,
            self::COPY_TARGET_DIR => $a_target,
        ];
    }
 
    public function equals(Value $other): bool
    {
        return strcmp($this->getHash(), $other->getHash());
    }
 
    public function getHash(): string
    {
        return md5($this->serialize());
    }
 
    public function serialize()
    {
        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(),
            ]
        );
    }
 
    public function setValue($value): void
    {
        $this->copy_definitions = $value;
    }
 
    public function unserialize($serialized): void
    {
        $elements = unserialize($serialized);
 
        $this->setCopyDefinitions($elements["copy_definition"]);
        $this->setTempDir($elements['temp_dir']);
        $this->setObjectRefIds(explode(",", (string) $elements["object_ref_ids"]));
        $this->setNumFiles($elements["num_files"]);
        $this->setSumFileSizes($elements["sum_file_sizes"]);
        $this->setAdheresToLimit($elements["adheres_to_limit"]);
    }
}