class AssetManipulationList

Provides a mechanism for determining the effective visibility of a set of assets (identified by filename and hash), given their membership to objects of varying visibility.

The effective visibility of assets is based on three rules: - If an asset is attached to any public record, that asset is public. - If an asset is not attached to any public record, but is attached to a protected record, that asset is protected. - If an asset is attached to a record being deleted, but not any existing public or protected record, then that asset is marked for deletion.

Variants are ignored for the purpose of determining visibility

Constants

STATE_PUBLIC

STATE_PROTECTED

STATE_DELETED

Methods

bool
addAsset(array $asset, string $state)

Add asset with the given state

bool
addPublicAsset(array $asset)

Mark a file as public

bool
addProtectedAsset(array $asset)

Record an asset as protected

bool
addDeletedAsset(array $asset)

Record an asset as deleted

array
getPublicAssets()

Get all public assets

array
getProtectedAssets()

Get protected assets

array
getDeletedAssets()

Get deleted assets

Details

at line 66
bool addAsset(array $asset, string $state)

Add asset with the given state

Parameters

array $asset Asset tuple
string $state One of the STATE_* const vars

Return Value

bool True if the asset was added to the set matching the given state

at line 86
bool addPublicAsset(array $asset)

Mark a file as public

Parameters

array $asset Asset tuple

Return Value

bool True if the asset was added to the public set

at line 107
bool addProtectedAsset(array $asset)

Record an asset as protected

Parameters

array $asset Asset tuple

Return Value

bool True if the asset was added to the protected set

at line 130
bool addDeletedAsset(array $asset)

Record an asset as deleted

Parameters

array $asset Asset tuple

Return Value

bool True if the asset was added to the deleted set

at line 151
array getPublicAssets()

Get all public assets

Return Value

array

at line 161
array getProtectedAssets()

Get protected assets

Return Value

array

at line 171
array getDeletedAssets()

Get deleted assets

Return Value

array