Skip to the content
Documentation

Recently added

Recent ratings Recent changes Recent comments Atom feed

26465 added pages

Saturday May 11 2024

  1. Implementation of a filtering hook Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    A filter decides, for each publication, whether it goes through the publishing queue. It is a class that extends the abstract class ezpAsynchronousPublishingFilter (in kernel/private/classes/), which implements ezpAsynch…

  2. postHandling hook Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    A postHandling hook is called by the daemon right after it has handled a queued draft, whether the publication finished or not. Use it, for example, to remove what a preQueue hook recorded, or to notify another system. C…

  3. preQueue hook Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    A preQueue hook is called just before a draft is added to the publishing queue, in the editor's request. Use it to record what you need to know about the publication later, such as its class, its author or where it comes…

  4. queueReader handler Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    The queue reader decides which queued draft the daemon publishes next. The shipped reader, ezpContentPublishingQueue, takes the oldest pending draft, leaving out drafts of an object that has another version being publish…

  5. Configuring the token expiry time Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Access tokens and refresh tokens expire after a time set in rest.ini [OAuthSettings]: # settings/override/rest.ini.append.php [OAuthSettings] # lifetime of an access token in seconds (default: one hour) TokenTTL=3600 # l…

  6. OAUTH administration - register the new application Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Before an application can ask users for authorization, an administrator registers it. Open Setup > oAuth admin (/oauthadmin/list). Click New application . Enter the Name users will see when they authorize it, a Descripti…

  7. Overriding the OAUTH log-in page layout template Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    The page on which a user signs in and authorizes an OAuth application (oauth/authorize) is rendered with its own page layout, oauthloginpagelayout.tpl, not the site's normal page layout. The body comes from oauth/authori…

  8. The authentication process Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    An application gets a token for a user in four steps (the OAuth 2.0 authorization code grant). 1. Send the user to the authorize page https://www.example.com/oauth/authorize?client_id=<client id>&redirect_uri=<endpoint U…

  9. Conclusion Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    With a provider, a view controller, a controller and one line in rest.ini, an extension answers its own REST routes, with authentication, versions and JSON from the kernel. Before you ship it, check: Permissions : every…

  10. Step 1: Understanding the REST URI pattern Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Every REST address has the same shape: https://www.example.com/api/ezp/v2/content/node/2 | | | | | | | the route of the provider | | the version (v + a number; optional for a provider that has unversioned routes) | the p…

  11. Step 2: Understanding REST API versioning Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Every route is registered for one or more versions with ezpRestVersionedRoute. A request for /api/<provider>/v2/... only matches the routes registered for version 2. This lets a provider change an answer in a new version…

  12. Step 3: Extending the REST API Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    This example adds GET /api/myapi/v1/hello/:name, which answers {"greeting":"Hello, <name>"}, in the extension myapi. 1. The provider <?php // extension/myapi/classes/myapirestprovider.php class myApiRestProvider implemen…

  13. List of services Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    The services of the content API. All paths are below /api/ezp/v1 or /api/ezp/v2; writes exist only in v2. Content node service : GET /content/node/<id> Content object service : GET /content/object/<id> Content list servi…

  14. Re: Re: For an speed boost and lowering number of fetches... Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Historical. Comments that readers left on the eZ Publish documentation of this topic, kept for reference. They describe earlier versions and are not maintained; the current page for Exponential 6 is Outputting node and o…

  15. Re: How to modify an array element?? / How to modify an a... Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Historical. Comments that readers left on the eZ Publish documentation of this topic, kept for reference. They describe earlier versions and are not maintained; the current page for Exponential 6 is Variable usage .

  16. Re: How I got overrides to work / How I got overrides to ... Updated

    · Technical manual 6.x · Added 04:12 am · Written by Graham Brookins

    Historical. Comments that readers left on the eZ Publish documentation of this topic, kept for reference. They describe earlier versions and are not maintained; the current page for Exponential 6 is Template override exa…

  17. AppendLastModifiedTime Updated

    · User manual 6.x · Added 04:12 am · Written by Graham Brookins

    This chapter moved. Its content is now part of ezjscore.ini settings . This page described [Packer] AppendLastModifiedTime, which puts the time of the last change into the name of a packed file. It is enabled by default…

  18. CustomHosts Updated

    · User manual 6.x · Added 04:12 am · Written by Graham Brookins

    This chapter moved. Its content is now part of ezjscore.ini settings . This page described [Packer] CustomHosts[], other hosts to serve the packed files from. Read more ezjscore.ini settings ezjscore.ini [Packer]

  19. ExternalScripts Updated

    · User manual 6.x · Added 04:12 am · Written by Graham Brookins

    This chapter moved. Its content is now part of ezjscore.ini settings . This page described [eZJSCore] ExternalScripts[], the outside addresses of the jQuery files. The YUI entries were removed in ezjscore 1.5. Read more…

  20. LoadFromCDN Updated

    · User manual 6.x · Added 04:12 am · Written by Graham Brookins

    This chapter moved. Its content is now part of ezjscore.ini settings . This page described [eZJSCore] LoadFromCDN, which loads the jQuery files from outside addresses. It is disabled by default. Read more ezjscore.ini se…