abstract class AcsfMessage in Acquia Cloud Site Factory Connector 8

AcsfMessage.

AcsfMessage defines a basic message interface between a Drupal site and the Site Factory. It is composed of a AcsfConfig compatible object which defines the location and credentials required to communicate with the Site Factory. There is one abstract method, which client code must implement: sendMessage(). This method is responsible for implementing the communication and returning an AcsfResponse object. This ensures that the client code has predictable input and output.

Invocation is simple, the following shows a working example of communicating via REST (using the AcsfMessageRest concrete class). Construction can be as simple as providing a method, endpoint and parameters. Additional arguments may be provided to customize the behavior - namely locating a special config file or providing an anonymous callback function.

$m = new AcsfMessageRest('GET', 'site-api/v1/sync/', [ 'site_id' => 406 ]); $m->send(); $m->getResponseCode(); $m->getResponseBody();

Hierarchy

• class \Drupal\acsf\AcsfMessage

5 files declare their use of AcsfMessage

AcsfMessageUnitTestFailure.inc in tests/AcsfMessageUnitTestFailure.inc

AcsfMessageUnitTestFailureException.inc in tests/AcsfMessageUnitTestFailureException.inc

AcsfMessageUnitTestMissingEndpoint.inc in tests/AcsfMessageUnitTestMissingEndpoint.inc

AcsfMessageUnitTestMissingResponse.inc in tests/AcsfMessageUnitTestMissingResponse.inc

AcsfMessageUnitTestSuccess.inc in tests/AcsfMessageUnitTestSuccess.inc

File

src/AcsfMessage.php, line 27

Namespace

Drupal\acsf

abstract class AcsfMessage {

  /**
   * The message endpoint on the remote server.
   *
   * @var string
   */
  protected $endpoint;

  /**
   * An unstructured list of parameters to send with the request.
   *
   * @var array
   */
  protected $parameters;

  /**
   * The AcsfMessageResponse object.
   *
   * @var \Drupal\acsf\AcsfMessageResponse
   */
  protected $response;

  /**
   * An optional Acquia Hosting sitegroup.
   *
   * @var string
   */
  protected $ahSite;

  /**
   * An optional Acquia Hosting environment.
   *
   * @var string
   */
  protected $ahEnv;

  /**
   * An optional AcsfConfig object.
   *
   * @var \Drupal\acsf\AcsfConfig
   */
  private $config;

  /**
   * Constructor.
   *
   * @param string $method
   *   The request method. e.g. POST, GET, PUT, etc.
   * @param string $endpoint
   *   The endpoint to contact on the remote server.
   * @param array $parameters
   *   The list of parameters to send with the request.
   * @param AcsfConfig $config
   *   (Optional) The configuration option.
   * @param string $ah_site
   *   (Optional) The Acquia Hosting sitegroup.
   * @param string $ah_env
   *   (Optional) The Acquia Hosting environment.
   * @param Closure $callback
   *   (Optional) An anonymous callback function.
   *
   * @throws AcsfMessageMissingCredsException
   */
  public function __construct($method, $endpoint, array $parameters = [], AcsfConfig $config = NULL, $ah_site = NULL, $ah_env = NULL, Closure $callback = NULL) {

    // Use our default config if not specified.
    if (empty($config)) {
      $config = new AcsfConfigDefault($ah_site, $ah_env);
    }
    $this->config = $config;
    $this->method = $method;
    $this->endpoint = $endpoint;
    $this->parameters = $parameters;
    $this->ahSite = $ah_site;
    $this->ahEnv = $ah_env;
    $this->callback = $callback;
  }

  /**
   * Sends the message to the remote server.
   */
  public function send() {
    if (function_exists('is_acquia_host') && !is_acquia_host()) {
      return;
    }
    $this->response = $this
      ->sendMessage($this->config
      ->getUrl(), $this->method, $this->endpoint, $this->parameters, $this->config
      ->getUsername(), $this->config
      ->getPassword());

    // Don't allow empty responses.
    if (empty($this->response)) {
      throw new AcsfMessageEmptyResponseException(sprintf('The message to %s resulted in an empty response.', $this->endpoint));
    }

    // Only allow AcsfMessageResponse compatible responses.
    if (!is_subclass_of($this->response, '\\Drupal\\acsf\\AcsfMessageResponse')) {
      throw new AcsfMessageMalformedResponseException(sprintf('The message to %s resulted in a malformed response. It should be an AcsfMessageResponse object.', $this->endpoint));
    }

    // If the response failed, throw an exception.
    if ($this->response
      ->failed()) {

      // The REST API returns error descriptions in the "message" field of the
      // response body.
      if (!empty($this->response->body['message'])) {
        $error_message = sprintf('The request to %s failed with HTTP error: %s %s.', $this->endpoint, $this->response->code, $this->response->body['message']);
      }
      else {
        $error_message = sprintf('The request to %s failed.', $this->endpoint);
      }
      throw new AcsfMessageFailedResponseException($error_message);
    }

    // Allow the implementer to respond right away.
    $this
      ->receiveResponse($this->response);

    // Allow an anonymous callback.
    if (!empty($this->callback)) {
      try {
        $callback = $this->callback;
        $callback($this->response);
      } catch (\Exception $e) {

        // @todo log here?
      }
    }
  }

  /**
   * Allows client code to optionally run logic after the response is received.
   */
  protected function receiveResponse(AcsfMessageResponse $response) {
  }

  /**
   * Retrieves the response body.
   */
  public function getResponseBody() {
    if (empty($this->response)) {
      return FALSE;
    }
    return $this->response->body;
  }

  /**
   * Retrieves the response code.
   */
  public function getResponseCode() {
    if (empty($this->response)) {
      return FALSE;
    }
    return $this->response->code;
  }

  /**
   * Sends a message to a remote server and implements a response object.
   *
   * @param string $url
   *   The URL of the remote service.
   * @param string $method
   *   The request method. e.g. POST, GET, PUT, etc.
   * @param string $endpoint
   *   The endpoint to call on the remote service.
   * @param array $parameters
   *   Parameters to send with the request.
   * @param string $username
   *   The remote username.
   * @param string $password
   *   The remote password.
   *
   * @return AcsfMessageResponse
   *   The message response instance.
   */
  protected abstract function sendMessage($url, $method, $endpoint, array $parameters, $username, $password);

}

Members

Name	Modifiers	Type	Description	Overrides
AcsfMessage::$ahEnv	protected	property	An optional Acquia Hosting environment.
AcsfMessage::$ahSite	protected	property	An optional Acquia Hosting sitegroup.
AcsfMessage::$config	private	property	An optional AcsfConfig object.
AcsfMessage::$endpoint	protected	property	The message endpoint on the remote server.
AcsfMessage::$parameters	protected	property	An unstructured list of parameters to send with the request.
AcsfMessage::$response	protected	property	The AcsfMessageResponse object.
AcsfMessage::getResponseBody	public	function	Retrieves the response body.
AcsfMessage::getResponseCode	public	function	Retrieves the response code.
AcsfMessage::receiveResponse	protected	function	Allows client code to optionally run logic after the response is received.
AcsfMessage::send	public	function	Sends the message to the remote server.
AcsfMessage::sendMessage	abstract protected	function	Sends a message to a remote server and implements a response object.	6
AcsfMessage::__construct	public	function	Constructor.	1