Back to Dagger

EngineCache

docs/static/reference/php/Dagger/EngineCache.html

0.20.73.8 KB
Original Source

EngineCache

class EngineCache extends AbstractObject implements IdAble

A cache storage for the Dagger engine

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

EngineCacheEntrySet

entrySet(string|null $key = '')

The current set of entries in the cache

AbstractId

id()

A unique identifier for this EngineCache.

int

maxUsedSpace()

The maximum bytes to keep in the cache without pruning.

int

minFreeSpace()

The target amount of free disk space the garbage collector will attempt to leave.

void

prune(bool|null $useDefaultPolicy = false, string|null $maxUsedSpace = '', string|null $reservedSpace = '', string|null $minFreeSpace = '', string|null $targetSpace = '')

Prune the cache of releaseable entries

int

reservedSpace()

The minimum amount of disk space this policy is guaranteed to retain.

int

targetSpace()

The target number of bytes to keep when pruning.

Details

in AbstractObject at line 13 __construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |

in AbstractObject at line 19 protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |

Return Value

| null|array|string|int|float|bool | |

at line 19 EngineCacheEntrySet entrySet(string|null $key = '')

The current set of entries in the cache

Parameters

| string|null | $key | |

Return Value

| EngineCacheEntrySet | |

at line 31 AbstractId id()

A unique identifier for this EngineCache.

Return Value

| AbstractId | |

at line 40 int maxUsedSpace()

The maximum bytes to keep in the cache without pruning.

Return Value

| int | |

at line 49 int minFreeSpace()

The target amount of free disk space the garbage collector will attempt to leave.

Return Value

| int | |

at line 58 void prune(bool|null $useDefaultPolicy = false, string|null $maxUsedSpace = '', string|null $reservedSpace = '', string|null $minFreeSpace = '', string|null $targetSpace = '')

Prune the cache of releaseable entries

Parameters

| bool|null | $useDefaultPolicy | | | string|null | $maxUsedSpace | | | string|null | $reservedSpace | | | string|null | $minFreeSpace | | | string|null | $targetSpace | |

Return Value

| void | |

at line 87 int reservedSpace()

The minimum amount of disk space this policy is guaranteed to retain.

Return Value

| int | |

at line 96 int targetSpace()

The target number of bytes to keep when pruning.

Return Value

| int | |

Generated by Doctum, a API Documentation generator and fork of Sami.