public function AcquiaPurgeExecutorInterface::invalidate in Acquia Purge 7

Invalidate one or multiple paths from an external layer.

This method is responsible for clearing all the given invalidation objects from the external cache layer this executor covers. Executors decide /how/ they clear something, as long as they correctly call ::setStatusSucceeded() or ::setStatusFailed() on each processed object.

Parameters

AcquiaPurgeInvalidationInterface[] $invalidations: Unassociative list of AcquiaPurgeInvalidationInterface-compliant objects that contain the necessary info in them. You may likely need several of the following methods on the invalidation object:

• ::getScheme(): e.g.: 'https' or 'https://' when passing TRUE.
• ::getDomain(): e.g.: 'site.com'
• ::getPath(): e.g.: '/basepath/products/electrical/*'
• ::getUri(): e.g.: 'https://site.com/basepath/products/electrical/*'
• ::hasWildcard(): call this to find out if there's a asterisk ('*').
• ::setStatusFailed(): call this when clearing this item failed.
• ::setStatusSucceeded(): call this when clearing this item succeeded.

2 methods override AcquiaPurgeExecutorInterface::invalidate()

AcquiaPurgeExecutorAcquia::invalidate in lib/executor/AcquiaPurgeExecutorAcquia.php

Invalidate one or multiple paths from an external layer.

AcquiaPurgeExecutorPageCache::invalidate in lib/executor/AcquiaPurgeExecutorPageCache.php

Invalidate one or multiple paths from an external layer.

File

lib/executor/AcquiaPurgeExecutorInterface.php, line 59

Contains AcquiaPurgeExecutorInterface.

Class

AcquiaPurgeExecutorInterface

Describes an executor, which is responsible for taking a set of invalidation objects and wiping these paths/URLs from an external cache.

Code

public function invalidate($invalidations);