Public API Cookbook

The public API will give you = an easy access to the eZ Publish content repository. This repository is the= core component that manages content, locations (nodes in eZ Publish 4.x), = sections, content types (Content Classes in eZ Publish 4.x), users, user groups, and roles. It also provides a new, clear interface for = plugging in custom field types (datatypes in eZ Publish 4.x).

The public API i= s 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 wil= l be forward compatible with future releases based on enhanced, scalable an= d high-performance storage engines. Applications based on the public API ar= e also fully backwards compatible by using the included storage engine base= d on the current kernel and database model.

About this Cookbook

The objective o= f this Public API Cookbook is to progressively guide you through useful, ev= eryday business logic, using the API in concrete recipes: obtaining a Locat= ion from a Content, fetching a set of Content, creating a User, and so on.<= br>

For each recipe, newly introduced ele= ments will be explained in detail, including the required API components (s= ervices, value objects...).

Did we forget an important recipe ?

Let us know in the comments.

Suggested tools

In addition to this cookbook, we stro= ngly recommend that you use a full featured PHP IDE, such as Eclipse or Php= Storm. It will provide you information on every piece of code you use, incl= uding objects and classes documentation. We have paid very careful attentio= n to PHPDoc throughout this API, and such a tool is a very valuable help wh= en using this API.

On top of this, generated public API = documentation can be found online, in various formats:

doxygen: http://apidoc.ez.no/doxygen/trunk/NS/ht= ml/
sami: http://apidoc.ez.no/sami/trunk/NS/html/