class.ilObjFileAbstractProcessor.php

Go to the documentation of this file.

<?php
 
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder;
use ILIAS\ResourceStorage\Services;
 
abstract class ilObjFileAbstractProcessor implements ilObjFileProcessorInterface
{
    protected ilFileServicesPolicy $policy;
    protected ilFileServicesSettings $settings;
    protected ilCountPDFPages $page_counter;
    protected Services $storage;
    protected ResourceStakeholder $stakeholder;
    protected ilObjFileGUI $gui_object;
    protected array $invalid_file_names = [];
 
    public function __construct(
        ResourceStakeholder $stakeholder,
        ilObjFileGUI $gui_object,
        Services $storage,
        ilFileServicesSettings $settings
    ) {
        $this->storage = $storage;
        $this->stakeholder = $stakeholder;
        $this->gui_object = $gui_object;
        $this->page_counter = new ilCountPDFPages();
        $this->settings = $settings;
        $this->policy = new ilFileServicesPolicy($this->settings);
    }
 
    protected function createFileObj(
        ResourceIdentification $rid,
        int $parent_id,
        array $options = [],
        bool $create_reference = false
    ): ilObjFile {
        $revision = $this->storage->manage()->getCurrentRevision($rid);
        $file_obj = new ilObjFile();
        $file_obj->setResourceId($rid);
        if ($this->page_counter->isAvailable()) {
            $file_obj->setPageCount($this->page_counter->extractAmountOfPagesByRID($rid) ?? 0);
        }
 
        $file_name = $revision->getInformation()->getTitle();
        $title = $file_obj->appendSuffixToTitle(
            empty($options[self::OPTION_FILENAME]) ? $file_name : $options[self::OPTION_FILENAME],
            $file_name
        );
 
        $revision->setTitle($title);
        $this->storage->manage()->updateRevision($revision);
 
        if (!$this->policy->isValidExtension($revision->getInformation()->getSuffix())) {
            $this->invalid_file_names[] = $title;
        }
        $file_obj->setTitle($title);
        $file_obj->setFileName($title);
        $file_obj->setVersion($revision->getVersionNumber());
 
        if (!empty($options)) {
            $this->applyOptions($file_obj, $options);
        }
 
        $file_obj->create();
 
        ilPreview::createPreview($file_obj, true);
        if ($create_reference) {
            $file_obj->createReference();
        }
 
        $file_obj->processAutoRating();
        $this->gui_object->putObjectInTree($file_obj, $parent_id);
 
        return $file_obj;
    }
 
    protected function applyOptions(ilObject $obj, array $options): void
    {
        foreach ($options as $key => $option) {
            if (in_array($key, self::OPTIONS, true)) {
                if (!empty($option)) {
                    $setter = "set" . ucfirst($key);
                    $obj->{$setter}($option);
                }
            } else {
                throw new LogicException("Option '$key' is not declared in " . static::class . "::OPTIONS.");
            }
        }
    }
 
    public function getInvalidFileNames(): array
    {
        return $this->invalid_file_names;
    }
}