api-client-php/doc/index.md

Documentation

• Dealing with civicrm/composer-compile-plugin prompts
  • Disable compilation prompts during the installation
  • I've chosen something else, now API client doesn't work!
  • Disabling compilation prompts manually
• Client structure
  • Design principles
  • Resource groups
• Usage
  • Instantiation
  • Sending a request
    • Choosing correct resource group, DTOs, and method
    • Sending a request
    • Dealing with exceptions
  • Error handling
  • Examples
    • How to create an order
    • How to receive the list of orders
    • How to handle all Client's exceptions
  • Event handling
• Customization
  • Controlling HTTP abstraction layer
  • Customizing request and response processing
    • Using a predefined handler
      • Built-in handlers
      • Modifying the default pipeline
      • Constructing the pipeline from scratch
    • Implementing a handler
  • Implementing custom API methods
• Troubleshooting
• PHPDoc