Diviner Phabricator Tech Docs PhabricatorCacheGeneralGarbageCollector

final class PhabricatorCacheGeneralGarbageCollector
Phabricator Technical Documentation (Cache)

This class is not documented.

Tasks

Getting Collector Information

public function getCollectorName()
public function hasAutomaticPolicy() — Specify that the collector has an automatic retention policy and is not configurable.
public function getDefaultRetentionPolicy()
public function getRetentionPolicy() — Get the effective retention policy.
final public function getCollectorConstant() — Get a unique string constant identifying this collector.

Collecting Garbage

final public function runCollector() — Run the collector.
protected function collectGarbage()
final protected function getGarbageEpoch() — Get the most recent epoch timestamp that is considered garbage.
final public static function getAllCollectors() — Load all of the available garbage collectors.

Methods

public function getCollectorName()

PhabricatorGarbageCollector

Get a human readable name for what this collector cleans up, like "User Activity Logs".

PhabricatorCacheGeneralGarbageCollector

This method is not documented.

Return

string

Human-readable collector name.

public function hasAutomaticPolicy()
Inherited

PhabricatorGarbageCollector

Specify that the collector has an automatic retention policy and is not configurable.

Return

bool	True if the collector has an automatic retention policy.

public function getDefaultRetentionPolicy()

PhabricatorGarbageCollector

Get the default retention policy for this collector.

Return the age (in seconds) when resources start getting collected, or null to retain resources indefinitely.

PhabricatorCacheGeneralGarbageCollector

This method is not documented.

Return

int|null

Lifetime, or `null` for indefinite retention.

public function getRetentionPolicy()
Inherited

PhabricatorGarbageCollector

Get the effective retention policy.

Return

int|null

Lifetime, or `null` for indefinite retention.

final public function getCollectorConstant()
Inherited

PhabricatorGarbageCollector

Get a unique string constant identifying this collector.

Return

string

Collector constant.

final public function runCollector()
Inherited

PhabricatorGarbageCollector

Run the collector.

Return

bool	True if there is more garbage to collect.

protected function collectGarbage()

PhabricatorGarbageCollector

Collect garbage from whatever source this GC handles.

PhabricatorCacheGeneralGarbageCollector

This method is not documented.

Return

bool	True if there is more garbage to collect.

final protected function getGarbageEpoch()
Inherited

PhabricatorGarbageCollector

Get the most recent epoch timestamp that is considered garbage.

Records older than this should be collected.

Return

int	Most recent garbage timestamp.

final public static function getAllCollectors()
Inherited

PhabricatorGarbageCollector

Load all of the available garbage collectors.

Return

list<PhabricatorGarbageCollector>

Garbage collectors.

Defined: src/applications/cache/garbagecollector/PhabricatorCacheGeneralGarbageCollector.php:3
Extends: PhabricatorGarbageCollector

final class PhabricatorCacheGeneralGarbageCollectorPhabricator Technical Documentation (Cache)

Tasks

Getting Collector Information

Collecting Garbage

Methods

public function getCollectorName()

public function hasAutomaticPolicy()Inherited

public function getDefaultRetentionPolicy()

public function getRetentionPolicy()Inherited

final public function getCollectorConstant()Inherited

final public function runCollector()Inherited

protected function collectGarbage()

final protected function getGarbageEpoch()Inherited

final public static function getAllCollectors()Inherited

final class PhabricatorCacheGeneralGarbageCollector
Phabricator Technical Documentation (Cache)

public function hasAutomaticPolicy()
Inherited

public function getRetentionPolicy()
Inherited

final public function getCollectorConstant()
Inherited

final public function runCollector()
Inherited

final protected function getGarbageEpoch()
Inherited

final public static function getAllCollectors()
Inherited