# integer-net/magento2-global-custom-layout

> Module for Magento 2 that allows you to add global layout update files to be selected from admin, by using '0' instead of an entity_id

`composer require integer-net/magento2-global-custom-layout`

Canonical URL: https://packagento.com/integer-net/magento2-global-custom-layout

## At a glance

- **Vendor**: integer-net (https://packagento.com/integer-net.md)
- **Latest version**: 1.1.2 — released 2020-05-11
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/integer-net/magento2-global-custom-layout and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require integer-net/magento2-global-custom-layout:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Module for Magento 2 that allows you to add global layout update files to be selected from admin, by using '0' instead of an entity_id

## README

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]

Allows you to add global layout update files to be selected from admin, by using `0` instead of a `category_id` / `sku` / `url_path`.

Compatible with Magento 2.3.4 and higher, since **cms-page/product/category specific layouts** where introduced in this version.

### Purpose

In Magento 2.3.4, [xml layout updates were removed from the Magento Admin](https://devdocs.magento.com/guides/v2.3/release-notes/release-notes-2-3-4-open-source.html#highlights), for security reasons.
Previously this textfield allowed you to add XML Layout updates to any given Category, Product or CMS Page.
After the update, this textfield is no longer available, but you can select custom layout updates which are defined in xml layout files in the filesystem.
 
After uploading/deploying _selectable layout files_ onto your project's filesystem, these layouts can be selected from the admin under the **Design** section.
The field is called **Custom Layout Update**.

### Usage:

Replace identifiers in selectable layouts with a 0 (zero).
Add layout file to themes/modules using:
 - catalog_category_view_selectable_0_<Layout Update Name>.xml for Categories
 - catalog_product_view_selectable_0_<Layout Update Name>.xml for Products
 - cms_page_view_selectable_0_<Layout Update Name>.xml for Cms pages
 
These files can go anywhere where you'd normally put layout files. For example:
`app/design/frontend/[Theme_Vendor]/[Theme_Name]/Magento_Theme/layout/catalog_category_view_0_customchanges.xml`

You can now select the layout update at _any_ given Category/Product/Page, under **Custom layout update** field of **Design**.

More info on default behaviour of selectable layouts: 
[Magento DevDocs: Create cms-page/product/category-specific layouts](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/xml-manage.html#create-cms-pageproductcategory-specific-layouts)

### Installation

1. Install via composer
    ```
    composer require integer-net/magento2-global-custom-layout
    ```
2. Enable module
    ```
    bin/magento setup:upgrade
    ```
### Configuration

Zero configuration needed.

### Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

### Testing

#### Magento Integration Tests

0. Configure test database in `dev/tests/integration/etc/install-config-mysql.php`. [Read more in the Magento docs.](https://devdocs.magento.com/guides/v2.3/test/integration/integration_test_execution.html) 

1. Copy `Test/Integration/phpunit.xml.dist` from the package to `dev/tests/integration/phpunit.xml` in your Magento installation.

2. In that directory, run
    ``` bash
    ../../../vendor/bin/phpunit
    ```

### Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Known issues

1. Does not work with the homepage (cms_index_index). But hey, it doesn't in the default Magento implementation either.

### Security

If you discover any security related issues, please email ww@integer-net.de instead of using the issue tracker.

### Credits

- [Willem Wigman][link-author]
- [All Contributors][link-contributors]

### License

The MIT License (MIT). Please see [License File](LICENSE.txt) for more information.

[ico-version]: https://img.shields.io/packagist/v/integer-net/magento2-global-custom-layout.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/integer-net/magento2-global-custom-layout/master.svg?style=flat-square
[ico-scrutinizer]: https://scrutinizer-ci.com/g/integer-net/magento2-global-custom-layout/badges/coverage.png?b=master
[ico-code-quality]: https://img.shields.io/scrutinizer/g/integer-net/magento2-global-custom-layout.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/integer-net/magento2-global-custom-layout
[link-travis]: https://travis-ci.org/integer-net/magento2-global-custom-layout
[link-scrutinizer]: https://scrutinizer-ci.com/g/integer-net/magento2-global-custom-layout/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/integer-net/magento2-global-custom-layout
[link-author]: https://github.com/wigman
[link-contributors]: ../../contributors

## Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

### 1.0.0 - 2020-04-27
#### Added
- Plugins for category, product and page layouts that allow custom layout files to be loaded with a global identifier
 (`0`). E.g. `catalog_category_view_selectable_0_.xml` for Categories.

### 1.1.0 - 2020-05-02
#### Added
- Adds frontend test coverage for global custom layout updates
- Fixes [#7](https://github.com/integer-net/magento2-global-custom-layout/issues/7) where layout handles were not merged in Product and Page Plugins' `afterFetchAvailableFiles()` method.

### 1.1.1 - 2020-05-08
#### Added
- Adds module registration test (registration.php coverage)
- Adds travis config for tags/releases

### 1.1.2 - 2020-05-11
#### Added
- Updates travis, magento 2.4-dev now requires elasticsearch
- Adds return type declaration (`void`) to `setUp()` functions, now needed for magento 2.4

## Recent Versions

| Version | Released |
|---|---|
| 1.1.2 | 2020-05-11 |
| 1.1.1 | 2020-05-08 |
| 1.1.0 | 2020-05-05 |
| 1.0.0 | 2020-04-27 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=102.0.4 |
| magento/module-catalog | >=103.0.4 |
| magento/module-cms | >=103.0.4 |
| php | >=7.1.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| magento/magento-coding-standard | @dev |

## Quality

Latest release (1.1.2) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 29 | 29 warnings (ruleset: Magento2) — 20 auto-fixable with phpcbf |
| PHPMD | Warning | 4 | 4 rule violations (IfStatementAssignment:4) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 68 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 4 | valid; 4 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 8 | 8 | – | – |
| 2.4.8 | – | 8 | 8 | – |
| 2.4.9 | – | – | 8 | 8 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Error | Error | – | – |
| 2.4.8 | – | Error | Error | – |
| 2.4.9 | – | – | Error | not tested |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["integer-net/magento2-global-custom-layout"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

integer-net is a Magento 2 vendor on Packagento. See https://packagento.com/integer-net.md for their full catalogue.