class DeployRemoteCcServiceRestJSON in Deploy - Content Staging 7.3

Class for calling Rest Service.

Hierarchy

• class \DeployServiceRest implements DeployService
  • class \DeployRemoteCcServiceRestJSON

1 string reference to 'DeployRemoteCcServiceRestJSON'

deploy_remote_cc_deploy_services in modules/deploy_remote_cc/deploy_remote_cc.module

Implements hook_deploy_services().

File

modules/deploy_remote_cc/plugins/DeployRemoteCcServiceRestJSON.inc, line 13

class DeployRemoteCcServiceRestJSON extends \DeployServiceRest {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $config = array()) {
    parent::__construct($config);

    // Clearing caches takes time overriding the default value.
    $this->config['timeout'] = 120.0;
  }

  /**
   * {@inheritdoc}
   */
  public function deploy(\Traversable $entities) {
    foreach ($entities->entities as $entity) {
      $this->config['headers']['Content-Type'] = 'application/json';

      // We only want the scheme and host part of any saved URL.
      $url = parse_url($this->config['url']);
      $url = $url['scheme'] . "://" . $url['host'] . "/";
      $url .= $entities
        ->buildPath(array(
        $entity,
      ));
      $this
        ->httpRequest($url, 'PUT');
    }
  }

  /**
   * Provides access to the context to be able to use it elsewhere.
   *
   * The fetchContext() function is protected however it would be useful to be
   * able to use it outside of the class.
   *
   * @return resource
   *   The stream context resource.
   */
  public function getContext() {
    return parent::fetchContext();
  }

  /**
   * Make a HTTP request.
   *
   * @param string $url
   *   The URL to use for the request.
   * @param string $method
   *   The method of request, 'GET', 'POST' or 'PUT'.
   * @param null|array $data
   *   The data to send with the request.
   *
   * @return mixed
   *   The data retrieved from the request.
   *
   * @throws \DeployServiceException
   *   Will throw a DeployServiceException if there are any issues with the
   *   http request.
   */
  public function httpRequest($url, $method, $data = NULL) {
    $this->config['headers']['Content-Type'] = 'application/json';
    $options = array(
      'method' => $method,
      'headers' => $this->config['headers'],
      'data' => $data,
      'context' => $this->config['context'],
      'timeout' => (double) $this->config['timeout'],
    );
    if ($this->config['debug']) {
      watchdog('deploy', 'Service request: %url <pre>@options</pre>', array(
        '%url' => $url,
        '@options' => print_r($options, TRUE),
      ), WATCHDOG_DEBUG);
    }
    $response = drupal_http_request($url, $options);
    if ($this->config['debug']) {
      watchdog('deploy', 'Service response: <pre>@response</pre>', array(
        '@response' => print_r($response, TRUE),
      ), WATCHDOG_DEBUG);
    }
    if (isset($response->error) || !in_array($response->code, array(
      200,
      304,
    ))) {
      throw new \DeployServiceException(t('Service error: @code @error', array(
        '@code' => $response->code,
        '@error' => $response->error,
      )));
    }
    return drupal_json_decode($response->data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DeployRemoteCcServiceRestJSON::deploy	public	function	Deploy all entities in the $iterator. This method should only move entities over to the endpoint and create unpublished revisions (if supported). The 'publish' method is responsible for publishing all successfully deployed entities. Overrides DeployServiceRest::deploy
DeployRemoteCcServiceRestJSON::getContext	public	function	Provides access to the context to be able to use it elsewhere.
DeployRemoteCcServiceRestJSON::httpRequest	public	function	Make a HTTP request. Overrides DeployServiceRest::httpRequest
DeployRemoteCcServiceRestJSON::__construct	public	function	Constructor for a service plugin. Overrides DeployServiceRest::__construct
DeployServiceRest::$config	public	property	Configuration options.
DeployServiceRest::$headers	public	property	An associative array of http headers for the REST request.
DeployServiceRest::configForm	public	function	Configuration form. Overrides DeployService::configForm
DeployServiceRest::fetchContext	protected	function	Fetches the context for the HTTP request.
DeployServiceRest::publish	public	function	Publish all entities in the $iterator. This method should only publish entities on the endpoint (if supported). The 'deploy' method is responsible for moving the entities to the endpoint, prior to the publishing. Overrides DeployService::publish	1