ILIAS\ResourceStorage\Resource\ResourceBuilder Class Reference

Class ResourceBuilder. More...

Collaboration diagram for ILIAS\ResourceStorage\Resource\ResourceBuilder:

Public Member Functions
	__construct (private StorageHandlerFactory $storage_handler_factory, Repositories $repositories, private LockHandler $lock_handler, private StreamAccess $stream_access, protected FileNamePolicy $file_name_policy=new NoneFileNamePolicy())
	ResourceBuilder constructor. More...
	new (UploadResult $result, InfoResolver $info_resolver, ResourceType $type=ResourceType::SINGLE_FILE)
	newFromStream (FileStream $stream, InfoResolver $info_resolver, bool $keep_original=false, ResourceType $type=ResourceType::SINGLE_FILE)
	newBlank (ResourceType $type=ResourceType::SINGLE_FILE)
	append (StorableResource $resource, UploadResult $result, InfoResolver $info_resolver, RevisionStatus $status)
	replaceWithUpload (StorableResource $resource, UploadResult $result, InfoResolver $info_resolver)
	appendFromStream (StorableResource $resource, FileStream $stream, InfoResolver $info_resolver, RevisionStatus $status, bool $keep_original=false,)
	replaceWithStream (StorableResource $resource, FileStream $stream, InfoResolver $info_resolver, bool $keep_original=false,)
	appendFromRevision (StorableResource $resource, int $revision_number)
	has (ResourceIdentification $identification)
	check if a resource exists More...
	store (StorableResource $resource)
	after you have modified a resource, you can store it here More...
	clone (StorableResource $resource)
	Clone anexisting resource with all it's revisions, stakeholders and information More...
	storeRevision (Revision $revision, ?StorableResource $resource=null)
	Store one Revision More...
	publish (StorableResource $resource)
	unpublish (StorableResource $resource)
	extractStream (Revision $revision)
	remove (StorableResource $resource, ?ResourceStakeholder $stakeholder=null)
	Remove a complete revision. More...
	removeRevision (StorableResource $resource, int $revision_number)
	createDirectoryInsideContainer (StorableContainerResource $container, string $path_inside_container,)
	removePathInsideContainer (StorableContainerResource $container, string $path_inside_container,)
	addUploadToContainer (StorableContainerResource $container, UploadResult $result, string $parent_path_inside_container,)
	addStreamToContainer (StorableContainerResource $container, FileStream $stream, string $path_inside_container,)

Protected Attributes
array	$resource_cache = []
StorageHandler	$primary_storage_handler

Private Member Functions
	buildDraftReplacementRevision (StorableResource $resource, Revision $new_revision, InfoResolver $info_resolver)
	ensurePathInZIP (\ZipArchive $zip, string $path, bool $is_file)
	deleteRevision (StorableResource $resource, Revision $revision)
	populateNakedResourceWithRevisionsAndStakeholders (StorableResource $resource)
	populateRevisionInfo (Revision $revision, InfoResolver $info_resolver)

Private Attributes
InformationRepository	$information_repository
ResourceRepository	$resource_repository
RevisionRepository	$revision_repository
StakeholderRepository	$stakeholder_repository
bool	$auto_migrate = true

Detailed Description

Class ResourceBuilder.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s.ch

Definition at line 57 of file ResourceBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Resource\ResourceBuilder::__construct	(	private StorageHandlerFactory	$storage_handler_factory,
		Repositories	$repositories,
		private LockHandler	$lock_handler,
		private StreamAccess	$stream_access,
		protected FileNamePolicy	$file_name_policy = new NoneFileNamePolicy()
	)

ResourceBuilder constructor.

Parameters

FileNamePolicy | null

$file_name_policy

Definition at line 89 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Repositories\getInformationRepository(), ILIAS\ResourceStorage\Repositories\getResourceRepository(), ILIAS\ResourceStorage\Repositories\getRevisionRepository(), and ILIAS\ResourceStorage\Repositories\getStakeholderRepository().

      {
        $this->primary_storage_handler = $this->storage_handler_factory->getPrimary();
        $this->revision_repository = $repositories->getRevisionRepository();
        $this->resource_repository = $repositories->getResourceRepository();
        $this->information_repository = $repositories->getInformationRepository();
        $this->stakeholder_repository = $repositories->getStakeholderRepository();
    }

Here is the call graph for this function:

Member Function Documentation

addStreamToContainer()

