Download the PHP package mothership/headless-shopware-varnish-cache without Composer

On this page you can find all versions of the php package mothership/headless-shopware-varnish-cache. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of mothership/headless-shopware-varnish-cache

Informations about the package headless-shopware-varnish-cache

Mothership Varnish cache adapter for headless Shopware

This Shopware bundle adds a cache adapter for a varnish for headless shopware.
If activated, it automatically invalidates a varnish cache when a cache-tag gets invalidated in Shopware. Like this, an external frontend application can use an effective full page cache (FPC) together with a headless Shopware backend.

This bundle is meant to be used together with the corresponding nuxt module e.g. for Shopware-PWA. Nevertheless, it can be used without the nuxt module, if the headless application sets cache tags in another way.

This currently obviously only works on self-hosted Shopware instances, as you need to be able to install the bundle.

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

Step 3: Configuration

First add the configuration file:

As you can see, two environment variables are used:

Example Varnish configuration

See a stripped down example Varnish configuration here.
There is also an example available which only uses xkeys here.

Disclaimer: this is not a production ready configuration file and stripped down to show the essential parts for the caching solution!

Usage

After installation and activation the module automatically invalidates the varnish cache at the configured hosts when a cache-tag gets invalidated in Shopware.
For example if a product changes, Shopware by default invalidates a cache-tag for this product. Like this all pages that contain this product get invalidated too and therefore are always up-to-date.

CLI-Command to manually flush the cache

bin/console varnish:invalidate

Flush manually via curl

Using the xkeys version

Usecase Command Description
single URL curl -X BAN https://www.domain.de/my/path Only the specified URL gets flushed
whole domain curl -X BAN -H 'xkey: all' https://www.domain.de Flush all URLs on the specified host
single cache-tag curl -X BAN -H 'xkey: product-<ID>' https://www.domain.de Flush all sites (on all hosts) with cache-tag "product-"

Using the custom-header version

Usecase Command Description
single URL curl -X BAN https://www.domain.de/my/path Only the specified URL gets flushed
whole host curl -X BAN -H 'X-Cache-Tags: all' https://www.domain.de Flush all URLs on the specified host
single cache-tag curl -X BAN -H 'X-Cache-Tags: product-<ID>' https://www.domain.de Flush all sites with cache-tag "product-" on this host

All versions of headless-shopware-varnish-cache with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
shopware/core Version ^v6.6
shopware/storefront Version ^v6.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mothership/headless-shopware-varnish-cache contains the following files

Loading the files please wait ....