PurgeCache Class Reference

Public Member Functions
	__construct (\Magento\PageCache\Model\Cache\Server $cacheServer, \Magento\CacheInvalidate\Model\SocketFactory $socketAdapterFactory, InvalidateLogger $logger)
	sendPurgeRequest ($tagsPattern)

Data Fields
const	HEADER_X_MAGENTO_TAGS_PATTERN = 'X-Magento-Tags-Pattern'

Protected Attributes
	$cacheServer
	$socketAdapterFactory

Detailed Description

Definition at line 10 of file PurgeCache.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\PageCache\Model\Cache\Server	$cacheServer,
		\Magento\CacheInvalidate\Model\SocketFactory	$socketAdapterFactory,
		InvalidateLogger	$logger
	)

Constructor

Parameters

\Magento\PageCache\Model\Cache\Server	$cacheServer
\Magento\CacheInvalidate\Model\SocketFactory	$socketAdapterFactory
InvalidateLogger	$logger

Definition at line 36 of file PurgeCache.php.

      {
        $this->cacheServer = $cacheServer;
        $this->socketAdapterFactory = $socketAdapterFactory;
        $this->logger = $logger;
    }

Member Function Documentation

sendPurgeRequest()

sendPurgeRequest

(

$tagsPattern

)

Send curl purge request to invalidate cache by tags pattern

Parameters

string

$tagsPattern

Returns

bool Return true if successful; otherwise return false

Definition at line 53 of file PurgeCache.php.

    {
        $socketAdapter = $this->socketAdapterFactory->create();
        $servers = $this->cacheServer->getUris();
        $headers = [self::HEADER_X_MAGENTO_TAGS_PATTERN => $tagsPattern];
        $socketAdapter->setOptions(['timeout' => 10]);
        foreach ($servers as $server) {
            $headers['Host'] = $server->getHost();
            try {
                $socketAdapter->connect($server->getHost(), $server->getPort());
                $socketAdapter->write(
                    'PURGE',
                    $server,
                    '1.1',
                    $headers
                );
                $socketAdapter->read();
                $socketAdapter->close();
            } catch (\Exception $e) {
                $this->logger->critical($e->getMessage(), compact('server', 'tagsPattern'));
                return false;
            }
        }

        $this->logger->execute(compact('servers', 'tagsPattern'));
        return true;
    }

Field Documentation

$cacheServer

$cacheServer

protected

Definition at line 17 of file PurgeCache.php.

$socketAdapterFactory

$socketAdapterFactory

protected

Definition at line 22 of file PurgeCache.php.

HEADER_X_MAGENTO_TAGS_PATTERN

const HEADER_X_MAGENTO_TAGS_PATTERN = 'X-Magento-Tags-Pattern'

Definition at line 12 of file PurgeCache.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-cache-invalidate/Model/PurgeCache.php