Weave Code
Extended Attribute Type Laravel Package
akeneo/extended-attribute-type
Extra attribute types for Akeneo PIM
Frequently asked questions about Extended Attribute Type
- Can I use akeneo/extended-attribute-type in a Laravel project without Symfony?
- No, this package is designed for Akeneo PIM (Symfony-based) and won’t work natively in Laravel. You’d need a Symfony bridge or rewrite Akeneo’s attribute system, which is high-effort. For Laravel, consider JSON columns or packages like `spatie/laravel-collection` instead.
- What Laravel alternatives exist for ordered string/URL collections?
- Laravel offers native solutions like JSON columns (`$table->json('text_collection')`) or packages such as `spatie/laravel-activitylog` for structured data. Avoid Akeneo’s dependency unless your product is built on Akeneo PIM. For ordered collections, `spatie/laravel-collection` or custom pivot tables work well.
- How do I install this package in Akeneo PIM Community Edition 2.2+?
- Run `composer require akeneo/extended-attribute-type:2.1`, register the bundle in `AppKernel.php`, and update `elasticsearch_index_configuration_files` in `pim_parameters.yml` to include the new configuration file. For fresh installs, follow Akeneo’s standard setup. Existing PIMs require Elasticsearch index resets.
- Will this package break if I upgrade Akeneo PIM to a newer version?
- The package’s last release was in 2018, so compatibility with Akeneo PIM v2.2+ isn’t guaranteed. Test thoroughly in a staging environment. Check Akeneo’s official extensions or maintained forks for updated versions. Deprecated packages may require manual patches.
- Do I need Elasticsearch for this package, and can I use Algolia instead?
- Yes, Elasticsearch is mandatory for Akeneo PIM’s search functionality. Algolia/Meilisearch won’t work directly. If avoiding Elasticsearch, consider rebuilding the attribute system in Laravel with a separate search layer, but this requires significant effort and may not replicate Akeneo’s features.
- How do I migrate existing Akeneo data to use TextCollection attributes?
- Backup Elasticsearch indexes and databases first. Clear caches with `php bin/console cache:clear --no-warmup --env=prod`, reset indexes with `akeneo:elasticsearch:reset-indexes`, and reindex products using `pim:product:index --all --env=prod`. Test in a non-production environment to avoid data loss during migration.
- Is this package suitable for dynamic metadata like FAQs or ingredient lists?
- Yes, the TextCollection attribute type is perfect for ordered, multi-value data like FAQs or ingredient lists. However, ensure your Akeneo PIM version supports it (v2.2+ for 2.1.x). For Laravel projects, native JSON columns or custom solutions may be simpler and more flexible.
- Can I use this package in Akeneo PIM Enterprise Edition (EE)?
- Yes, but you must include additional Elasticsearch configuration files in `pim_parameters.yml`, specifically `index_configuration_ee.yml`. Follow the EE-specific instructions in the README to register all required files. Test thoroughly in a staging environment before production.
- What risks should I consider before adopting this package?
- Key risks include Elasticsearch schema changes (backup data), Akeneo-specific code (high lock-in), and the package’s age (potential compatibility issues). Assess whether the TextCollection use case justifies the dependency. For Laravel, evaluate alternatives to avoid Symfony/Akeneo’s ecosystem.
- How do I troubleshoot Elasticsearch index reset failures?
- Start by verifying `elasticsearch_index_configuration_files` in `pim_parameters.yml` includes all required paths. Check Elasticsearch logs for errors during `akeneo:elasticsearch:reset-indexes`. If indexes fail to reset, manually delete them via Elasticsearch’s API or restore from a backup. Ensure your Akeneo and Elasticsearch versions are compatible.
Weaver
How can I help you explore Laravel packages today?