class.ilCopyDefinition.php

Go to the documentation of this file.

<?php

use ILIAS\BackgroundTasks\Implementation\Values\AbstractValue;
use ILIAS\BackgroundTasks\Value;

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilCopyDefinition extends AbstractValue
{
    const COPY_SOURCE_DIR = 'source';
    const COPY_TARGET_DIR = 'target';
    private $copy_definitions = [];
    private $temp_dir;
    private $object_ref_ids = [];
    private $num_files = 0;
    private $sum_file_sizes = 0;
    private $adheres_to_limit = false;


    public function getCopyDefinitions()
    {
        return $this->copy_definitions;
    }


    public function setCopyDefinitions($a_definitions)
    {
        $this->copy_definitions = $a_definitions;
    }


    public function getTempDir()
    {
        return $this->temp_dir;
    }


    public function setTempDir($temp_dir)
    {
        $this->temp_dir = $temp_dir;
    }


    public function getObjectRefIds()
    {
        return $this->object_ref_ids;
    }


    public function setObjectRefIds($object_ref_ids, $append = false)
    {
        if ($append) {
            array_merge($this->object_ref_ids, $object_ref_ids);
        } else {
            $this->object_ref_ids = $object_ref_ids;
        }
    }


    public function getNumFiles()
    {
        return $this->num_files;
    }


    public function setNumFiles($num_files)
    {
        $this->num_files = $num_files;
    }


    public function getSumFileSizes()
    {
        return $this->sum_file_sizes;
    }


    public function setSumFileSizes($sum_file_sizes)
    {
        $this->sum_file_sizes = $sum_file_sizes;
    }


    public function getAdheresToLimit()
    {
        return $this->adheres_to_limit;
    }


    public function setAdheresToLimit($adheres_to_limit)
    {
        $this->adheres_to_limit = $adheres_to_limit;
    }


    public function addCopyDefinition($a_source, $a_target)
    {
        $this->copy_definitions[]
            = [
            self::COPY_SOURCE_DIR => $a_source,
            self::COPY_TARGET_DIR => $a_target,
        ];
    }


    public function equals(Value $other)
    {
        return strcmp($this->getHash(), $other->getHash());
    }


    public function getHash()
    {
        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)
    {
        $this->copy_definitions = $value;
    }


    public function unserialize($serialized)
    {
        $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"]);
    }
}