Surfer\Adapter\AbstractAdapter

Complexity

Total Complexity

5

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	5

<?php

/**
 * @file AbstractAdapter.php
 * @brief This file contains the AbstractAdapter class.
 * @details
 * @author Filippo F. Fadda
 */


namespace Surfer\Adapter;


use Surfer\Message\Request;
use Surfer\Message\Response;
use Surfer\Hook\IChunkHook;


/**
 * @brief An abstract HTTP client adapter.
 * @nosubgrouping
 */
abstract class AbstractAdapter implements IClientAdapter {

  const DEFAULT_SERVER = "127.0.0.1:80"; //!< Default server.
  const DEFAULT_HOST = "127.0.0.1"; //!< Default host.
  const DEFAULT_PORT = 80; //!< Default port.

  const SCHEME_HOST_PORT_URI = '/^
	        (?P<scheme>tcp:\/\/|ssl:\/\/|tls:\/\/|http:\/\/|https:\/\/)? # Scheme
	        # Authority
	        (?P<host>[a-z0-9\-._~%]+                         # Named host
	        |     \[[a-f0-9:.]+\]                            # IPv6 host
	        |     \[v[a-f0-9][a-z0-9\-._~%!$&\'()*+,;=:]+\]) # IPvFuture host
	        (?P<port>:[0-9]+)?                               # Port
	        $/ix';

  // Used to know if the constructor has been already called.
  protected static $initialized = FALSE;

  protected $scheme;
  protected $host;
  protected $port;

  protected $userName;
  protected $password;

  // Stores the default ports used by the supported protocols.
  protected static $defaultPorts = array( // Cannot use [] syntax otherwise Doxygen generates a warning.
    'http://' => 80,
    'https://' => 443,
    'tcp://' => 80,
    'tls://' => 443,
    'ssl://' => 993
  );

  // URI specifying address of proxy server. (e.g. tcp://proxy.example.com:5100).
  //protected $proxy = NULL;

  // When set to TRUE, the entire URI will be used when constructing the request. While this is a non-standard request
  // format, some proxy servers require it.
  //protected $requestFullUri = FALSE;


  /**
   * @brief Creates a client adapter instance.
   * @param string $server Server must be expressed as host:port as defined by RFC 3986. It's also possible specify
   * a scheme like tcp://, ssl:// or tls://; if no scheme is present, tcp:// will be used.
   * @param string $userName (optional) User name.
   * @param string $password (optional) Password.
   * @see http://www.ietf.org/rfc/rfc3986.txt
   */
  public function __construct($server = self::DEFAULT_SERVER, $userName = "", $password = "") {

    // Parses the URI string '$server' to retrieve scheme, host and port and assigns matches to the relative class members.
    if (preg_match(self::SCHEME_HOST_PORT_URI, $server, $matches)) {
      $this->scheme = isset($matches['scheme']) ? $matches['scheme'] : "tcp://";
      $this->host = isset($matches['host']) ? $matches['host'] : self::DEFAULT_HOST;
      $this->port = isset($matches['port']) ? (int) substr($matches['port'], 1) : self::$defaultPorts[$this->scheme];
    }
    else // Match attempt failed.
      throw new \InvalidArgumentException(sprintf("'%s' is not a valid URI.", $server));

    $this->userName = (string)$userName;
    $this->password = (string)$password;
  }


  /**
   * @brief Initializes the client.
   * @details This method is called just once, when the first object instance is created. It's used to execute one time
   * operations due to initialize the client. Even if you create many instance of this client, this method is executed
   * just once, keep it in mind.
   */
  abstract public function initialize();



  /**
   * @brief Sets the maximum number of seconds the request will take to be performed.
   * @param int $seconds The timeout in seconds.
   * @return bool Returns `true` on success or `false` on failure.
   */
  abstract public function setTimeout($seconds);


  /**
   * @brief This method is used to send an HTTP Request.
   * @details You can also provide an instance of a class that implements the IChunkHook interface, to deal with a chunked
   * response.
   * @param Request $request The Request object.
   * @param IChunkHook $chunkHook (optional) A class instance that implements the IChunkHook interface.
   * @return Response
   */
  abstract public function send(Request $request, IChunkHook $chunkHook = NULL);

}