# elgentos/magento2-alternate-urls

> Add alternate URLs (hreflang) to all pages in the webshop

`composer require elgentos/magento2-alternate-urls`

Canonical URL: https://packagento.com/elgentos/magento2-alternate-urls

## At a glance

- **Vendor**: elgentos (https://packagento.com/elgentos.md)
- **Latest version**: 1.2.1 — released 2023-05-23
- **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/elgentos/magento2-alternate-urls 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 elgentos/magento2-alternate-urls:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Add alternate URLs (hreflang) to all pages in the webshop

## README

Makes it possible to configure and add alternate URLs to the `<head>` of each page.
The link to other websites/stores can be created manually in the admin

### Installation

This package can be installed using [Composer](https://getcomposer.com).

```bash
composer require elgentos/magento2-alternate-urls
bin/magento module:enable Elgentos_AlternateUrls
bin/magento setup:upgrade
```

### Usage

To use the module, you'll have to enable the module and add some mapping to 
"connect" websites/stores to each other. The script will automatically add 
references to the `<head>` of the page for each link that is found for the current
page.

### Extending for other page types

To extend this functionality to other page types (like blog posts from a module),
you will have to create a custom module and add a custom type that implements 
`Elgentos\AlternateUrls\Type\TypeInterface`. After that you'll need to add your
custom type to the `typeInstances` in the `alternate_urls` block in `default.xml`.

#### Example

```xml
<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="alternate_urls">
            <arguments>
                <argument name="typeInstances" xsi:type="array">
                    <item name="custom_page_type" xsi:type="object">
                        MyNamespace\CustomPageTypeAlternateUrls\Type\CustomPageType
                    </item>
                </argument>
            </arguments>
        </referenceBlock>
    </body>
</page>
```

### Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

### License
proprietary

## Changelog

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

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

### [1.2.1] - 2023-05-23
#### Fixed
- Solve coding standard errors

### [1.2.0] - 2022-08-22
#### Added
- PHP 8.1 and Magento 2.4.4 compatible

### [1.1.1] - 2022-08-22
#### Fixed
- Solve issue with incorrect multistore category URLs

### [1.1.0] - 2022-02-03
#### Added
- Implement compatibility with Magento 2.3.7-p1

### [1.0.0] - 2021-11-09
#### Added
- Implement alternate URLS for product pages
- Implement alternate URLS for category pages
- Implement alternate URLS for CMS pages
- Implement alternate URLS for default pages (i.e. account pages)

[Unreleased]: https://github.com/elgentos/magento2-alternate-urls/tree/main
[1.2.0]: https://github.com/elgentos/magento2-alternate-urls/compare/1.1.1...1.2.0
[1.1.1]: https://github.com/elgentos/magento2-alternate-urls/compare/1.1.0...1.1.1
[1.1.0]: https://github.com/elgentos/magento2-alternate-urls/compare/1.0.0...1.1.0
[1.0.0]: https://github.com/elgentos/magento2-alternate-urls/releases/tag/v1.0.0

## Recent Versions

| Version | Released |
|---|---|
| 1.2.1 | 2023-05-23 |
| 1.2.0 | 2023-05-23 |
| 1.1.1 | 2022-08-22 |
| 1.0.0 | 2021-11-09 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | ^102.0.7\|\|^103.0 |
| magento/module-catalog | ^103.0.7\|\|^104.0 |
| php | ^7.4\|\|^8.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| youwe/coding-standard-magento2 | ^2.0.0 |
| youwe/testing-suite | ^2.9 |

## Quality

Latest release (1.2.1) passes 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 | 15 | 15 warnings (ruleset: Magento2) — 1 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### 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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### 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=["elgentos/magento2-alternate-urls"],
  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

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

