Page MenuHomeClusterLabs Projects
Diviner Tech Docs PhabricatorGarbageCollector

abstract class PhabricatorGarbageCollector
Phorge Technical Documentation (Daemons)

This class is not documented.

Tasks

Getting Collector Information

  • abstract public function getCollectorName() — Get a human readable name for what this collector cleans up, like "User Activity Logs".
  • public function hasAutomaticPolicy() — Specify that the collector has an automatic retention policy and is not configurable.
  • public function getDefaultRetentionPolicy() — Get the default retention policy for this collector.
  • 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.
  • abstract protected function collectGarbage() — Collect garbage from whatever source this GC handles.
  • 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

abstract public function getCollectorName()

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

Return
stringHuman-readable collector name.

public function hasAutomaticPolicy()

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

Return
boolTrue if the collector has an automatic retention policy.

public function getDefaultRetentionPolicy()

Get the default retention policy for this collector.

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

Return
int|nullLifetime, or `null` for indefinite retention.

public function getRetentionPolicy()

Get the effective retention policy.

Return
int|nullLifetime, or `null` for indefinite retention.

final public function getCollectorConstant()

Get a unique string constant identifying this collector.

Return
stringCollector constant.

final public function runCollector()

Run the collector.

Return
boolTrue if there is more garbage to collect.

abstract protected function collectGarbage()

Collect garbage from whatever source this GC handles.

Return
boolTrue if there is more garbage to collect.

final protected function getGarbageEpoch()

Get the most recent epoch timestamp that is considered garbage.

Records older than this should be collected.

Return
intMost recent garbage timestamp.

final public static function getAllCollectors()

Load all of the available garbage collectors.

Return
list<PhabricatorGarbageCollector>Garbage collectors.
Defined
src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php:7