Weave Code
Layouts Contentful Laravel Package
netgen/layouts-contentful
Netgen Layouts Contentful integrates Contentful CMS with Netgen Layouts, letting you use Contentful entries as dynamic content sources and render queried Contentful content within your layouts alongside existing providers.
Netgen Layouts & Contentful integration
Frequently asked questions about Layouts Contentful
- What does netgen/layouts-contentful do?
- It is an adapter that connects Contentful to Netgen Layouts, a Symfony-based layout composition engine. It maps Contentful content types to Layouts block definitions and resolves entries through the Contentful Delivery API at render time, so editors keep page structure in Layouts and content in Contentful. It is a thin translation layer rather than a second CMS, and it is only useful if your application already runs Netgen Layouts.
- How do I install netgen/layouts-contentful?
- Install it with Composer alongside an existing Netgen Layouts setup, typically netgen/layouts-core plus layouts-standard or layouts-ui. You then register the bundle, configure the Contentful client (space ID, environment and CDA token) and declare a block definition for each Contentful content type you want to expose. Item view templates are supplied by your application, so expect real configuration work rather than a drop-in install.
- Does netgen/layouts-contentful work with Laravel?
- No. Netgen Layouts is a Symfony package and this integration inherits that, so it targets Symfony applications rather than Laravel. There is no Laravel service provider or Laravel-specific API here. If your project is Laravel, adopting this means adopting the whole Layouts engine first, which is a much bigger decision than adding a Contentful client.
- Which Netgen Layouts, Symfony and PHP versions are supported?
- The package follows Layouts' own platform requirements, so it expects PHP 8.x and a compatible Symfony version. Exact constraints should be read from the package's composer.json, because the Layouts block-definition API has moved across major releases and the integration is version-coupled to it. Confirm an active release branch matches your Layouts major version before committing.
- Does it support the Contentful Preview and Management APIs?
- The integration is built around the Contentful Delivery API, which is what it needs to resolve entries at render time. Coverage of the Preview API for editor preview and the Management API is not clearly documented and should be verified before you rely on it. If you need preview or cache warming, plan on writing that layer yourself.
- How are Contentful references, linked assets and include depth handled?
- The adapter can only resolve what its query layer exposes, so Contentful's link model is the usual friction point. Deeply nested references, cross-space links and unusual include-depth requirements may need custom block definitions rather than configuration. Extending resolution without forking is only possible if the query layer is exposed in a way you can hook into.
- How do I render Contentful rich text fields?
- Rich text rendering is typically application code, not something this package supplies. Contentful returns rich text as a structured node tree, so you write a renderer that walks the nodes and produces HTML inside your item view templates. Budget for that work up front, especially if you support embedded entries and assets inside rich text.
- How does caching work, and can a Contentful webhook purge it?
- The package resolves entries at render time, so caching and invalidation are largely your responsibility. It may reuse Layouts' resolver cache, but deterministic invalidation through a Contentful webhook (publish or unpublish to cache purge) is something you will likely have to build. Plan the webhook-to-purge path before launch rather than after editors start noticing stale content.
- Is netgen/layouts-contentful production-ready and actively maintained?
- Adoption signals are weak: roughly eleven GitHub stars, zero dependents and a low composite score, meaning little external test base and no community pressure on edge cases. It is effectively single-vendor and maintained by Netgen alongside Layouts core. It can work in production, but treat it as vendor-supported glue you may need to fork, and confirm with Netgen whether commercial support covers this specific package.
- Do I need Netgen Layouts already, or are there alternatives?
- You need Netgen Layouts already; this package is not a reason to adopt the layout engine, it is a downstream dependency of that decision. If you are not on Layouts, the simpler alternative is pulling Contentful content with the Contentful PHP SDK inside a controller or Twig extension. If you are on Layouts, the alternative is writing your own block definitions and query loader, which is roughly the work this package saves you.
Weaver
How can I help you explore Laravel packages today?