smile / module-custom-entity
smile/module-custom-entity
Smile - Custom Entity Module
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 ?
[image: Smile]
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.
[image: Entity attributes]
- Entity type:
You can create as many entity types as you need
[image: Entity type]
- Entity:
Create your entities:
[image: Entity add button]
[image: Entity list]
Entity type and Entity on front
- Display your entity set and your entities
[image: Entity set]
[image: Entity]
Documentation
Documentation is available here.
The User Guide is also available on PDF format here
Contributing
You can contribute to this module by submitting issues or pull requests.
For more details, please take a look at the contribution guidelines.
Changelog
All notable changes are recorded in this changelog.
Standards & Code Quality
Smile Lab Quality Suite (Magento) 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
- Add mass delete action to entity listing
1.3.13 - 2024-01-09
- 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
- Update for di compile complete on CustomEntityInterface
1.3.11 - 2023-07-25
- Fixed custom_entity_attribute_set_id column migration
1.3.10 - 2023-07-25
- Added custom entity attribute type to custom entity
- Implement new quality standard
1.3.9 - 2023-01-30
- Update parameter on delete custom entity
1.3.8 - 2022-12-02
- Fix Zend Validate Regex
1.3.7 - 2022-11-21
- Add github actions workflow
1.3.6 - 2022-10-19
- 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
- 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
- Fix di compile for CustomEntityExtensionInterface class
1.3.3 - 2022-09-06
- Add use for classes and use type hints on functions
1.3.2 - 2022-09-01
- Add strict types on php files
- Remove disclaimer / annotation comments
- Add .gitattributes and update .gitignore
1.3.1 - 2022-08-23
- 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
- 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
- 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
- Update requirements for scoped eav module
1.0.1 - 2020-03-20
- Remove explicit PHP requirements.
1.0.0 - 2017-08-23
- Initial Release
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 1.3.15 | stable | Fail | Magento 2.4.7-2.4.9 Details | 2024-03-05 16:25:08 |
| 1.3.14 | stable | Not tested | Not yet tested Details | 2024-03-05 13:27:42 |
| 1.3.13 | stable | Not tested | Not yet tested Details | 2024-01-09 14:45:26 |
| 1.3.12 | stable | Not tested | Not yet tested Details | 2023-08-03 14:15:00 |
| 1.3.11 | stable | Not tested | Not yet tested Details | 2023-07-26 07:16:40 |
| 1.3.10 | stable | Not tested | Not yet tested Details | 2023-07-24 14:39:49 |
| 1.3.9 | stable | Not tested | Not yet tested Details | 2023-01-30 14:19:37 |
| 1.3.8 | stable | Not tested | Not yet tested Details | 2022-12-02 17:07:04 |
| 1.3.7 | stable | Not tested | Not yet tested Details | 2022-11-21 15:56:11 |
| 1.3.6 | stable | Not tested | Not yet tested Details | 2022-10-19 13:49:29 |
| 1.3.5 | stable | Not tested | Not yet tested Details | 2022-09-14 13:23:01 |
| 1.3.4 | stable | Not tested | Not yet tested Details | 2022-09-07 08:11:34 |
| 1.3.3 | stable | Not tested | Not yet tested Details | 2022-09-06 14:34:31 |
| 1.3.2 | stable | Not tested | Not yet tested Details | 2022-09-01 13:10:40 |
| 1.3.1 | stable | Not tested | Not yet tested Details | 2022-08-23 13:41:58 |
| 1.3.0 | stable | Not tested | Not yet tested Details | 2022-08-10 08:44:07 |
| 1.2.0 | stable | Not tested | Not yet tested Details | 2020-09-23 14:27:34 |
| 1.1.0 | stable | Not tested | Not yet tested Details | 2020-03-30 21:31:50 |
| 1.0.1 | stable | Not tested | Not yet tested Details | 2020-03-27 12:33:26 |
| 1.0.0 | stable | Not tested | Not yet tested Details | 2019-05-06 11:08:55 |
Requires 3
| Package | Constraint |
|---|---|
| php | ^7.4 || ^8.1 |
| smile/module-scoped-eav | ^1.3 |
| magento/module-sitemap | >=100.3.0 |
Requires-dev 1
| Package | Constraint |
|---|---|
| smile/magento2-smilelab-quality-suite | ^3.0 |
Suggests 2
| Package | Reason |
|---|---|
| smile/module-custom-entity-product-link | Possibility to add product attribute for link product to custom entities |
| smile/module-custom-entity-import-export | Possibility to import custom entities |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. 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.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
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
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from smile
View vendorMagento 2 merchandising and search engine built on ElasticSearch
Smile - Custom Entity Akeneo Module
Extension of Magento2 Sales Rule to provide gifted (free) products with magento/module-sales-rule-staging.
Smile Retailer Offer Inventory
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.