# smile/module-custom-entity

> Smile - Custom Entity Module

`composer require smile/module-custom-entity`

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

## At a glance

- **Vendor**: smile (https://packagento.com/smile.md)
- **Latest version**: 1.3.15 — released 2024-03-05
- **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 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:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Smile - Custom Entity Module

## README

Custom Entity Management
========================

### What is Custom Entity Magento 2 Module?

This module allow possibility to create and manage custom enities like Brand, Pictogram, ... and  to display them in front  

### 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

#### Create Entity Attribute, Entity Type and Entity

* **Entity Attributes:**

This module allows you to **create entity attribute** like the product attributes.

![Entity attributes](./doc/static/entity_attribute_list.png)

* **Entity type:**

You can create as many entity types as you need

![Entity type](./doc/static/entity_type_list.png)

* **Entity:**

Create your entities:

![Entity add button](./doc/static/entity_list_new_button.png)

![Entity list](./doc/static/entity_list.png)

#### Entity type and Entity on front

* **Display your entity set and your entities**

![Entity set](./doc/static/front_entity_set.png)

![Entity](./doc/static/front_entity.png)

### Documentation

Documentation is available [here](https://github.com/Smile-SA/magento2-module-custom-entity/wiki).

The User Guide is also available on PDF format [here](https://github.com/Smile-SA/magento2-module-custom-entity/wiki/static/UserGuide.pdf)

### 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).

### Changelog

All notable changes are recorded in this [changelog](CHANGELOG.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.3.14] - 2024-03-05
[1.3.14]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.13...1.3.14

- Add mass delete action to entity listing

### [1.3.13] - 2024-01-09
[1.3.13]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.12...1.3.13

- Add handler for removing images when deleting an entity
- Optimize cache tags ("smile_custom_entity" -> "sce", "smile_custom_entity_set" -> "sces")
- Fix resource/ACL declaration for display menu Content > Custom Entities > Entities
- Fix url_key generation when store_id > 0 in beforeSave

### [1.3.12] - 2023-08-03
[1.3.12]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.11...1.3.12

- Update for di compile complete on CustomEntityInterface

### [1.3.11] - 2023-07-25
[1.3.11]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.10...1.3.11

- Fixed custom_entity_attribute_set_id column migration

### [1.3.10] - 2023-07-25
[1.3.10]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.9...1.3.10

- Added custom entity attribute type to custom entity
- Implement new quality standard

### [1.3.9] - 2023-01-30
[1.3.9]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.8...1.3.9

- Update parameter on delete custom entity

### [1.3.8] - 2022-12-02
[1.3.8]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.7...1.3.8

- Fix Zend Validate Regex

### [1.3.7] - 2022-11-21
[1.3.7]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.6...1.3.7

- Add github actions workflow

### [1.3.6] - 2022-10-19
[1.3.6]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.5...1.3.6

- Add Smile Lab Quality Suite
- Analyse code style with phpcs / phpmd / phpstan command
- Add db_schema.xml instead InstallSchema

### [1.3.5] - 2022-09-14
[1.3.5]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.4...1.3.5

- Specify php version on composer.json
- Use action interface on controllers
- Add view model instead helper on template
- Use Escaper on templates

### [1.3.4] - 2022-09-07
[1.3.4]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.3...1.3.4

- Fix di compile for CustomEntityExtensionInterface class

### [1.3.3] - 2022-09-06
[1.3.3]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.2...1.3.3

- Add use for classes and use type hints on functions

### [1.3.2] - 2022-09-01
[1.3.2]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.1...1.3.2

- Add strict types on php files
- Remove disclaimer / annotation comments
- Add .gitattributes and update .gitignore

### [1.3.1] - 2022-08-23
[1.3.1]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.3.0...1.3.1

- Allow more recent version of scoped-eav module to be used (Eg for Magento 2.4.4)
- Add CONTRIBUTING.md
- Update README.md

### [1.3.0] - 2022-08-10
[1.3.0]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.2.0...1.3.0

- Add compatibility version for Magento 2.4.4 and Php 8
- Add CHANGELOG.md file
- Check empty values before rendering in templates
- Fitler by attribute set id when the identifier is being checked

### [1.2.0] - 2020-09-30
[1.2.0]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.1.0...1.2.0

- Add compatibility version for Magento 2.3.5 and 2.4.0 through leveraging the requirements for scoped-eav module.

### [1.1.0] - 2020-03-27
[1.1.0]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.0.1...1.1.0

- Update requirements for scoped eav module

### [1.0.1] - 2020-03-20
[1.0.1]: https://github.com/Smile-SA/magento2-module-custom-entity/compare/1.0.0...1.0.1

- Remove explicit PHP requirements.

### 1.0.0 - 2017-08-23

- Initial Release

## Recent Versions

| Version | Released |
|---|---|
| 1.3.15 | 2024-03-05 |
| 1.3.14 | 2024-03-05 |
| 1.3.13 | 2024-01-09 |
| 1.3.12 | 2023-08-03 |
| 1.3.11 | 2023-07-26 |
| 1.3.10 | 2023-07-24 |
| 1.3.9 | 2023-01-30 |
| 1.3.8 | 2022-12-02 |
| 1.3.7 | 2022-11-21 |
| 1.3.6 | 2022-10-19 |

Showing 10 of 20 versions. Full release history on https://packagento.com/smile/module-custom-entity.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/module-sitemap | >=100.3.0 |
| php | ^7.4 \|\| ^8.1 |
| smile/module-scoped-eav | ^1.3 |

### Require (dev)

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

### Suggest

| Package | Constraint |
|---|---|
| smile/module-custom-entity-import-export | Possibility to import custom entities |
| smile/module-custom-entity-product-link | Possibility to add product attribute for link product to custom entities |

## Quality

Latest release (1.3.15) 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 | 98 | 98 warnings (ruleset: Magento2) — 9 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (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 | 21 | 16 | – | – |
| 2.4.8 | – | 16 | 16 | – |
| 2.4.9 | – | – | 16 | 16 |


### 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=["smile/module-custom-entity"],
  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.