PHP Classes

File: includes/src/vendor/rmccue/requests/docs/hooks.md

Recommend this page to a friend!
  Classes of Subin Siby   Lobby   includes/src/vendor/rmccue/requests/docs/hooks.md   Download  
File: includes/src/vendor/rmccue/requests/docs/hooks.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Lobby
Web OS to install and run Web applications
Author: By
Last change: Lobby 1.0 Cobra
Date: 7 years ago
Size: 2,628 bytes
 

Contents

Class file image Download

Hooks

Requests has a hook system that you can use to manipulate parts of the request process along with internal transport hooks.

Check out the [API documentation for Requests_Hooks][requests_hooks] for more information on how to use the hook system.

Available Hooks

  • `requests.before_request`

    Alter the request before it's sent to the transport.

    Parameters: `string &$url`, `array &$headers`, `array|string &$data`, `string &$type`, `array &$options`

  • `requests.before_parse`

    Alter the raw HTTP response before parsing

    Parameters: `string &$response`

  • `requests.after_request`

    Alter the response object before it's returned to the user

    Parameters: `Requests_Response &$return`

  • `curl.before_request`

    Set cURL options before the transport sets any (note that Requests may override these)

    Parameters: `cURL resource &$fp`

  • `curl.before_send`

    Set cURL options just before the request is actually sent via `curl_exec`

    Parameters: `cURL resource &$fp`

  • `curl.after_request`

    Alter the raw HTTP response before returning for parsing

    Parameters: `string &$response, array &$info`

    `$info` contains the associated array as defined in curl-getinfo-returnvalues

  • `fsockopen.before_request`

    Run events before the transport does anything

  • `fsockopen.after_headers`

    Add extra headers before the body begins (i.e. before `\r\n\r\n`)

    Parameters: `string &$out`

  • `fsockopen.before_send`

    Add body data before sending the request

    Parameters: `string &$out`

  • `fsockopen.after_send`

    Run events after writing the data to the socket

  • `fsockopen.after_request`

    Alter the raw HTTP response before returning for parsing

    Parameters: `string &$response, array &$info`

    `$info` contains the associated array as defined in stream-get-meta-data-returnvalues

Registering Hooks

Note: if you're doing this in an authentication handler, see the [Custom Authentication guide][authentication-custom] instead.

[authentication-custom]: authentication-custom.md

In order to register your own hooks, you need to instantiate Requests_hooks and pass this in via the 'hooks' option.

$hooks = new Requests_Hooks();
$hooks->register('requests.after_request', 'mycallback');

$request = Requests::get('http://httpbin.org/get', array(), array('hooks' => $hooks));