Collaboration diagram for ILIAS\ResourceStorage\Resource\ResourceBuilder:

Public Member Functions
	__construct (StorageHandlerFactory $storage_handler_factory, RevisionRepository $revision_repository, ResourceRepository $resource_repository, InformationRepository $information_repository, StakeholderRepository $stakeholder_repository, LockHandler $lock_handler, FileNamePolicy $file_name_policy=null)
	ResourceBuilder constructor. More...

	new (UploadResult $result, InfoResolver $info_resolver)
	@inheritDoc More...

	newFromStream (FileStream $stream, InfoResolver $info_resolver, bool $keep_original=false)

	newBlank ()

	append (StorableResource $resource, UploadResult $result, InfoResolver $info_resolver)

	replaceWithUpload (StorableResource $resource, UploadResult $result, InfoResolver $info_resolver)
	@inheritDoc More...

	appendFromStream (StorableResource $resource, FileStream $stream, InfoResolver $info_resolver, 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)

	store (StorableResource $resource)

	clone (StorableResource $resource)

	storeRevision (Revision $revision)
	@description Store one Revision More...

	get (ResourceIdentification $identification)

	remove (StorableResource $resource, ResourceStakeholder $stakeholder=null)
	@description Reve a complete revision. More...

	removeRevision (StorableResource $resource, int $revision_number)

Protected Attributes
	$resource_cache = []

	$file_name_policy

	$primary_storage_handler

Private Member Functions
	deleteRevision (StorableResource $resource, Revision $revision)

	populateNakedResourceWithRevisionsAndStakeholders (StorableResource $resource)

	populateRevisionInfo (Revision $revision, InfoResolver $info_resolver)

Private Attributes
	$information_repository

	$resource_repository

	$revision_repository

	$storage_handler_factory

	$stakeholder_repository

	$lock_handler

Detailed Description

Class ResourceBuilder.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 34 of file ResourceBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ResourceStorage\Resource\ResourceBuilder::__construct	(	StorageHandlerFactory	$storage_handler_factory,
		RevisionRepository	$revision_repository,
		ResourceRepository	$resource_repository,
		InformationRepository	$information_repository,
		StakeholderRepository	$stakeholder_repository,
		LockHandler	$lock_handler,
		FileNamePolicy	$file_name_policy = `null`
	)

ResourceBuilder constructor.

Parameters

StorageHandlerFactory	$storage_handler_factory
RevisionRepository	$revision_repository
ResourceRepository	$resource_repository
InformationRepository	$information_repository
StakeholderRepository	$stakeholder_repository
LockHandler	$lock_handler
FileNamePolicy \| null	$file_name_policy

Definition at line 84 of file ResourceBuilder.php.

      {
        $this->storage_handler_factory = $storage_handler_factory;
        $this->primary_storage_handler = $storage_handler_factory->getPrimary();
        $this->revision_repository = $revision_repository;
        $this->resource_repository = $resource_repository;
        $this->information_repository = $information_repository;
        $this->stakeholder_repository = $stakeholder_repository;
        $this->lock_handler = $lock_handler;
        $this->file_name_policy = $file_name_policy ?? new NoneFileNamePolicy();
    }

References ILIAS\ResourceStorage\Resource\ResourceBuilder\$file_name_policy, ILIAS\ResourceStorage\Resource\ResourceBuilder\$information_repository, ILIAS\ResourceStorage\Resource\ResourceBuilder\$lock_handler, ILIAS\ResourceStorage\Resource\ResourceBuilder\$resource_repository, ILIAS\ResourceStorage\Resource\ResourceBuilder\$revision_repository, ILIAS\ResourceStorage\Resource\ResourceBuilder\$stakeholder_repository, and ILIAS\ResourceStorage\Resource\ResourceBuilder\$storage_handler_factory.

Member Function Documentation

◆ append()

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

Definition at line 140 of file ResourceBuilder.php.

      : StorableResource {
        $revision = $this->revision_repository->blankFromUpload($info_resolver, $resource, $result);
        $revision = $this->populateRevisionInfo($revision, $info_resolver);
 
        $resource->addRevision($revision);
        $resource->setStorageID($resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID());
 
        return $resource;
    }

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

