class AcquiaPurgeExecutorRequest in Acquia Purge 7

Provides a single HTTP request.

Hierarchy

• class \AcquiaPurgeExecutorRequest implements AcquiaPurgeExecutorRequestInterface

File

lib/executor/AcquiaPurgeExecutorRequest.php, line 6

class AcquiaPurgeExecutorRequest implements AcquiaPurgeExecutorRequestInterface {

  /**
   * The cURL execution resource.
   *
   * @var null|resource
   */
  public $curl = NULL;

  /**
   * cURL error code.
   *
   * @var int
   */
  public $error_curl = '';

  /**
   * String useful for debugging or logging the request.
   *
   * @var string
   */
  public $error_debug = '';

  /**
   * Unassociative array with headers keys and values ("key: value").
   *
   * @var string[]
   */
  public $headers = array();

  /**
   * The HTTP request method, e.g.: 'GET', 'POST', 'PURGE' or 'BAN'.
   *
   * @var string
   */
  public $method = 'GET';

  /**
   * The HTTP response code.
   *
   * @var string
   */
  public $response_code = '';

  /**
   * The outcome of the HTTP request.
   *
   * @var bool
   */
  public $result = NULL;

  /**
   * The scheme to perform against, without '://': 'http' or 'https'.
   *
   * @var string
   */
  public $scheme = 'http';

  /**
   * The URL to connect to, e.g.: http://domain.com/path/a/b/c
   *
   * @var string
   */
  public $uri = '';

  /**
   * {@inheritdoc}
   */
  public function __construct($uri = NULL) {
    if (!is_null($uri)) {
      $this->uri = $uri;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AcquiaPurgeExecutorRequest::$curl	public	property	The cURL execution resource.
AcquiaPurgeExecutorRequest::$error_curl	public	property	cURL error code.
AcquiaPurgeExecutorRequest::$error_debug	public	property	String useful for debugging or logging the request.
AcquiaPurgeExecutorRequest::$headers	public	property	Unassociative array with headers keys and values ("key: value").
AcquiaPurgeExecutorRequest::$method	public	property	The HTTP request method, e.g.: 'GET', 'POST', 'PURGE' or 'BAN'.
AcquiaPurgeExecutorRequest::$response_code	public	property	The HTTP response code.
AcquiaPurgeExecutorRequest::$result	public	property	The outcome of the HTTP request.
AcquiaPurgeExecutorRequest::$scheme	public	property	The scheme to perform against, without '://': 'http' or 'https'.
AcquiaPurgeExecutorRequest::$uri	public	property	The URL to connect to, e.g.: http://domain.com/path/a/b/c
AcquiaPurgeExecutorRequest::__construct	public	function	Constructs a HTTP request object. Overrides AcquiaPurgeExecutorRequestInterface::__construct