The public API is built on top of a layered architecture, including a persistence API that abstracts storage. By using the public API, you are sure that your code will be forward compatible with future releases based on enhanced, scalable and high-performance storage engines. Applications based on the public API are also fully backwards compatible by using the included storage engine based on the current kernel and database model.
The objective of this Public API cookbook Cookbook is to progressively guide you through useful, everyday business logic, using the API in concrete recipes: obtaining a Location from a Content, fetching a set of Content, creating a User, and so on...
For each recipe, newly introduced elements will be explained in detailsdetail, including the required API components (services, value objects...).
Did we forget an important recipe ?
Let us know in the comments.
In addition to this cookbook, we strongly recommend that you use a full featured PHP IDE, such as Eclipse or PhpStorm. They It will provide you with information on every piece of code you use, including objects and classes documentation. We have paid very careful attention to PHPDoc throughout this API, and such a tool is a very valuable help when using this API.
On top of this, generated public API documentation can be found online, in various formats:
- phpDocumentordoxygen: http://ezsystemsapidoc.githubez.com/ezp-next/phpDocumentor/ doxygen: http://ezsystems.github.com/ezp-next/doxygen/no/doxygen/trunk/NS/html/
- sami: http://ezsystemsapidoc.githubez.comno/ezp-next/sami/trunk/NS/html/