CacheFlushResult
final readonly class \
What was flushed: cache tags per cache group, cache groups, and the records and cache commands this was resolved from, including what was skipped and why, and the errors reported while flushing.
Table of Contents
Properties
- $commands : array
- $context : CacheFlushingContext
- $errors : array
- $groups : array
- $records : array
- $skippedGroups : array
- $tags : array
Methods
- __construct() : mixed
- fromPlan() : self
- getFlushedRecords() : array<int, CacheFlushRecord>
- getPageIds() : array<int, int>
- Ids of the pages whose caches were flushed by their "pageId_<uid>" tag.
- getSkippedRecords() : array<int, CacheFlushRecord>
- getTags() : array<int, string>
- The flushed cache tags of a cache group, or of all groups if none is given.
- hasErrors() : bool
- includesGroup() : bool
- True if the group, or all caches, were flushed.
Properties
$commands
public
array
$commands
= []
$context
public
CacheFlushingContext
$context
$errors
public
array
$errors
= []
$groups
public
array
$groups
= []
$records
public
array
$records
= []
$skippedGroups
public
array
$skippedGroups
= []
$tags
public
array
$tags
= []
Methods
__construct()
public
__construct(CacheFlushingContext $context[, array<string, array<int, string>> $tags = [] ][, array<int, string> $groups = [] ][, array<string, CacheFlushSkipReason> $skippedGroups = [] ][, array<int, CacheFlushRecord> $records = [] ][, array<int, string> $commands = [] ][, array<int, string> $errors = [] ]) : mixed
Parameters
- $context : CacheFlushingContext
- $tags : array<string, array<int, string>> = []
-
cache group => tags, "all" stands for all caches
- $groups : array<int, string> = []
-
"all" stands for all caches
- $skippedGroups : array<string, CacheFlushSkipReason> = []
- $records : array<int, CacheFlushRecord> = []
- $commands : array<int, string> = []
- $errors : array<int, string> = []
fromPlan()
public
static fromPlan(CacheFlushPlan $plan) : self
Parameters
- $plan : CacheFlushPlan
Return values
selfgetFlushedRecords()
public
getFlushedRecords() : array<int, CacheFlushRecord>
Return values
array<int, CacheFlushRecord>getPageIds()
Ids of the pages whose caches were flushed by their "pageId_<uid>" tag.
public
getPageIds() : array<int, int>
Return values
array<int, int>getSkippedRecords()
public
getSkippedRecords() : array<int, CacheFlushRecord>
Return values
array<int, CacheFlushRecord>getTags()
The flushed cache tags of a cache group, or of all groups if none is given.
public
getTags([string|null $group = null ]) : array<int, string>
Parameters
- $group : string|null = null
Return values
array<int, string>hasErrors()
public
hasErrors() : bool
Return values
boolincludesGroup()
True if the group, or all caches, were flushed.
public
includesGroup(string $group) : bool
Parameters
- $group : string