Page MenuHomeClusterLabs Projects
Diviner Tech Docs HeraldTranscriptGarbageCollector

final class HeraldTranscriptGarbageCollector
Phorge Technical Documentation (Herald)

This class is not documented.

Tasks

Getting Collector Information

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".

HeraldTranscriptGarbageCollector
This method is not documented.
Return
stringHuman-readable collector name.

public function hasAutomaticPolicy()
Inherited

PhabricatorGarbageCollector

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()

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.

HeraldTranscriptGarbageCollector
This method is not documented.
Return
int|nullLifetime, or `null` for indefinite retention.

public function getRetentionPolicy()
Inherited

PhabricatorGarbageCollector

Get the effective retention policy.

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

final public function getCollectorConstant()
Inherited

PhabricatorGarbageCollector

Get a unique string constant identifying this collector.

Return
stringCollector constant.

final public function runCollector()
Inherited

PhabricatorGarbageCollector

Run the collector.

Return
boolTrue if there is more garbage to collect.

protected function collectGarbage()

PhabricatorGarbageCollector

Collect garbage from whatever source this GC handles.

HeraldTranscriptGarbageCollector
This method is not documented.
Return
boolTrue 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
intMost 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/herald/garbagecollector/HeraldTranscriptGarbageCollector.php:3
Extends
PhabricatorGarbageCollector