ILIAS\ResourceStorage\Flavour\Flavour Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Flavour\Flavour:

Collaboration diagram for ILIAS\ResourceStorage\Flavour\Flavour:

Public Member Functions
	__construct (FlavourDefinition $definition, ResourceIdentification $resource_id, int $revision)
	getPersistingName ()
	Flavours are stored in the file system by the StroageHandler. More...
	getName ()
	getResourceId ()
	withStreamResolver (int $index, ?StreamResolver $stream_resolver=null)
	maybeStreamResolver (int $index)
	getStreamResolvers ()
	getDefinition ()
	getRevision ()

Private Attributes
array	$streams = []
array	$stream_resolvers = []
FlavourDefinition	$definition
ResourceIdentification	$resource_id
int	$revision

Detailed Description

Author

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

Definition at line 31 of file Flavour.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Flavour\Flavour::__construct	(	FlavourDefinition	$definition,
		ResourceIdentification	$resource_id,
		int	$revision
	)

Definition at line 39 of file Flavour.php.

References ILIAS\ResourceStorage\Flavour\Flavour\$definition, ILIAS\ResourceStorage\Flavour\Flavour\$resource_id, and ILIAS\ResourceStorage\Flavour\Flavour\$revision.

    {
        $this->definition = $definition;
        $this->resource_id = $resource_id;
        $this->revision = $revision;
    }

Member Function Documentation

getDefinition()

ILIAS\ResourceStorage\Flavour\Flavour::getDefinition

(

)

Definition at line 86 of file Flavour.php.

References ILIAS\ResourceStorage\Flavour\Flavour\$definition.

Referenced by ILIAS\ResourceStorage\Resource\Repository\FlavourDBRepository\store().

                                   : FlavourDefinition
    {
        return $this->definition;
    }

Here is the caller graph for this function:

getName()

ILIAS\ResourceStorage\Flavour\Flavour::getName

(

)

Definition at line 56 of file Flavour.php.

Referenced by ILIAS\ResourceStorage\Flavour\Flavour\getPersistingName().

                             : string
    {
        return $this->definition->getInternalName() . $this->definition->getVariantName();
    }

Here is the caller graph for this function:

getPersistingName()

ILIAS\ResourceStorage\Flavour\Flavour::getPersistingName

(

)

Flavours are stored in the file system by the StroageHandler.

Thereby you use this hash. By crc32 these hashes have always a length of 8 characters. Possible collisions are accepted, because they are very unlikely.

Definition at line 51 of file Flavour.php.

References ILIAS\ResourceStorage\Flavour\Flavour\getName().

Referenced by ILIAS\ResourceStorage\Events\FlavourData\__construct(), and ILIAS\ResourceStorage\StorageHandler\FileSystemBased\AbstractFileSystemStorageHandler\getFlavourPath().

                                       : string
    {
        return hash('crc32', $this->getName());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getResourceId()

ILIAS\ResourceStorage\Flavour\Flavour::getResourceId

(

)

Definition at line 61 of file Flavour.php.

References ILIAS\ResourceStorage\Flavour\Flavour\$resource_id.

Referenced by ILIAS\ResourceStorage\Flavour\FlavourBuilder\getCurrentRevision(), ILIAS\ResourceStorage\Flavour\FlavourBuilder\populateFlavourWithExistingStreams(), and ILIAS\ResourceStorage\Resource\Repository\FlavourDBRepository\store().

                                   : ResourceIdentification
    {
        return $this->resource_id;
    }

Here is the caller graph for this function:

getRevision()

ILIAS\ResourceStorage\Flavour\Flavour::getRevision

(

)

Definition at line 91 of file Flavour.php.

References ILIAS\ResourceStorage\Flavour\Flavour\$revision.

Referenced by ILIAS\ResourceStorage\Resource\Repository\FlavourDBRepository\store().

                                 : int
    {
        return $this->revision;
    }

Here is the caller graph for this function:

getStreamResolvers()

ILIAS\ResourceStorage\Flavour\Flavour::getStreamResolvers

(

)

Returns

StreamResolver[]

Definition at line 81 of file Flavour.php.

References ILIAS\ResourceStorage\Flavour\Flavour\$stream_resolvers.

Referenced by ilSecureTokenSrcBuilder\getFlavourURLs(), and ILIAS\ResourceStorage\Consumer\InlineSrcBuilder\getFlavourURLs().

                                        : array
    {
        return $this->stream_resolvers;
    }

Here is the caller graph for this function:

maybeStreamResolver()

ILIAS\ResourceStorage\Flavour\Flavour::maybeStreamResolver

(

int

$index

)

Definition at line 73 of file Flavour.php.

                                                   : ?StreamResolver
    {
        return $this->stream_resolvers[$index] ?? null;
    }

withStreamResolver()

ILIAS\ResourceStorage\Flavour\Flavour::withStreamResolver	(	int	$index,
		?StreamResolver	$stream_resolver = null
	)

Definition at line 66 of file Flavour.php.

Referenced by ILIAS\ResourceStorage\Consumer\StreamAccess\StreamAccess\populateFlavour().

                                                                                           : Flavour
    {
        $this->stream_resolvers[$index] = $stream_resolver;

        return $this;
    }

Here is the caller graph for this function:

Field Documentation

$definition

FlavourDefinition ILIAS\ResourceStorage\Flavour\Flavour::$definition

private

Definition at line 35 of file Flavour.php.

Referenced by ILIAS\ResourceStorage\Flavour\Flavour\__construct(), and ILIAS\ResourceStorage\Flavour\Flavour\getDefinition().

$resource_id

ResourceIdentification ILIAS\ResourceStorage\Flavour\Flavour::$resource_id

private

Definition at line 36 of file Flavour.php.

Referenced by ILIAS\ResourceStorage\Flavour\Flavour\__construct(), and ILIAS\ResourceStorage\Flavour\Flavour\getResourceId().

$revision

int ILIAS\ResourceStorage\Flavour\Flavour::$revision

private

Definition at line 37 of file Flavour.php.

Referenced by ILIAS\ResourceStorage\Flavour\Flavour\__construct(), and ILIAS\ResourceStorage\Flavour\Flavour\getRevision().

$stream_resolvers

array ILIAS\ResourceStorage\Flavour\Flavour::$stream_resolvers = []

private

Definition at line 34 of file Flavour.php.

Referenced by ILIAS\ResourceStorage\Flavour\Flavour\getStreamResolvers().

$streams

array ILIAS\ResourceStorage\Flavour\Flavour::$streams = []

private

Definition at line 33 of file Flavour.php.

---

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

• src/ResourceStorage/Flavour/Flavour.php