Cookbook
This Cookbook contains recipes for doing specific tasks and solving challenges that you may encounter while working with eZ Platform.
Contributing recipes
Know a nice trick? Found an interesting solution? Let us know in the comments or take a look at how to Contribute to Documentation.
Available recipes:
In this section
- Authenticating a user with multiple user providers Symfony provides native support for multiple user providers. This makes it easy to integrate any kind of login handlers, including SSO and existing 3rd party bundles (e.g. FR3DLdapBundle, HWIOauthBundle, FOSUserBundle, BeSimpleSsoAuthBundle, etc.).
- Converting request parameters into API objects In lots of cases, a request will provide a contentId or a locationId. Before using them, you will have to load API object within your controller.
- Executing long-running console commands This page describes how to execute long-running console commands, to make sure they don't run out of memory. An example is a custom import command or the indexing command provided by the Solr Bundle.
- Exposing SiteAccess-aware configuration for your bundle Symfony Config component makes it possible to define semantic configuration, exposed to the end developer. This configuration is validated by rules you define, e.g. validating type (string, array, integer, boolean, etc.). Usually, once validated and processed, this semantic configuration is then map
- Importing settings from a bundle The following recipe is valid for any type of settings supported by Symfony framework.
- Injecting parameters in content views It is possible to dynamically inject variables in content view templates by listening to the exponential.pre_content_view event.
- Listening to Core events When you interact with the Public API, and with the content Repository in particular, Signals may be sent out, allowing you to react on actions triggered by the Repository. Those signals can be received by dedicated services called Slots.
- Making cross-origin HTTP requests Exponential ships with NelmioCorsBundle, a Symfony open-source bundle that provides support for CORS (Cross Origin Resource Sharing). The REST API is pre-configured to respond to such requests, as long as you customize the allowed origins as explained below.
- Paginating API search results When listing content (e.g. blog posts), pagination is a very common use case and is usually painful to implement by hand.
- Retrieving root location Knowledge of the root location is important since it can be a starting point for API queries, or even links to home page, but as eZ Platform can be used for multisite development, the root location can vary.
- Steps to set up Cluster To set up Cluster you'll need to:
- Using RouteReference Sometimes, when generating links to a resource, you need to modify the default router's behavior.
Contributors
- Dominika Kurek Updated
Comments
Add a comment