Here is the caller graph for this function:

◆ appendFromRevision()

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

Definition at line 209 of file ResourceBuilder.php.

      : StorableResource {
        $existing_revision = $resource->getSpecificRevision($revision_number);
        if ($existing_revision instanceof FileRevision) {
            $info_resolver = new ClonedRevisionInfoResolver(
                $resource->getMaxRevision() + 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;
 
    }

References ILIAS\ResourceStorage\Resource\StorableResource\addRevision(), ILIAS\ResourceStorage\Resource\StorableResource\getMaxRevision(), ILIAS\ResourceStorage\Resource\StorableResource\getStorageID(), and ILIAS\ResourceStorage\Resource\StorableResource\setStorageID().

Here is the call graph for this function:

◆ appendFromStream()

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

Definition at line 175 of file ResourceBuilder.php.

      : StorableResource {
        $revision = $this->revision_repository->blankFromStream($info_resolver, $resource, $stream, $keep_original);
        $revision = $this->populateRevisionInfo($revision, $info_resolver);
 
        $resource->addRevision($revision);
        $resource->setStorageID($resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID());
 
        return $resource;
    }

◆ clone()

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

Parameters

StorableResource $resource

Returns: StorableResource @description Clone anexisting resource with all it's revisions, stakeholders and information

Definition at line 283 of file ResourceBuilder.php.

                                                      : StorableResource
    {
        $new_resource = $this->newBlank();
        foreach ($resource->getStakeholders() as $stakeholder) {
            $stakeholder = clone $stakeholder;
            $new_resource->addStakeholder($stakeholder);
        }
 
        foreach ($resource->getAllRevisions() as $existing_revision) {
            if (!$existing_revision instanceof FileRevision) {
                continue;
            }
            $info_resolver = new ClonedRevisionInfoResolver(
                $existing_revision->getVersionNumber(),
                $existing_revision
            );
 
            $stream = new FileStreamConsumer($resource, $this->storage_handler_factory->getHandlerForResource($resource));
            $stream->setRevisionNumber($existing_revision->getVersionNumber());
 
            $cloned_revision = new FileStreamRevision($new_resource->getIdentification(), $stream->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;
 
    }

References ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisions(), and ILIAS\ResourceStorage\Resource\StorableResource\getStakeholders().

Here is the call graph for this function:

◆ deleteRevision()

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

private

Definition at line 394 of file ResourceBuilder.php.

                                                                                    : void
    {
        try {
            $this->storage_handler_factory->getHandlerForResource($resource)->deleteRevision($revision);
        } catch (\Throwable $t) {
        }
 
        $this->information_repository->delete($revision->getInformation(), $revision);
        $this->revision_repository->delete($revision);
        $resource->removeRevision($revision);
    }

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

Here is the call graph for this function:

◆ get()

ILIAS\ResourceStorage\Resource\ResourceBuilder::get ( ResourceIdentification $identification )

Parameters

ResourceIdentification $identification

Returns: StorableResource

Exceptions

ResourceNotFoundException @description Get a Resource out of a Identification

Definition at line 342 of file ResourceBuilder.php.

                                                                : StorableResource
    {
        if (isset($this->resource_cache[$identification->serialize()])) {
            return $this->resource_cache[$identification->serialize()];
        }
        $resource = $this->resource_repository->get($identification);
 
        $this->resource_cache[$identification->serialize()] = $this->populateNakedResourceWithRevisionsAndStakeholders($resource);
 
        return $this->resource_cache[$identification->serialize()];
    }

◆ has()

ILIAS\ResourceStorage\Resource\ResourceBuilder::has ( ResourceIdentification $identification )

Parameters

ResourceIdentification $identification

Returns: bool @description check if a resource exists

Definition at line 241 of file ResourceBuilder.php.

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

◆ new()

ILIAS\ResourceStorage\Resource\ResourceBuilder::new	(	UploadResult	$result,
		InfoResolver	$info_resolver
	)

@inheritDoc

Definition at line 109 of file ResourceBuilder.php.

      : StorableResource {
        $resource = $this->resource_repository->blank($this->primary_storage_handler->getIdentificationGenerator()->getUniqueResourceIdentification());
 
        return $this->append($resource, $result, $info_resolver);
    }

References $result, and ILIAS\ResourceStorage\Resource\ResourceBuilder\append().

Here is the call graph for this function:

◆ newBlank()

ILIAS\ResourceStorage\Resource\ResourceBuilder::newBlank ( )

Definition at line 128 of file ResourceBuilder.php.

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

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

Here is the call graph for this function:

◆ newFromStream()

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

Definition at line 118 of file ResourceBuilder.php.

      : StorableResource {
        $resource = $this->resource_repository->blank($this->primary_storage_handler->getIdentificationGenerator()->getUniqueResourceIdentification());
 
        return $this->appendFromStream($resource, $stream, $info_resolver, $keep_original);
    }

◆ populateNakedResourceWithRevisionsAndStakeholders()

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

private

Parameters

StorableResource $resource

Returns: StorableResource

Definition at line 423 of file ResourceBuilder.php.

                                                                                                   : StorableResource
    {
        $revisions = $this->revision_repository->get($resource);
        $resource->setRevisions($revisions);
 
        foreach ($resource->getAllRevisions() as $revision) {
            $information = $this->information_repository->get($revision);
            $revision->setInformation($information);
        }
 
        foreach ($this->stakeholder_repository->getStakeholders($resource->getIdentification()) as $s) {
            $resource->addStakeholder($s);
        }
 
        return $resource;
    }

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

Here is the call graph for this function:

◆ populateRevisionInfo()

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

private

Definition at line 440 of file ResourceBuilder.php.

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

◆ remove()

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

@description Reve a complete revision.

if there are other Stakeholder, only your stakeholder gets removed

Parameters

StorableResource	$resource
ResourceStakeholder \| null	$stakeholder

Returns: bool whether ResourceStakeholders handled this successful

Definition at line 360 of file ResourceBuilder.php.

                                                                                                : bool
    {
        $sucessful = true;
        if ($stakeholder instanceof ResourceStakeholder) {
            $this->stakeholder_repository->deregister($resource->getIdentification(), $stakeholder);
            $sucessful = $sucessful && $stakeholder->resourceHasBeenDeleted($resource->getIdentification());
            $resource->removeStakeholder($stakeholder);
            if (count($resource->getStakeholders()) > 0) {
                return $sucessful;
            }
        }
        foreach ($resource->getStakeholders() as $s) {
            $sucessful = $sucessful && $s->resourceHasBeenDeleted($resource->getIdentification());
        }
 
        foreach ($resource->getAllRevisions() as $revision) {
            $this->deleteRevision($resource, $revision);
        }
 
        $this->storage_handler_factory->getHandlerForResource($resource)->deleteResource($resource);
        $this->resource_repository->delete($resource);
 
        return $sucessful;
    }

References ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisions(), ILIAS\ResourceStorage\Resource\StorableResource\getIdentification(), ILIAS\ResourceStorage\Resource\StorableResource\getStakeholders(), and ILIAS\ResourceStorage\Resource\StorableResource\removeStakeholder().

Here is the call graph for this function:

◆ removeRevision()

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

Definition at line 385 of file ResourceBuilder.php.

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

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

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 190 of file ResourceBuilder.php.

      : StorableResource {
        $revision = $this->revision_repository->blankFromStream($info_resolver, $resource, $stream, $keep_original);
        $revision = $this->populateRevisionInfo($revision, $info_resolver);
 
        foreach ($resource->getAllRevisions() as $existing_revision) {
            $this->deleteRevision($resource, $existing_revision);
        }
 
        $resource->addRevision($revision);
        $resource->setStorageID($resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID());
 
        return $resource;
    }

◆ replaceWithUpload()

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

@inheritDoc

Definition at line 157 of file ResourceBuilder.php.

      : StorableResource {
        $revision = $this->revision_repository->blankFromUpload($info_resolver, $resource, $result);
        $revision = $this->populateRevisionInfo($revision, $info_resolver);
 
        foreach ($resource->getAllRevisions() as $existing_revision) {
            $this->deleteRevision($resource, $existing_revision);
        }
 
        $resource->addRevision($revision);
        $resource->setStorageID($resource->getStorageID() === '' ? $this->primary_storage_handler->getID() : $resource->getStorageID());
 
        return $resource;
    }

◆ store()

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

Parameters

StorableResource $resource @description after you have modified a resource, you can store it here

Exceptions

ILIAS\ResourceStorage\Policy\FileNamePolicyException

Definition at line 251 of file ResourceBuilder.php.

                                                      : void
    {
        foreach ($resource->getAllRevisions() 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) {
            $this->resource_repository->store($resource);
 
            foreach ($resource->getAllRevisions() as $revision) {
                $this->storeRevision($revision);
            }
 
            foreach ($resource->getStakeholders() as $stakeholder) {
                $this->stakeholder_repository->register($resource->getIdentification(), $stakeholder);
            }
        });
 
        $r->runAndUnlock();
    }

References ILIAS\ResourceStorage\Resource\StorableResource\getAllRevisions(), and ILIAS\ResourceStorage\Resource\StorableResource\getStakeholders().

Here is the call graph for this function:

◆ storeRevision()

ILIAS\ResourceStorage\Resource\ResourceBuilder::storeRevision ( Revision $revision )

@description Store one Revision

Parameters

Revision $revision

Exceptions

ILIAS\ResourceStorage\Policy\FileNamePolicyException

Definition at line 319 of file ResourceBuilder.php.

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

References ILIAS\ResourceStorage\Revision\Revision\getInformation().

Here is the call graph for this function:

Field Documentation

◆ $file_name_policy

ILIAS\ResourceStorage\Resource\ResourceBuilder::$file_name_policy

protected

Definition at line 68 of file ResourceBuilder.php.

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

◆ $information_repository

ILIAS\ResourceStorage\Resource\ResourceBuilder::$information_repository

private

Definition at line 40 of file ResourceBuilder.php.

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

◆ $lock_handler

ILIAS\ResourceStorage\Resource\ResourceBuilder::$lock_handler

private

Definition at line 60 of file ResourceBuilder.php.

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

◆ $primary_storage_handler

ILIAS\ResourceStorage\Resource\ResourceBuilder::$primary_storage_handler

protected

Definition at line 72 of file ResourceBuilder.php.

◆ $resource_cache

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

protected

Definition at line 64 of file ResourceBuilder.php.

◆ $resource_repository

ILIAS\ResourceStorage\Resource\ResourceBuilder::$resource_repository

private

Definition at line 44 of file ResourceBuilder.php.

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

◆ $revision_repository

ILIAS\ResourceStorage\Resource\ResourceBuilder::$revision_repository

private

Definition at line 48 of file ResourceBuilder.php.

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

◆ $stakeholder_repository

ILIAS\ResourceStorage\Resource\ResourceBuilder::$stakeholder_repository

private

Definition at line 56 of file ResourceBuilder.php.

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

◆ $storage_handler_factory

ILIAS\ResourceStorage\Resource\ResourceBuilder::$storage_handler_factory

private

Definition at line 52 of file ResourceBuilder.php.

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

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

src/ResourceStorage/Resource/ResourceBuilder.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ append()

◆ appendFromRevision()

◆ appendFromStream()

◆ clone()

◆ deleteRevision()

◆ get()

◆ has()

◆ new()

◆ newBlank()

◆ newFromStream()

◆ populateNakedResourceWithRevisionsAndStakeholders()

◆ populateRevisionInfo()

◆ remove()

◆ removeRevision()

◆ replaceWithStream()

◆ replaceWithUpload()

◆ store()

◆ storeRevision()

Field Documentation

◆ $file_name_policy

◆ $information_repository

◆ $lock_handler

◆ $primary_storage_handler

◆ $resource_cache

◆ $resource_repository

◆ $revision_repository

◆ $stakeholder_repository

◆ $storage_handler_factory