The Poetry Client Library aims to hide Poetry service complexity behind and easy-to-use client library so that users don't have to worry about building their own request messages nor about implementing any sort of SOAP interaction.
The library is build around the following main components:
- Poetry factory object: it's responsible for initializing and orchestrating all services and dependencies. The factory object also allows services to be easily configured by the host application. This is the main entry point for host applications.
- Messages: they are responsible for building and validating request and status messages.
- Client: it's responsible for sending a request message to the Poetry service.
- Server notifications: notifications coming from the Poetry Server will be turned into events that host applications can subscribe to.
After having properly configured the Poetry factory object library users will be able to perform the following operations:
- Build and send message objects.
- Subscribe and handle Poetry service notifications.
The Poetry Client Library depends on the following projects:
- Pimple: a simple PHP Dependency Injection Container, it is used to instantiate services and manage object dependency and configuration.
- Plates: a lightweight, native PHP template system that is used to render messages into SOAP XML payload.
- Symfony Event Dispatcher: allows to dispatch and subscribe to events.
- Symfony Validator: provides tools to validate message objects and their components.
- Symfony DomCrawler: provides components to ease DOM navigation for HTML and XML documents.