# backendorf/module-installment

> Add installment feature to Magento 2 catalog

`composer require backendorf/module-installment`

Canonical URL: https://packagento.com/backendorf/module-installment

## At a glance

- **Vendor**: backendorf (https://packagento.com/backendorf.md)
- **Latest version**: 2.0.0 — released 2026-03-12
- **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/backendorf/module-installment 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 backendorf/module-installment:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Add installment feature to Magento 2 catalog

## README

[![Magento 2.4.x](https://img.shields.io/badge/Magento-2.4.x-brightgreen.svg)](https://magento.com/)
[![Hyvä Compatible](https://img.shields.io/badge/Hyv%C3%A4-Compatible-yellow.svg)](https://hyva.io/)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A powerful and flexible Magento 2 module designed to display installment values and strategic discounts directly on your storefront catalog and product pages. Now fully compatible with **Hyvä Themes** while maintaining support for **Luma/Standard** themes.

### 🚀 Features

- **Multi-Theme Support**: Native support for **Hyvä Themes** (Alpine.js) and **Luma/Standard** themes (jQuery).
- **Installment Display**: Show installment options across Product, Category, and Search pages.
- **Strategic Discounts**: Display custom discounts (e.g., PIX, Bank Transfer) with automatic calculation and deduplication.
- **Configurable Logic**: 
  - Define maximum installments and minimum installment value.
  - Support for **Simple** and **Compound** interest calculations.
- **Customizable Interest**: Set specific interest rates for each installment level.
- **Flexible Templates**: Specific price templates for `catalog_category_view`, `catalogsearch_result_index`, and `catalog_product_view`.
- **Custom Styling**: Control primary colors, highlight text colors, and font weights directly from the admin panel.

### ⚡ Hyvä Integration

This module is built to leverage Hyvä's performance:
- **Alpine.js Components**: Lightweight and reactive installment calculations.
- **Tailwind CSS**: Automatically registers module templates for the Tailwind CSS build process.
- **CSP Compatible**: All JavaScript components are built to comply with Content Security Policy.

### 🛠️ Installation

#### Using Composer (Recommended)

```bash
composer require backendorf/module-installment
```

#### Enable the Module

```bash
bin/magento module:enable Backendorf_Installment
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```

#### For Hyvä Themes

To ensure Tailwind classes are generated correctly for your theme:
```bash
bin/magento hyva:config:generate
```

### ⚙️ Configuration

Navigate to **Stores > Configuration > Backendorf > Installment** to configure:

1.  **General Settings**: Enable/Disable the module, set installment limits, and display behavior.
2.  **Interest Rates**: Configure calculation types and specific rates per installment.
3.  **Discounts**: Add dynamic discount rules based on percentages.
4.  **Price Templates**: Customize the HTML output for different page types.
5.  **Styles**: Personalize the look and feel (colors and typography) to match your brand.

### 📋 Requirements

- **Magento** 2.4.x
- **PHP** 8.1+
- **Hyvä Themes** (Optional, but fully supported)

### 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Recent Versions

| Version | Released |
|---|---|
| 2.0.0 | 2026-03-12 |
| 1.3.1 | 2025-10-11 |
| 1.3.0 | 2024-05-28 |
| 1.2.3 | 2024-05-01 |
| 1.2.2 | 2023-10-10 |
| 1.2.1 | 2023-09-30 |
| v1.2.0 | 2023-08-07 |
| v1.1.0 | 2023-07-07 |
| v1.0.7 | 2021-09-29 |
| v1.0.6 | 2021-08-15 |

Showing 10 of 16 versions. Full release history on https://packagento.com/backendorf/module-installment.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | ^102.0 \|\| ^103.0 |
| magento/module-catalog | ^103.0 \|\| ^104.0 |

## Quality

Latest release (2.0.0) 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 | 1 |


### 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 | Fail | 38 | 2 errors, 36 warnings (ruleset: Magento2) — 12 auto-fixable with phpcbf |
| PHPMD | Warning | 1 | 1 rule violation (UnusedFormalParameter:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 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 | 9 | 9 | – | – |
| 2.4.8 | – | 9 | 9 | – |
| 2.4.9 | – | – | 9 | 10 |


### 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=["backendorf/module-installment"],
  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

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