Weave Code
Akeneo PIM Custom entity bundle
Frequently asked questions about Custom Entity Bundle
- Can I use Akeneo CustomEntityBundle in a standalone Laravel project without Akeneo PIM?
- No, this bundle is tightly coupled with Akeneo PIM and requires its core architecture. For standalone Laravel projects, consider alternatives like Spatie’s Laravel Media Library or custom Eloquent models instead.
- What Laravel/Akeneo versions does the CustomEntityBundle support?
- The bundle aligns with Akeneo PIM versions (e.g., 4.0.* for Akeneo 4.0). It’s not a standalone Laravel package—it depends on Akeneo’s Symfony-based ecosystem, so check the [requirements table](https://github.com/akeneo/CustomEntityBundle#requirements) for exact version mappings.
- How do I create a custom entity like a supplier hierarchy?
- Extend `AbstractCustomEntity`, define Doctrine mappings, and configure YAML files (e.g., `menu.yml`, `form_extensions.yml`). Follow Akeneo’s [reference data documentation](https://docs.akeneo.com/4.0/manipulate_pim_data/catalog_structure/creating_a_reference_data.html) for step-by-step setup.
- What’s the installation process for Akeneo CustomEntityBundle?
- Run `composer require akeneo-labs/custom-entity-bundle`, enable the bundle in `bundles.php`, add routing in `routes.yml`, and run `doctrine:schema:update`. Frontend assets require `yarn webpack-dev` after configuration changes.
- Does this bundle support REST APIs or GraphQL?
- It includes normalizers for API consistency but relies on Akeneo’s existing API layer. For GraphQL, you’d need to integrate with Akeneo’s API platform or build custom resolvers, as the bundle doesn’t natively support GraphQL.
- How do I test custom entities in a CI/CD pipeline?
- Use Dockerized Akeneo test environments (e.g., `akeneo/pim-community-dev`) and configure `phpunit.xml` for Akeneo’s testing stack. Unit tests require `phpspec`, while integration tests need a full PIM setup with `.env.test`.
- Will upgrading Akeneo PIM break my custom entities?
- Yes, the bundle is version-locked to Akeneo PIM. Always test upgrades in a staging environment and use exact Composer versions (e.g., `4.0.*`) to avoid compatibility issues. Review Akeneo’s changelog for breaking changes.
- Can I customize the UI for custom entities without Akeneo’s frontend?
- No, the bundle assumes Akeneo’s Symfony UX + Webpack pipeline. Customizing the UI requires modifying Akeneo’s assets or forking its frontend components, which may not be feasible for standalone Laravel projects.
- How do I handle database migrations for custom entities?
- Each entity creates a new table. Use `doctrine:schema:update --dump-sql` to preview changes and back up your database before applying migrations. Avoid manual schema edits to prevent conflicts with Akeneo’s core tables.
- Are there alternatives to CustomEntityBundle for Laravel?
- For Laravel-only projects, consider Spatie’s `laravel-medialibrary` for media entities, `spatie/laravel-permission` for role-based data, or custom Eloquent models with policies. Akeneo’s bundle is PIM-specific and not interchangeable.
Weaver
How can I help you explore Laravel packages today?