You are here

interface RemoteManagerInterface in Entity Share 8.3

Same name and namespace in other branches
  1. 8 modules/entity_share_client/src/Service/RemoteManagerInterface.php \Drupal\entity_share_client\Service\RemoteManagerInterface
  2. 8.2 modules/entity_share_client/src/Service/RemoteManagerInterface.php \Drupal\entity_share_client\Service\RemoteManagerInterface

Remote manager interface methods.

Hierarchy

Expanded class hierarchy of RemoteManagerInterface

All classes that implement RemoteManagerInterface

4 files declare their use of RemoteManagerInterface
DiffGeneratorPluginBase.php in modules/entity_share_diff/src/DiffGenerator/DiffGeneratorPluginBase.php
EntityParser.php in modules/entity_share_diff/src/Service/EntityParser.php
EntityShareClientCommands.php in modules/entity_share_client/src/Commands/EntityShareClientCommands.php
PullForm.php in modules/entity_share_client/src/Form/PullForm.php

File

modules/entity_share_client/src/Service/RemoteManagerInterface.php, line 12

Namespace

Drupal\entity_share_client\Service
View source
interface RemoteManagerInterface {

  /**
   * Performs a HTTP request. Wraps the HTTP client.
   *
   * We need to override this method during tests to emulate another website.
   *
   * @param \Drupal\entity_share_client\Entity\RemoteInterface $remote
   *   The remote website on which to perform the request.
   * @param string $method
   *   HTTP method.
   * @param string $url
   *   URL to request.
   *
   * @return \Psr\Http\Message\ResponseInterface
   *   The response.
   *
   * @see \GuzzleHttp\ClientInterface::request()
   */
  public function request(RemoteInterface $remote, $method, $url);

  /**
   * Performs a HTTP request on a JSON:API endpoint. Wraps the HTTP client.
   *
   * We need to override this method during tests to emulate another website.
   *
   * @param \Drupal\entity_share_client\Entity\RemoteInterface $remote
   *   The remote website on which to perform the request.
   * @param string $method
   *   HTTP method.
   * @param string $url
   *   URL to request.
   *
   * @return \Psr\Http\Message\ResponseInterface
   *   The response.
   *
   * @see \GuzzleHttp\ClientInterface::request()
   */
  public function jsonApiRequest(RemoteInterface $remote, $method, $url);

  /**
   * Get the channels infos of a remote website.
   *
   * @param \Drupal\entity_share_client\Entity\RemoteInterface $remote
   *   The remote website on which to get the channels infos.
   *
   * @return array
   *   Channel infos as returned by entity_share_server entry point.
   */
  public function getChannelsInfos(RemoteInterface $remote);

  /**
   * Get the field mappings of a remote website.
   *
   * @param \Drupal\entity_share_client\Entity\RemoteInterface $remote
   *   The remote website on which to get the field mappings.
   *
   * @return array
   *   Field mappings as returned by entity_share_server entry point.
   */
  public function getfieldMappings(RemoteInterface $remote);

}

Members

Namesort descending Modifiers Type Description Overrides
RemoteManagerInterface::getChannelsInfos public function Get the channels infos of a remote website. 1
RemoteManagerInterface::getfieldMappings public function Get the field mappings of a remote website. 1
RemoteManagerInterface::jsonApiRequest public function Performs a HTTP request on a JSON:API endpoint. Wraps the HTTP client. 1
RemoteManagerInterface::request public function Performs a HTTP request. Wraps the HTTP client. 1