apie/apie-bundle

Composer package of the apie library: apie bundle

dev-main 2025-03-18 22:51 UTC

Requires

• php: >=8.3
• apie/common: dev-main
• apie/core: dev-main
• symfony/config: ^7.2
• symfony/dependency-injection: ^7.2
• symfony/finder: ^7.2
• symfony/http-kernel: ^7.2
• symfony/psr-http-message-bridge: ^7.2
• symfony/routing: ^7.2

Requires (Dev)

• apie/cms: dev-main
• apie/cms-layout-graphite: dev-main
• apie/console: dev-main
• apie/country-and-phone-number: dev-main
• apie/faker: dev-main
• apie/fixtures: dev-main
• apie/rest-api: dev-main
• apie/text-value-objects: dev-main
• doctrine/persistence: ^3.1.0
• league/openapi-psr7-validator: 0.22
• phpspec/prophecy-phpunit: ^2.2
• phpunit/phpunit: ^11.5.2
• symfony/framework-bundle: ^7.2
• symfony/security-bundle: ^7.2
• symfony/twig-bundle: ^7.2
• symfony/validator: ^7.2

Suggests

• apie/cms: Access domain object actions in a fully working admin panel to your application
• apie/console: Access domain object actions by symfony console
• apie/doctrine-entity-datalayer: Store domain objects by using generated doctrine entities internally
• apie/rest-api: Access domain object actions in a fully working REST API to your application

MIT

• Pieter Jordaan

README

apie-bundle

This package is part of the Apie library. The code is maintained in a monorepo, so PR's need to be sent to the monorepo

Documentation

Include this package in a Symfony application and you can use apie in a Symfony application.

Configuration

If Symfony flex is installed requiring this package will register ApieBundle and install apie.yaml inside config/packages. In apie.yaml you can configure your Apie application.

Recommended Symfony bundles.

Apie/cms uses CSRF for form submits, however CSRF is a setting inside the Symfony framework bundle. Some settings are also required from the security bundle. Technically you can run Apie without these generic Symfony bundles, but it's recommended not to run Apie without the framework bundle and security bundle enabled. The Doctrine Bundle is also not a hard requirement even if you use apie/doctrine-entity-datalayer package for storing Apie resources.

Doctrine bundle linking

Apie creates his own Dotrine entity manager if using the Doctrine Entity datalayer. Since this one is not managed by the Doctrine Bundle, you need to configure linking Apie with Doctrine. Doing so will make the doctrine console commands work with --em=apie_manager. Also if the Symfony webprofiler is installed you can see all the queries that Apie executed in the request.

Apie's default value is to link it with the Doctrine Bundle if the DoctrineBundle class exists. This linking can be disabled in apie.yaml with:

apie:
    enable_doctrine_bundle_connection: false

Without the Doctrine bundle, a programmer has to configure his own setting for database migrations. It's not recommended to enable the automatic database migrations in production.

apie/cms customization

TODO

Changing logo and other files

TODO

Overwrite apie/cms templates

TODO