Httpful

Handlers are classes responsible for two main tasks: parsing response bodies and serializing request payloads.

To create a custom handler, you must extend the \Httpful\Handlers\MimeHandlerAdapter class and implement the following two methods:

1. serialize($payload): Converts a data structure (like an array) into a serialized format (like a string) to be used as the body of an outgoing request.
2. parse($body): Takes a raw response body (usually a string) and converts it into a usable data structure (like an array or object).

Once a handler is registered to a specific MIME type, Httpful will automatically use that handler for any requests or responses matching that type.

<?php

class SimpleCsvHandler extends \Httpful\Handlers\MimeHandlerAdapter
{
    public function parse($body)
    {
        return str_getcsv($body);
    }

    public function serialize($payload)
    {
        $serialized = '';
        foreach ($payload as $line) {
            $serialized .= '"' . implode('","', $line) . '"' . "\n";
        }
        return $serialized;
    }
}

Httpful::register('text/csv', new SimpleCsvHandler());

You can extend Httpful's functionality by implementing a custom handler for specific MIME types.

1. Create a class that extends \Httpful\Handlers\MimeHandlerAdapter.
2. Implement parse($body) to handle incoming response data.
3. Implement serialize($payload) to handle outgoing request data.
4. Register the handler using Httpful::register($mimeType, $handlerInstance).

Example of a CSV handler:

<?php

class SimpleCsvHandler extends \Httpful\Handlers\MimeHandlerAdapter
{
    /**
     * Takes a response body, and turns it into 
     * a two dimensional array.
     *
     * @param string $body
     * @return mixed
     */
    public function parse($body)
    {
        return str_getcsv($body);
    }

    /**
     * Takes a two dimensional array and turns it
     * into a serialized string to include as the 
     * body of a request
     *
     * @param mixed $payload
     * @return string
     */
    public function serialize($payload)
    {
        $serialized = '';
        foreach ($payload as $line) {
            $serialized .= '"' . implode('","', $line) . '"' . "\n";
        }
        return $serialized;
    }
}

// Register the handler for the text/csv mime type
Httpful::register('text/csv', new SimpleCsvHandler());