ILIAS\ResourceStorage\Resource\ResourceBuilder::addStreamToContainer	(	StorableContainerResource	$container,
		FileStream	$stream,
		string	$path_inside_container
	)

Definition at line 706 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\ensurePathInZIP(), ILIAS\ResourceStorage\Resource\ResourceBuilder\extractStream(), ILIAS\ResourceStorage\Resource\AbstractStorableResource\getCurrentRevisionIncludingDraft(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

     : bool {
        $revision = $container->getCurrentRevisionIncludingDraft();
        $revision_stream = $this->extractStream($revision);

        try {
            $zip = new \ZipArchive();
            $zip->open($revision_stream->getMetadata()['uri']);

            $path_inside_container = $this->ensurePathInZIP($zip, $path_inside_container, true);

            $return = $zip->addFromString(
                $path_inside_container,
                (string) $stream
            );
            $zip->close();

            // cleanup revision and flavours
            $this->storage_handler_factory->getHandlerForRevision($revision)->clearFlavours($revision);
            $revision->getInformation()->setSize(filesize($revision_stream->getMetadata()['uri']));
            $this->storeRevision($revision);

            return $return;
        } catch (\Throwable) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

addUploadToContainer()

ILIAS\ResourceStorage\Resource\ResourceBuilder::addUploadToContainer	(	StorableContainerResource	$container,
		UploadResult	$result,
		string	$parent_path_inside_container
	)

Definition at line 670 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\ensurePathInZIP(), ILIAS\ResourceStorage\Resource\ResourceBuilder\extractStream(), ILIAS\ResourceStorage\Resource\AbstractStorableResource\getCurrentRevisionIncludingDraft(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getPath(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

     : bool {
        $revision = $container->getCurrentRevisionIncludingDraft();
        $stream = $this->extractStream($revision);

        // create directory inside ZipArchive
        try {
            $zip = new \ZipArchive();
            $zip->open($stream->getMetadata()['uri']);

            $parent_path_inside_container = $this->ensurePathInZIP($zip, $parent_path_inside_container, false);

            $path_inside_zip = rtrim($parent_path_inside_container, '/') . '/' . $result->getName();

            $return = $zip->addFile(
                $result->getPath(),
                $path_inside_zip
            );
            $zip->close();

            // cleanup revision and flavours
            $this->storage_handler_factory->getHandlerForRevision($revision)->clearFlavours($revision);
            $revision->getInformation()->setSize(filesize($stream->getMetadata()['uri']));
            $this->storeRevision($revision);

            return $return;
        } catch (\Throwable) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

append()

ILIAS\ResourceStorage\Resource\ResourceBuilder::append	(	StorableResource	$resource,
		UploadResult	$result,
		InfoResolver	$info_resolver,
		RevisionStatus	$status
	)

Definition at line 158 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\addRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\buildDraftReplacementRevision(), ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), ILIAS\ResourceStorage\Resource\StorableResource\replaceRevision(), and ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\new().

     : StorableResource {
        if (
            $status !== RevisionStatus::DRAFT
            && $resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            throw new \LogicException(
                'You can not replace a draft revision with a published, you must publish the current revision first'
            );
        }

        $new_revision = $this->revision_repository->blankFromUpload($info_resolver, $resource, $result, $status);

        if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            $clone_revision = $this->buildDraftReplacementRevision($resource, $new_revision, $info_resolver);
            $resource->replaceRevision($clone_revision);
        } else {
            $new_revision = $this->populateRevisionInfo($new_revision, $info_resolver);
            $resource->addRevision($new_revision);
        }

        $resource->setStorageID(
            $resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID()
        );

        return $resource;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

appendFromRevision()

ILIAS\ResourceStorage\Resource\ResourceBuilder::appendFromRevision	(	StorableResource	$resource,
		int	$revision_number
	)

Definition at line 288 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\addRevision(), ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getMaxRevision(), ILIAS\ResourceStorage\Resource\StorableResource\getSpecificRevision(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), and ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

     : StorableResource {
        if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            throw new \LogicException('You can not replace a draft revision, you must publish it first');
        }
        $existing_revision = $resource->getSpecificRevision($revision_number);
        if ($existing_revision instanceof FileRevision) {
            $info_resolver = new ClonedRevisionInfoResolver(
                $resource->getMaxRevision(false) + 1,
                $existing_revision
            );

            $cloned_revision = $this->revision_repository->blankFromClone(
                $info_resolver,
                $resource,
                $existing_revision
            );

            $this->populateRevisionInfo($cloned_revision, $info_resolver);

            $resource->addRevision($cloned_revision);
            $resource->setStorageID(
                $resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID()
            );
            return $resource;
        }
        return $resource;
    }

Here is the call graph for this function:

appendFromStream()

ILIAS\ResourceStorage\Resource\ResourceBuilder::appendFromStream	(	StorableResource	$resource,
		FileStream	$stream,
		InfoResolver	$info_resolver,
		RevisionStatus	$status,
		bool	$keep_original = false
	)

Definition at line 220 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\addRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\buildDraftReplacementRevision(), ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), ILIAS\ResourceStorage\Resource\StorableResource\replaceRevision(), and ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\newFromStream().

     : StorableResource {
        if (
            $status !== RevisionStatus::DRAFT
            && $resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            throw new \LogicException(
                'You can not replace a draft revision with a published, you must publish the current revision first'
            );
        }

        $new_revision = $this->revision_repository->blankFromStream(
            $info_resolver,
            $resource,
            $stream,
            $status,
            $keep_original
        );

        if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            $clone_revision = $this->buildDraftReplacementRevision($resource, $new_revision, $info_resolver);
            $resource->replaceRevision($clone_revision);
        } else {
            $new_revision = $this->populateRevisionInfo($new_revision, $info_resolver);
            $resource->addRevision($new_revision);
        }

        $resource->setStorageID(
            $resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID()
        );

        return $resource;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildDraftReplacementRevision()

ILIAS\ResourceStorage\Resource\ResourceBuilder::buildDraftReplacementRevision ( StorableResource  $resource, Revision  $new_revision, InfoResolver  $info_resolver  )

private

Definition at line 319 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\ResourceBuilder\extractStream(), ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getIdentification(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), ILIAS\ResourceStorage\Revision\BaseRevision\setStatus(), and ILIAS\ResourceStorage\Revision\StreamReplacementRevision\setVersionNumber().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\append(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\appendFromStream().

     : Revision {
        $current_revision = $resource->getCurrentRevisionIncludingDraft();
        $stream_replacement = new StreamReplacementRevision(
            $resource->getIdentification(),
            $this->extractStream($new_revision)
        );
        $stream_replacement = $this->populateRevisionInfo($stream_replacement, $info_resolver);
        $stream_replacement->setVersionNumber($current_revision->getVersionNumber());
        $stream_replacement->setStatus(RevisionStatus::DRAFT);

        return $stream_replacement;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

clone()

ILIAS\ResourceStorage\Resource\ResourceBuilder::clone

(

StorableResource

$resource

)

Clone anexisting resource with all it's revisions, stakeholders and information

Definition at line 380 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisionsIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getStakeholders(), ILIAS\ResourceStorage\Resource\StorableResource\getType(), ILIAS\ResourceStorage\Resource\ResourceBuilder\newBlank(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\store().

                                                     : StorableResource
    {
        $new_resource = $this->newBlank($resource->getType());
        foreach ($resource->getStakeholders() as $stakeholder) {
            $stakeholder = clone $stakeholder;
            $new_resource->addStakeholder($stakeholder);
        }

        foreach ($resource->getAllRevisionsIncludingDraft() as $existing_revision) {
            if (!$existing_revision instanceof FileRevision) {
                continue;
            }
            $info_resolver = new ClonedRevisionInfoResolver(
                $existing_revision->getVersionNumber(),
                $existing_revision
            );

            $existing_revision = $this->stream_access->populateRevision($existing_revision);

            $cloned_revision = new FileStreamRevision(
                $new_resource->getIdentification(),
                $existing_revision->maybeStreamResolver()->getStream(),
                true
            );

            $this->populateRevisionInfo($cloned_revision, $info_resolver);
            $cloned_revision->setVersionNumber($existing_revision->getVersionNumber());

            $new_resource->addRevision($cloned_revision);
        }
        $this->store($new_resource);
        return $new_resource;
    }

Here is the call graph for this function:

createDirectoryInsideContainer()

ILIAS\ResourceStorage\Resource\ResourceBuilder::createDirectoryInsideContainer	(	StorableContainerResource	$container,
		string	$path_inside_container
	)

Definition at line 567 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\ensurePathInZIP(), ILIAS\ResourceStorage\Resource\ResourceBuilder\extractStream(), ILIAS\ResourceStorage\Resource\AbstractStorableResource\getCurrentRevisionIncludingDraft(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

     : bool {
        $revision = $container->getCurrentRevisionIncludingDraft();
        $stream = $this->extractStream($revision);

        // create directory inside ZipArchive
        try {
            $zip = new \ZipArchive();
            $zip->open($stream->getMetadata()['uri']);
            $path_inside_container = $this->ensurePathInZIP($zip, $path_inside_container, false);
            $zip->close();

            // cleanup revision and flavours
            $this->storage_handler_factory->getHandlerForRevision($revision)->clearFlavours($revision);
            $revision->getInformation()->setSize(filesize($stream->getMetadata()['uri']));
            $this->storeRevision($revision);

            return true;
        } catch (\Throwable) {
            return false;
        }
    }

Here is the call graph for this function:

deleteRevision()

ILIAS\ResourceStorage\Resource\ResourceBuilder::deleteRevision ( StorableResource  $resource, Revision  $revision  )

private

Definition at line 739 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Revision\Revision\getInformation(), and ILIAS\ResourceStorage\Resource\StorableResource\removeRevision().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\remove(), ILIAS\ResourceStorage\Resource\ResourceBuilder\removeRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\replaceWithStream(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\replaceWithUpload().

                                                                                   : void
    {
        try {
            $this->storage_handler_factory->getHandlerForResource($resource)->deleteRevision($revision);
        } catch (\Throwable) {
        }

        $this->information_repository->delete($revision->getInformation(), $revision);
        $this->revision_repository->delete($revision);
        $resource->removeRevision($revision);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensurePathInZIP()

ILIAS\ResourceStorage\Resource\ResourceBuilder::ensurePathInZIP ( \ZipArchive  $zip, string  $path, bool  $is_file  )

private

Definition at line 592 of file ResourceBuilder.php.

References $filename, $parts, and $path.

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\addStreamToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\addUploadToContainer(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\createDirectoryInsideContainer().

                                                                                   : string
    {
        if ($path === '' || $path === '/') {
            return $path;
        }

        $filename = '';
        if ($is_file) {
            $filename = basename($path);
            $path = dirname($path);
        }

        // try to determine if a path inside the zip exists with or without a slash at the beginning
        // determine root directory of the path using regex
        $parts = explode('/', $path);
        $root = array_shift($parts);
        $root = $root === '' ? array_shift($parts) : $root;

        // check if the root directory exists without a slash at the beginning
        if ($zip->locateName($root . '/') !== false) {
            $root = $root;
        } elseif ($zip->locateName('/' . $root . '/') !== false) {
            // check if the root directory exists with a slash at the beginning
            $root = '/' . $root;
        } else {
            // if the root directory does not exist, create it
            $zip->addEmptyDir($root);
        }

        $path_inside_container = $root;
        foreach ($parts as $part) {
            $path_inside_container .= '/' . $part;
            if ($zip->locateName($path_inside_container . '/') === false) {
                $zip->addEmptyDir($path_inside_container . '/');
            }
        }

        return rtrim((string) $path_inside_container, '/') . '/' . $filename;
    }

Here is the caller graph for this function:

extractStream()

ILIAS\ResourceStorage\Resource\ResourceBuilder::extractStream

(

Revision

$revision

)

Definition at line 503 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Revision\Revision\getIdentification(), ILIAS\ResourceStorage\Revision\Revision\getStorageID(), and ILIAS\Filesystem\Stream\Streams\ofReattachableResource().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\addStreamToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\addUploadToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\buildDraftReplacementRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\createDirectoryInsideContainer(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\removePathInsideContainer().

                                                     : FileStream
    {
        switch (true) {
            case $revision instanceof FileStreamRevision:
                return Streams::ofReattachableResource($revision->getStream()->detach());
            case $revision instanceof UploadedFileRevision:
                return Streams::ofReattachableResource(fopen($revision->getUpload()->getPath(), 'rb'));
            case $revision instanceof CloneRevision:
                return $revision->getRevisionToClone()->getStream();
            case $revision instanceof FileRevision:
                if ($revision->getStorageID() !== '') {
                    return $this->storage_handler_factory->getHandlerForRevision(
                        $revision
                    )->getStream($revision);
                }

                return $this->storage_handler_factory->getHandlerForResource(
                    $this->get($revision->getIdentification())
                )->getStream($revision);
            default:
                throw new \LogicException('This revision type is not supported');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

has()

ILIAS\ResourceStorage\Resource\ResourceBuilder::has

(

ResourceIdentification

$identification

)

check if a resource exists

Definition at line 339 of file ResourceBuilder.php.

                                                               : bool
    {
        return $this->resource_repository->has($identification);
    }

new()

ILIAS\ResourceStorage\Resource\ResourceBuilder::new	(	UploadResult	$result,
		InfoResolver	$info_resolver,
		ResourceType	$type = ResourceType::SINGLE_FILE
	)

Definition at line 110 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\append().

Referenced by ILIAS\ResourceStorage\Policy\FileNamePolicyTest\testDeniedFileEnding(), ILIAS\ResourceStorage\Resource\ResourceBuilderTest\testNewUpload(), and ILIAS\ResourceStorage\Policy\FileNamePolicyTest\testValidFileEnding().

     : StorableResource {
        $resource = $this->resource_repository->blank(
            $this->primary_storage_handler->getIdentificationGenerator()->getUniqueResourceIdentification(),
            $type
        );

        return $this->append($resource, $result, $info_resolver, RevisionStatus::PUBLISHED);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

newBlank()

ILIAS\ResourceStorage\Resource\ResourceBuilder::newBlank

(

ResourceType

$type = ResourceType::SINGLE_FILE

)

Definition at line 143 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\clone().

                                                                          : StorableResource
    {
        $resource = $this->resource_repository->blank(
            $this->primary_storage_handler->getIdentificationGenerator()->getUniqueResourceIdentification(),
            $type
        );
        $resource->setStorageID($this->primary_storage_handler->getID());

        return $resource;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

newFromStream()

ILIAS\ResourceStorage\Resource\ResourceBuilder::newFromStream	(	FileStream	$stream,
		InfoResolver	$info_resolver,
		bool	$keep_original = false,
		ResourceType	$type = ResourceType::SINGLE_FILE
	)

Definition at line 123 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\appendFromStream().

     : StorableResource {
        $resource = $this->resource_repository->blank(
            $this->primary_storage_handler->getIdentificationGenerator()->getUniqueResourceIdentification(),
            $type
        );

        return $this->appendFromStream(
            $resource,
            $stream,
            $info_resolver,
            RevisionStatus::PUBLISHED,
            $keep_original
        );
    }

Here is the call graph for this function:

populateNakedResourceWithRevisionsAndStakeholders()

ILIAS\ResourceStorage\Resource\ResourceBuilder::populateNakedResourceWithRevisionsAndStakeholders ( StorableResource  $resource )

private

Definition at line 751 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\addStakeholder(), ILIAS\ResourceStorage\Resource\StorableResource\getIdentification(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), and ILIAS\ResourceStorage\Resource\StorableResource\setRevisions().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

                                                                                                  : StorableResource
    {
        $revisions = $this->revision_repository->get($resource);
        $resource->setRevisions($revisions);

        foreach ($revisions->getAll(true) as $i => $revision) {
            $information = $this->information_repository->get($revision);
            $revision->setInformation($information);
            $revision->setStorageID($resource->getStorageID());
            // $revisions->replaceSingleRevision($this->stream_access->populateRevision($revision)); // currently we do not need populating the stream every time, we will do that in consumers only
        }

        foreach ($this->stakeholder_repository->getStakeholders($resource->getIdentification()) as $s) {
            $resource->addStakeholder($s);
        }

        return $resource;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateRevisionInfo()

ILIAS\ResourceStorage\Resource\ResourceBuilder::populateRevisionInfo ( Revision  $revision, InfoResolver  $info_resolver  )

private

Definition at line 770 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getCreationDate(), ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getFileName(), ILIAS\ResourceStorage\Revision\Revision\getInformation(), ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getMimeType(), ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getOwnerId(), ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getRevisionTitle(), ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getSize(), ILIAS\ResourceStorage\Resource\InfoResolver\InfoResolver\getSuffix(), ILIAS\ResourceStorage\Revision\Revision\setInformation(), and ILIAS\ResourceStorage\Revision\Revision\setTitle().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\append(), ILIAS\ResourceStorage\Resource\ResourceBuilder\appendFromRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\appendFromStream(), ILIAS\ResourceStorage\Resource\ResourceBuilder\buildDraftReplacementRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\clone(), ILIAS\ResourceStorage\Resource\ResourceBuilder\replaceWithStream(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\replaceWithUpload().

                                                                                          : Revision
    {
        $info = $revision->getInformation();

        $info->setTitle($this->secure($info_resolver->getFileName()));
        $info->setMimeType($info_resolver->getMimeType());
        $info->setSuffix($this->secure($info_resolver->getSuffix()));
        $info->setSize($info_resolver->getSize());
        $info->setCreationDate($info_resolver->getCreationDate());

        $revision->setInformation($info);
        $revision->setTitle($this->secure($info_resolver->getRevisionTitle()));
        $revision->setOwnerId($info_resolver->getOwnerId());

        return $revision;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

publish()

ILIAS\ResourceStorage\Resource\ResourceBuilder::publish

(

StorableResource

$resource

)

Definition at line 481 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\store().

                                                       : bool
    {
        $revision = $resource->getCurrentRevisionIncludingDraft();
        if ($revision->getStatus() === RevisionStatus::PUBLISHED) {
            return false;
        }
        $revision->setStatus(RevisionStatus::PUBLISHED);
        $this->store($resource);
        return true;
    }

Here is the call graph for this function:

remove()

ILIAS\ResourceStorage\Resource\ResourceBuilder::remove	(	StorableResource	$resource,
		?ResourceStakeholder	$stakeholder = null
	)

Remove a complete revision.

if there are other Stakeholder, only your stakeholder gets removed

Parameters

ResourceStakeholder | null

$stakeholder

Returns

bool whether ResourceStakeholders handled this successful

Definition at line 532 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\deleteRevision(), ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisionsIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getIdentification(), ILIAS\ResourceStorage\Resource\StorableResource\getStakeholders(), and ILIAS\ResourceStorage\Resource\StorableResource\removeStakeholder().

                                                                                                : bool
    {
        $sucessful = true;
        if ($stakeholder instanceof ResourceStakeholder) {
            $this->stakeholder_repository->deregister($resource->getIdentification(), $stakeholder);
            $sucessful = $stakeholder->resourceHasBeenDeleted($resource->getIdentification());
            $resource->removeStakeholder($stakeholder);
            if ($resource->getStakeholders() !== []) {
                return $sucessful;
            }
        }
        foreach ($resource->getStakeholders() as $s) {
            $sucessful = $s->resourceHasBeenDeleted($resource->getIdentification()) && $sucessful;
        }

        foreach ($resource->getAllRevisionsIncludingDraft() as $revision) {
            $this->deleteRevision($resource, $revision);
        }

        $this->storage_handler_factory->getHandlerForResource($resource)->deleteResource($resource);
        $this->resource_repository->delete($resource);

        return $sucessful;
    }

Here is the call graph for this function:

removePathInsideContainer()

ILIAS\ResourceStorage\Resource\ResourceBuilder::removePathInsideContainer	(	StorableContainerResource	$container,
		string	$path_inside_container
	)

Definition at line 632 of file ResourceBuilder.php.

References $path, ILIAS\ResourceStorage\Resource\ResourceBuilder\extractStream(), ILIAS\ResourceStorage\Resource\AbstractStorableResource\getCurrentRevisionIncludingDraft(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

     : bool {
        $revision = $container->getCurrentRevisionIncludingDraft();
        $stream = $this->extractStream($revision);

        // create directory inside ZipArchive
        try {
            $zip = new \ZipArchive();
            $zip->open($stream->getMetadata()['uri']);

            $return = $zip->deleteName($path_inside_container);
            // remove all files inside the directory
            for ($i = 0; $i < $zip->numFiles; $i++) {
                $path = $zip->getNameIndex($i);
                if ($path === false) {
                    continue;
                }
                if (str_starts_with($path, $path_inside_container)) {
                    $zip->deleteIndex($i);
                }
            }

            $zip->close();

            // cleanup revision and flavours
            $this->storage_handler_factory->getHandlerForRevision($revision)->clearFlavours($revision);
            $revision->getInformation()->setSize(filesize($stream->getMetadata()['uri']));
            $this->storeRevision($revision);

            return $return;
        } catch (\Throwable) {
            $this->storage_handler_factory->getHandlerForRevision($revision)->clearFlavours($revision);
            return false;
        }
    }

Here is the call graph for this function:

removeRevision()

ILIAS\ResourceStorage\Resource\ResourceBuilder::removeRevision	(	StorableResource	$resource,
		int	$revision_number
	)

Definition at line 557 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\ResourceBuilder\deleteRevision(), ILIAS\ResourceStorage\Resource\StorableResource\getSpecificRevision(), null, and ILIAS\ResourceStorage\Resource\ResourceBuilder\store().

                                                                                    : void
    {
        $reveision_to_delete = $resource->getSpecificRevision($revision_number);
        if ($reveision_to_delete !== null) {
            $this->deleteRevision($resource, $reveision_to_delete);
        }
        $this->store($resource);
    }

Here is the call graph for this function:

replaceWithStream()

ILIAS\ResourceStorage\Resource\ResourceBuilder::replaceWithStream	(	StorableResource	$resource,
		FileStream	$stream,
		InfoResolver	$info_resolver,
		bool	$keep_original = false
	)

Definition at line 258 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\addRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\deleteRevision(), ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisionsIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), and ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

     : StorableResource {
        if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            throw new \LogicException('You can not replace a draft revision, you must publish it first');
        }
        $revision = $this->revision_repository->blankFromStream(
            $info_resolver,
            $resource,
            $stream,
            RevisionStatus::PUBLISHED,
            $keep_original
        );
        $revision = $this->populateRevisionInfo($revision, $info_resolver);

        foreach ($resource->getAllRevisionsIncludingDraft() as $existing_revision) {
            $this->deleteRevision($resource, $existing_revision);
        }

        $resource->addRevision($revision);
        $resource->setStorageID(
            $resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID()
        );

        return $resource;
    }

Here is the call graph for this function:

replaceWithUpload()

ILIAS\ResourceStorage\Resource\ResourceBuilder::replaceWithUpload	(	StorableResource	$resource,
		UploadResult	$result,
		InfoResolver	$info_resolver
	)

Definition at line 192 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Resource\StorableResource\addRevision(), ILIAS\ResourceStorage\Resource\ResourceBuilder\deleteRevision(), ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisionsIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), ILIAS\ResourceStorage\Resource\ResourceBuilder\populateRevisionInfo(), and ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

     : StorableResource {
        if ($resource->getCurrentRevisionIncludingDraft()->getStatus() === RevisionStatus::DRAFT) {
            throw new \LogicException('You can not replace a draft revision, you must publish it first');
        }
        $revision = $this->revision_repository->blankFromUpload(
            $info_resolver,
            $resource,
            $result,
            RevisionStatus::PUBLISHED
        );
        $revision = $this->populateRevisionInfo($revision, $info_resolver);

        foreach ($resource->getAllRevisionsIncludingDraft() as $existing_revision) {
            $this->deleteRevision($resource, $existing_revision);
        }

        $resource->addRevision($revision);
        $resource->setStorageID(
            $resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID()
        );

        return $resource;
    }

Here is the call graph for this function:

store()

ILIAS\ResourceStorage\Resource\ResourceBuilder::store

(

StorableResource

$resource

)

after you have modified a resource, you can store it here

Exceptions

FileNamePolicyException

Definition at line 348 of file ResourceBuilder.php.

References $r, ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisionsIncludingDraft(), ILIAS\ResourceStorage\Resource\StorableResource\getIdentification(), ILIAS\ResourceStorage\Resource\StorableResource\getStakeholders(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\storeRevision().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\clone(), ILIAS\ResourceStorage\Resource\ResourceBuilder\publish(), ILIAS\ResourceStorage\Resource\ResourceBuilder\removeRevision(), ILIAS\ResourceStorage\Policy\FileNamePolicyTest\testDeniedFileEnding(), ILIAS\ResourceStorage\Policy\FileNamePolicyTest\testValidFileEnding(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\unpublish().

                                                     : void
    {
        foreach ($resource->getAllRevisionsIncludingDraft() as $revision) {
            $this->file_name_policy->check($revision->getInformation()->getSuffix());
        }

        $r = $this->lock_handler->lockTables(
            array_merge(
                $this->resource_repository->getNamesForLocking(),
                $this->revision_repository->getNamesForLocking(),
                $this->information_repository->getNamesForLocking(),
                $this->stakeholder_repository->getNamesForLocking()
            ),
            function () use ($resource): void {
                $this->resource_repository->store($resource);

                foreach ($resource->getAllRevisionsIncludingDraft() as $revision) {
                    $this->storeRevision($revision, $resource);
                }

                foreach ($resource->getStakeholders() as $stakeholder) {
                    $this->stakeholder_repository->register($resource->getIdentification(), $stakeholder);
                }
            }
        );

        $r->runAndUnlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeRevision()

ILIAS\ResourceStorage\Resource\ResourceBuilder::storeRevision	(	Revision	$revision,
		?StorableResource	$resource = null
	)

Store one Revision

Exceptions

FileNamePolicyException

Definition at line 418 of file ResourceBuilder.php.

References $DIC, InitResourceStorage\D_MIGRATOR, ILIAS\ResourceStorage\Revision\Revision\getIdentification(), ILIAS\ResourceStorage\Revision\Revision\getInformation(), ILIAS\ResourceStorage\Revision\Revision\getOwnerId(), ILIAS\ResourceStorage\Revision\Revision\getStatus(), ILIAS\ResourceStorage\Revision\Revision\getStorageID(), ILIAS\ResourceStorage\Revision\Revision\getTitle(), ILIAS\ResourceStorage\Revision\Revision\getVersionNumber(), null, ILIAS\ResourceStorage\Resource\ResourceBuilder\populateNakedResourceWithRevisionsAndStakeholders(), and ILIAS\ResourceStorage\Revision\FileRevision\setVersionNumber().

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\addStreamToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\addUploadToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\createDirectoryInsideContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\removePathInsideContainer(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\store().

                                                                                         : void
    {
        $storage_handler = empty($revision->getStorageID())
            ? $this->primary_storage_handler
            : $this->storage_handler_factory->getHandlerForRevision($revision);

        if ($revision instanceof UploadedFileRevision) {
            // check policies
            $this->file_name_policy->check($revision->getInformation()->getSuffix());
            $storage_handler->storeUpload($revision);
        }
        if ($revision instanceof FileStreamRevision) {
            $storage_handler->storeStream($revision);
        }
        if ($revision instanceof CloneRevision) {
            $storage_handler->cloneRevision($revision);
        }
        if ($revision instanceof StreamReplacementRevision) {
            $storage_handler->streamReplacement($revision);
        }
        $this->revision_repository->store($revision);
        $this->information_repository->store($revision->getInformation(), $revision);

        // we replace the revision with the populated one
        if ($resource !== null) {
            $replace_revision = new FileRevision($revision->getIdentification());
            $replace_revision->setVersionNumber($revision->getVersionNumber());
            $replace_revision->setOwnerId($revision->getOwnerId());
            $replace_revision->setTitle($revision->getTitle());
            $replace_revision->setStatus($revision->getStatus());
            $replace_revision->setInformation($revision->getInformation());
            $replace_revision->setStorageID($revision->getStorageID());

            $resource->replaceRevision($replace_revision);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unpublish()

ILIAS\ResourceStorage\Resource\ResourceBuilder::unpublish

(

StorableResource

$resource

)

Definition at line 492 of file ResourceBuilder.php.

References ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\ResourceStorage\Resource\StorableResource\getCurrentRevisionIncludingDraft(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\store().

                                                         : bool
    {
        $revision = $resource->getCurrentRevisionIncludingDraft();
        if ($revision->getStatus() === RevisionStatus::DRAFT) {
            return false;
        }
        $revision->setStatus(RevisionStatus::DRAFT);
        $this->store($resource);
        return true;
    }

Here is the call graph for this function:

Field Documentation

$auto_migrate

bool ILIAS\ResourceStorage\Resource\ResourceBuilder::$auto_migrate = true

private

Definition at line 83 of file ResourceBuilder.php.

$information_repository

InformationRepository ILIAS\ResourceStorage\Resource\ResourceBuilder::$information_repository

private

Definition at line 64 of file ResourceBuilder.php.

$primary_storage_handler

StorageHandler ILIAS\ResourceStorage\Resource\ResourceBuilder::$primary_storage_handler

protected

Definition at line 82 of file ResourceBuilder.php.

$resource_cache

array ILIAS\ResourceStorage\Resource\ResourceBuilder::$resource_cache = []

protected

Definition at line 81 of file ResourceBuilder.php.

$resource_repository

ResourceRepository ILIAS\ResourceStorage\Resource\ResourceBuilder::$resource_repository

private

Definition at line 68 of file ResourceBuilder.php.

$revision_repository

RevisionRepository ILIAS\ResourceStorage\Resource\ResourceBuilder::$revision_repository

private

Definition at line 72 of file ResourceBuilder.php.

$stakeholder_repository

StakeholderRepository ILIAS\ResourceStorage\Resource\ResourceBuilder::$stakeholder_repository

private

Definition at line 76 of file ResourceBuilder.php.

---

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

• components/ILIAS/ResourceStorage/src/Resource/ResourceBuilder.php