Class \Scrivo\AssetSet

A Scrivo Asset set is a group of Scrivo assets with a common parent id.

A asset set is actually a simple array of (child) assets but it does a couple of things extra:

When serialized only the ids are stored.
When iteratering, counting or getting assets from the array only the readable assets in the array will be taken into account.

Asset sets are a part of a Scrivo asset and are used to retrieve and iterate through the child assets (or path) of an asset.

Implements
Defined in: AssetSet.php.

Constructor summary
Attr.	Name / Description
public	AssetSet($asset) Construct an asset set.

Member summary
Attr.	Type	Name	Description
private	\..\Asset	$asset	The parent asset of the set.
private	\..\int[]	$ids	An array containing the keys of the items array, used when serializing.
private	\..\Asset[]	$items	The array containing the assets or asset ids.

Method summary
Attr.	Type	Name / Description
public		__sleep() When serializing retrieve the don't store the items array but just the keys.
public		__wakeup() When unserializing restore the items array only the id.
private		check($id) When reading the items array always check of the actual entry is an instantiated Scrivo asset.
public	int	count() The asset count of assets in the set.
public	\..\Asset	current() Get the current asset from the asset set when iterating.
public	\..\Asset	key() Get the key(id) of the current asset from the asset set when iterating.
public	\..\Asset	next() Get the current asset from the asset set and move the internal pointer to the next asset in the set.
public	boolean	offsetExists($id) Test if asset is set in the asset set.
public	\..\Asset	offsetGet($id) Get an asset with a specific id from the asset set.
public		offsetSet($id, $asset) Set an asset in the asset set.
public		offsetUnset($id) It is not possible to unset assets in an asset set.
public		prepend($asset) Add an asset to the beginning of the set.
public		rewind() Rewind the asset set so that iterating will start at the beginning.
public	boolean	valid() Test if the current asset is valid.

Constructor

public AssetSet(\Scrivo\Asset $asset)

Construct an asset set.

Parameters:
Type	Name	Def.	Description
\Scrivo\Asset	$asset		The parent asset of the asset set.

View source: AssetSet.php line 90.

Members

private \Scrivo\Asset $asset

The parent asset of the set.

Inital value: null

View source: AssetSet.php line 62.

private \Scrivo\int[id] $ids

An array containing the keys of the items array, used when serializing.

Inital value: null

View source: AssetSet.php line 68.

private \Scrivo\Asset[id] $items

The array containing the assets or asset ids.

Inital value: array()

View source: AssetSet.php line 56.

Methods

public __sleep()

When serializing retrieve the don't store the items array but just the keys.

return array An array with the names of the serializable members.

View source: AssetSet.php line 242.

public __wakeup()

When unserializing restore the items array only the id.

View source: AssetSet.php line 255.

private check(int $id)

When reading the items array always check of the actual entry is an instantiated Scrivo asset.

If not, get that asset and store it in the items array.

Parameters:
Type	Name	Def.	Description
int	$id		The asset id of the entry to check.

View source: AssetSet.php line 77.

public int count()

The asset count of assets in the set.

Note that returned asset count depends on whether the assets are readable for the user defined in the Scrivo context. So the returned count is always equeal or less that the actual count of assets in the items array.