When contributing code to Akeneo PIM, you must follow its code conventions (very close to Symfony Code conventions).
This is part of our Developer eXperience effort, writing these conventions allows us to share the path we want to follow to continuously improve our codebase.
There are still inconsistencies in the codebase that we’re fixing in the upcoming minor releases.
We’ll keep on enhancing this section.
Akeneo or Pim, Bundle or Component?¶
Since version 1.3, Akeneo PIM introduced components, that contain business logic or technical logic not coupled with Symfony Framework, although Bundles contain the glue to assemble components together.
We use different namespaces, Akeneo for the technical parts not coupled with the PIM, Pim for the Community Edition parts and Enterprise suffix for the Enterprise Edition parts.
We organise the code as above in any new development and try to update legacy code as much as we can in each minor version to make the stack more and more understandable.
Classic folders are:
Controllers are implemented in the /Controller directory. We created also a /Rest directory inside the /Controller directory to have all the REST Controller in the same directory.
We define them as services, these classes don’t extend the BaseController and are not ContainerAware.
Entities are defined in Component under the /Model directory.
An Interface is created for each model and, from outside, we rely only on the interface.
Repository Interfaces are defined in Component under /Repository directory
The implementations of Repositories (Doctrine ORM) are located in Bundle in:
Except classes from Doctrine/Common, we should never use Doctrine classes in a class which is not located in /Doctrine.
SaverInterface & RemoverInterface¶
We never use ObjectManager persist/remove/flush except in SaverInterface and RemoverInterface.
It allows use to decouple the business code of component from the ORM code.
We define the services in several files depending on the service purpose (form type, etc.).
In each of these, a service is named with the following convention:
For example, the product saver service is
You can have several directories separated by a dot like
Parameters are defined in the same file, the convention used is the same as the one for services, with a
The parameter for the product saver service class is
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!