Public API Cookbook
The public API will give you an easy access to the eZ Platform content repository. This repository is the core component that manages content, Locations, Sections, Content Types, Users, User groups, and Roles. It also provides a new, clear interface for plugging in custom Field Types.
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.
About this Cookbook
The objective of this Public API Cookbook is to progressively guide you through useful, everyday business logic, using the API in concrete recipes: obtaining a Location from a Content item, fetching a set of Content items, creating a User, and so on.
For each recipe, newly introduced elements will be explained in detail, including the required API components (services, value objects, etc.).
Did we forget an important recipe ?
Let us know in the comments.
Suggested tools
In addition to this cookbook, we strongly recommend that you use a full featured PHP IDE, such as Eclipse or PHPStorm. It will provide you 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:
In this section
- 1. Getting started In this chapter, we will see two ways of customizing eZ Platform: command line scripts (for import scripts, for instance), and custom controllers, the eZ Platform equivalent of Exponential 4.x custom modules.
- 2. Browsing, finding, viewing We will start by going through the various ways to find and retrieve content from eZ Platform using the API. While this will be covered in further dedicated documentation, it is necessary to explain a few basic concepts of the Public API. In the following recipes, you will learn about the general pr
- 2. Browsing, finding, viewing We will start by going through the various ways to find and retrieve content from eZ Platform using the API. While this will be covered in further dedicated documentation, it is necessary to explain a few basic concepts of the Public API. In the following recipes, you will learn about the general pr
- 2. Browsing, finding, viewing We will start by going through the various ways to find and retrieve content from eZ Platform using the API. While this will be covered in further dedicated documentation, it is necessary to explain a few basic concepts of the Public API. In the following recipes, you will learn about the general pr
- 2. Browsing, finding, viewing We will start by going through the various ways to find and retrieve content from eZ Platform using the API. While this will be covered in further dedicated documentation, it is necessary to explain a few basic concepts of the Public API. In the following recipes, you will learn about the general pr
- 2. Browsing, finding, viewing We will start by going through the various ways to find and retrieve content from eZ Platform using the API. While this will be covered in further dedicated documentation, it is necessary to explain a few basic concepts of the Public API. In the following recipes, you will learn about the general pr
- 2. Browsing, finding, viewing We will start by going through the various ways to find and retrieve content from eZ Platform using the API. While this will be covered in further dedicated documentation, it is necessary to explain a few basic concepts of the Public API. In the following recipes, you will learn about the general pr
- 3. Managing Content In the following recipes, you will see how to create Content, including complex fields like XmlText or Image. Identifying to the repository with a login a...
- 3. Managing Content In the following recipes, you will see how to create Content, including complex fields like XmlText or Image. Identifying to the repository with a login a...
- 4. Working with Locations Adding a new Location to a Content item Full code https://github.com/ezsystems/CookbookBundle/blob/master/Command/AddLocationToContentCommand.php We...
- 5. Other recipes Assigning Section to content Full code https://github.com/ezsystems/CookbookBundle/tree/master/Command/AssignContentToSectionCommand.php The Section...
- 5. Other recipes Assigning Section to content Full code https://github.com/ezsystems/CookbookBundle/tree/master/Command/AssignContentToSectionCommand.php The Section...
- 5. Other recipes Assigning Section to content Full code https://github.com/ezsystems/CookbookBundle/tree/master/Command/AssignContentToSectionCommand.php The Section...
Contributors
- Christian Bacher
- Dominika Kurek Updated
Comments
Add a comment