WANGetWithSetCallbackBuilder.php

Go to the documentation of this file.

<?php
namespace Wikimedia\ObjectCache;
 
use LogicException;
 
class WANGetWithSetCallbackBuilder {
    private $callback = null;
    private WANObjectCache $cache;
    private ?string $key = null;
    private ?int $lifetime = null;
    private array $options = [];
 
    public function __construct( WANObjectCache $cache ) {
        $this->cache = $cache;
    }
 
    public function key( string $keygroup, ...$components ) {
        $this->key = $this->cache->makeKey( $keygroup, ...$components );
 
        return $this;
    }
 
    public function globalKey( string $keygroup, ...$components ) {
        $this->key = $this->cache->makeGlobalKey( $keygroup, ...$components );
        return $this;
    }
 
    public function rawKey( string $key ) {
        $this->key = $key;
 
        return $this;
    }
 
    public function lifetime( int $seconds ) {
        $this->lifetime = $seconds;
        return $this;
    }
 
    public function keepIndefinitely() {
        return $this->lifetime( WANObjectCache::TTL_INDEFINITE );
    }
 
    public function keepForAMinute() {
        return $this->lifetime( WANObjectCache::TTL_MINUTE );
    }
 
    public function keepForAnHour() {
        return $this->lifetime( WANObjectCache::TTL_HOUR );
    }
 
    public function keepForADay() {
        return $this->lifetime( WANObjectCache::TTL_DAY );
    }
 
    public function keepForAWeek() {
        return $this->lifetime( WANObjectCache::TTL_WEEK );
    }
 
    public function keepForAMonth() {
        return $this->lifetime( WANObjectCache::TTL_MONTH );
    }
 
    public function keepForAYear() {
        return $this->lifetime( WANObjectCache::TTL_YEAR );
    }
 
    public function invalidatedByKey( string $keygroup, ...$components ) {
        $this->options['checkKeys'][] = $this->cache->makeKey( $keygroup, ...$components );
 
        return $this;
    }
 
    public function invalidatedByGlobalKey( string $keygroup, ...$components ) {
        $this->options['checkKeys'][] = $this->cache->makeGlobalKey( $keygroup, ...$components );
 
        return $this;
    }
 
    public function lastModifiedCallback( callable $callback ) {
        $this->options['touchedCallback'] = $callback;
 
        return $this;
    }
 
    public function allowStale( int $seconds = 30 ) {
        $this->options['lockTSE'] = $seconds;
 
        return $this;
    }
 
    public function busyValue( $value ) {
        $this->options['busyValue'] = $value;
 
        return $this;
    }
 
    public function refreshBeforeExpiry( int $seconds ) {
        $this->options['lowTTL'] = $seconds;
 
        return $this;
    }
 
    public function refreshPopularEvery( int $seconds ) {
        $this->options['hotTTR'] = $seconds;
 
        return $this;
    }
 
    public function refreshPopularAfterAge( int $seconds ) {
        $this->options['ageNew'] = $seconds;
 
        return $this;
    }
 
    public function processCacheLifetime( int $seconds ) {
        $this->options['pcTTL'] = $seconds;
 
        return $this;
    }
 
    public function shortProcessCache() {
        return $this->processCacheLifetime( WANObjectCache::TTL_PROC_SHORT );
    }
 
    public function longProcessCache() {
        return $this->processCacheLifetime( WANObjectCache::TTL_PROC_LONG );
    }
 
    public function processCacheGroup( string $group ) {
        $this->options['pcGroup'] = $group;
 
        return $this;
    }
 
    public function valueVersion( int $version ) {
        $this->options['version'] = $version;
 
        return $this;
    }
 
    public function allowSegmentation( bool $enabled = true ) {
        $this->options['segmentable'] = $enabled;
 
        return $this;
    }
 
    public function callback( callable $callback ) {
        $this->callback = $callback;
 
        return $this;
    }
 
    public function fetch() {
        if ( $this->key === null ) {
            throw new LogicException( 'No cache key set; call key(), globalKey(), or rawKey() first' );
        }
        if ( $this->lifetime === null ) {
            throw new LogicException( 'No lifetime set; call lifetime(), keepIndefinitely(), or e.g. keepForADay()' );
        }
        if ( $this->callback === null ) {
            throw new LogicException( 'No callback set; call callback()' );
        }
 
        return $this->cache->getWithSetCallback(
            $this->key,
            $this->lifetime,
            $this->callback,
            $this->options
        );
    }
}