ilObjFileAbstractProcessor Class Reference

Class ilObjFileAbstractProcessorInterface. More...

Inheritance diagram for ilObjFileAbstractProcessor:

Collaboration diagram for ilObjFileAbstractProcessor:

Public Member Functions
	__construct (ResourceStakeholder $stakeholder, ilObjFileGUI $gui_object, Services $storage, ilFileServicesSettings $settings)
	getInvalidFileNames ()
Public Member Functions inherited from ilObjFileProcessorInterface
	process (ResourceIdentification $rid, array $options=[])
	Processes a given resource for the given arguments. More...

Protected Member Functions
	createFileObj (ResourceIdentification $rid, int $parent_id, array $options=[], bool $create_reference=false)
	Creates an ilObjFile instance for the provided information. More...
	applyOptions (ilObject $obj, array $options)
	Apply provided options to the given object. More...

Protected Attributes
ilFileServicesPolicy	$policy
ilFileServicesSettings	$settings
ilCountPDFPages	$page_counter
Services	$storage
ResourceStakeholder	$stakeholder
ilObjFileGUI	$gui_object
array	$invalid_file_names = []

Additional Inherited Members
Data Fields inherited from ilObjFileProcessorInterface
const	OPTION_FILENAME = 'title'
const	OPTION_DESCRIPTION = 'description'
const	OPTIONS

Detailed Description

Class ilObjFileAbstractProcessorInterface.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 28 of file class.ilObjFileAbstractProcessor.php.

Constructor & Destructor Documentation

__construct()

ilObjFileAbstractProcessor::__construct	(	ResourceStakeholder	$stakeholder,
		ilObjFileGUI	$gui_object,
		Services	$storage,
		ilFileServicesSettings	$settings
	)

Definition at line 38 of file class.ilObjFileAbstractProcessor.php.

      {
        $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);
    }

References $gui_object, $settings, $stakeholder, $storage, and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

applyOptions()

ilObjFileAbstractProcessor::applyOptions ( ilObject  $obj, array  $options  )

protected

Apply provided options to the given object.

Definition at line 105 of file class.ilObjFileAbstractProcessor.php.

                                                                  : 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.");
            }
        }
    }

References ILIAS\LTI\ToolProvider\$key.

Referenced by ilObjFileAbstractZipProcessor\createContainerObj().

Here is the caller graph for this function:

createFileObj()

ilObjFileAbstractProcessor::createFileObj ( ResourceIdentification  $rid, int  $parent_id, array  $options = [], bool  $create_reference = false  )

protected

Creates an ilObjFile instance for the provided information.

See also

ilObjFileAbstractProcessorInterface::OPTIONS

Definition at line 56 of file class.ilObjFileAbstractProcessor.php.

     : 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;
    }

Referenced by ilObjFileProcessor\process(), ilObjFileUnzipFlatProcessor\process(), and ilObjFileUnzipRecursiveProcessor\process().

Here is the caller graph for this function:

getInvalidFileNames()

ilObjFileAbstractProcessor::getInvalidFileNames

(

)

Definition at line 119 of file class.ilObjFileAbstractProcessor.php.

                                         : array
    {
        return $this->invalid_file_names;
    }

Field Documentation

$gui_object

ilObjFileGUI ilObjFileAbstractProcessor::$gui_object

protected

Definition at line 35 of file class.ilObjFileAbstractProcessor.php.

Referenced by __construct(), and ilObjFileAbstractZipProcessor\__construct().

$invalid_file_names

array ilObjFileAbstractProcessor::$invalid_file_names = []

protected

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

$page_counter

ilCountPDFPages ilObjFileAbstractProcessor::$page_counter

protected

Definition at line 32 of file class.ilObjFileAbstractProcessor.php.

$policy

ilFileServicesPolicy ilObjFileAbstractProcessor::$policy

protected

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

$settings

ilFileServicesSettings ilObjFileAbstractProcessor::$settings

protected

Definition at line 31 of file class.ilObjFileAbstractProcessor.php.

Referenced by __construct(), and ilObjFileAbstractZipProcessor\__construct().

$stakeholder

ResourceStakeholder ilObjFileAbstractProcessor::$stakeholder

protected

Definition at line 34 of file class.ilObjFileAbstractProcessor.php.

Referenced by __construct(), and ilObjFileAbstractZipProcessor\__construct().

$storage

Services ilObjFileAbstractProcessor::$storage

protected

Definition at line 33 of file class.ilObjFileAbstractProcessor.php.

Referenced by __construct(), and ilObjFileAbstractZipProcessor\__construct().

---

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

• Modules/File/classes/Processors/class.ilObjFileAbstractProcessor.php