# smile/module-custom-entity-akeneo

> Smile - Custom Entity Akeneo Module

`composer require smile/module-custom-entity-akeneo`

Canonical URL: https://packagento.com/smile/module-custom-entity-akeneo

## At a glance

- **Vendor**: smile (https://packagento.com/smile.md)
- **Latest version**: 1.0.5 — released 2025-07-31
- **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/smile/module-custom-entity-akeneo 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 smile/module-custom-entity-akeneo:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Smile - Custom Entity Akeneo Module

## README

### What is this module ?

Import Akeneo's Reference Entities into Smile Custom Entity module.

### Who is developing this module ?

![Smile](doc/static/smile.png)

This module is built by Smile.

Smile is the **European leader of Open Source** and also a four-times **Europe Partner of the the Year** (2010-2014), two-times **Spirit of Excellence** (2015-2016), **Global Elite Partner** (2017-now), and **Regional Commercial Partner** (2018) awarded by Magento.

Our multidisciplinary team brings together experts in technology, innovation, and new applications.

Together we explore, invent, and test technologies of the future, to better serve our clients.

### Main Features

It imports the Akeneo's References Entities, and the associated attributes, options, records and medias into Smile Custom Entity module.
A configuration lets you the possibility to choose which entities you want to import.

### Documentation

- [Installation](doc/install.md)
- [Reference Entity](https://help.akeneo.com/pim/serenity/articles/what-about-reference-entities.html)
- [Custom Entity](https://github.com/Smile-SA/magento2-module-custom-entity)
- [Configuration](doc/configuration.md)
- [Import](doc/import.md)

### Contributing

You can contribute to this module by submitting issues or pull requests.

For more details, please take a look at the [contribution guidelines](CONTRIBUTING.md).

### Standards & Code Quality

[Smile Lab Quality Suite (Magento)](https://github.com/Smile-SA/magento2-smilelab-quality-suite/) provides coding standards / rulesets that can be used on Magento projects.

## Changelog

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

### 1.0.5 - 2025-07-30

- Fix import of smile_custom_entity type attributes when frontend input type does not match between akeneo and magento [#25](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/25)

### 1.0.4 - 2024-03-05

- Removed dependency from parent constructor in ReferenceEntity helper [#24](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/24)

### 1.0.3 - 2024-02-13

- Adaptation of the import of custom entity attributes and custom entity records to manage all image attributes and value by channel and/or locale in [#19](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/19), [#20](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/20), [#21](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/21)

### 1.0.2 - 2023-08-10

- Updating the version of the required modules by @dmytro-khrusch in [#16](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/16)
- Fixed reference_entity import for custom entity by @dmytro-khrusch in [#17](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/17)

### 1.0.1 - 2023-07-26

- Add entity in custom entity import table in [#15](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/15)
- Updated import for attributes of type single_link, multiple_links for reference entity based on new input type for custom entity attributes in [#14](https://github.com/Smile-SA/magento2-module-custom-entity-akeneo/pull/14)

### 1.0.0 - 2022-10-10

- Initial Release

## Recent Versions

| Version | Released |
|---|---|
| 1.0.5 | 2025-07-31 |
| 1.0.4 | 2024-03-05 |
| 1.0.3 | 2024-02-13 |
| 1.0.2 | 2023-08-10 |
| 1.0.1 | 2023-07-26 |
| 1.0.0 | 2022-12-07 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| akeneo/magento2-connector-enterprise | ^103.2 \|\| >=104 |
| php | ^8.0 |
| smile/module-custom-entity | >=1.3.12 |
| smile/module-custom-entity-product-link | ^1.3 |

### Require (dev)

| Package | Constraint |
|---|---|
| smile/magento2-smilelab-quality-suite | ^4.0 |

## Quality

Latest release (1.0.5) 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 | not tested | not tested | – | – |
| 2.4.8 | – | not tested | not tested | – |
| 2.4.9 | – | – | not tested | not tested |


### 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 | 13 | 13 warnings (ruleset: Magento2) — 3 auto-fixable with phpcbf |
| PHPMD | Warning | 5 | 5 rule violations (UnusedFormalParameter:3, TooManyPublicMethods:1, ExcessiveClassComplexity: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 | Error | Error | – | – |
| 2.4.8 | – | Error | Error | – |
| 2.4.9 | – | – | Error | Error |


### 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 | N/A | 0 | no resolvable dependency tree to audit |
| 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=["smile/module-custom-entity-akeneo"],
  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

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