Download the PHP package hryvinskyi/magento2-esi-page-layout without Composer

On this page you can find all versions of the php package hryvinskyi/magento2-esi-page-layout. 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 hryvinskyi/magento2-esi-page-layout

Informations about the package magento2-esi-page-layout

Varnish ESI Theme Context for Magento 2

Ensures correct theme context and cache segmentation for Varnish ESI block requests in multi-theme Magento setups.

Problem

When Varnish fetches ESI blocks via /page_cache/block/esi, the request does not carry any theme context. In a multi-theme store (e.g. Vendor/base and Venor/balckfriday), ESI blocks may be rendered and cached using the wrong theme, causing incorrect markup or broken styles.

Additionally, blocks with ttl are rendered inline during full-page generation even though they will be replaced by <esi:include> tags — wasting server resources.

Solution

This module solves both issues with three components:

1. Observer: ProcessLayoutRenderElement

Replaces the core Magento\PageCache\Observer\ProcessLayoutRenderElement (disabled in frontend scope). Adds an esi_theme parameter directly to the ESI URL during <esi:include> tag generation, so the theme path is carried through to the ESI request.

2. Plugin: RestoreEsiContextPlugin

Before plugin on Magento\PageCache\Controller\Block\Esi::execute(). Reads esi_theme from the request, sets the design theme via DesignInterface::setDesignTheme(), and adds a layout cache key (esi_theme_{path}) so layout cache is segmented per theme.

3. Plugin: SkipRenderLayoutElementPlugin

Around plugin on Magento\Framework\View\Layout::renderNonCachedElement(). When Varnish full-page cache is active and the page is cacheable, blocks with a TTL are skipped (return empty string) since they will be served via ESI includes instead.

Known Issues with Third-Party Modules

Amasty: Incorrect Entity-Specific Handle Registration

Warning: Avoid using Amasty modules if you want your site to be solid and have good performance.

Amasty modules (amasty/module-shop-by-brand, amasty/shopby) have a bug in their category controllers where they call addPageLayoutHandles() with both type and id parameters in a single call without setting $entitySpecific = false:

Magento core does this correctly with separate calls:

This causes catalog_category_view_type_layered to be registered as an entity-specific handle. Magento's ProcessLayoutRenderElement observer then strips it from ESI URLs via array_diff(), so when Varnish fetches the ESI block, the layout is loaded without the layered navigation handle, resulting in broken block rendering on category and brand pages.

Installation

Configuration

No configuration required. The module activates automatically when Varnish full-page cache is enabled.

Requirements

All versions of magento2-esi-page-layout with dependencies

PHP Build Version
Package Version
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 hryvinskyi/magento2-esi-page-layout contains the following files

Loading the files please wait ...