class ImportContext in Entity Share 8.3

Class ImportContext.

Contains properties to store data during import.

@package Drupal\entity_share_client

Hierarchy

• class \Drupal\entity_share_client\ImportContext

11 files declare their use of ImportContext

AuthenticationTestBase.php in modules/entity_share_client/tests/src/Functional/AuthenticationTestBase.php

EntityShareAsyncWorker.php in modules/entity_share_async/src/Plugin/QueueWorker/EntityShareAsyncWorker.php

EntityShareClientCliService.php in modules/entity_share_client/src/Service/EntityShareClientCliService.php

EntityShareClientFunctionalTestBase.php in modules/entity_share_client/tests/src/Functional/EntityShareClientFunctionalTestBase.php

ImportService.php in modules/entity_share_client/src/Service/ImportService.php

... See full list

File

modules/entity_share_client/src/ImportContext.php, line 14

Namespace

Drupal\entity_share_client

class ImportContext {

  /**
   * The remote ID.
   *
   * @var string
   */
  protected $remoteId;

  /**
   * The channel ID.
   *
   * @var string
   */
  protected $channelId;

  /**
   * The config import ID.
   *
   * @var string
   */
  protected $importConfigId;

  /**
   * The list of entity UUIDs to import (optional).
   *
   * @var string[]
   */
  protected $uuids;

  /**
   * The offset on a JSON:API endpoint (optional).
   *
   * @var int
   */
  protected $offset;

  /**
   * The limit of entities to display on a JSON:API endpoint (optional).
   *
   * @var int
   */
  protected $limit;

  /**
   * The count of entities on the remote channel (optional).
   *
   * @var string
   */
  protected $remoteChannelCount = '';

  /**
   * Constructor.
   *
   * @param string $remote_id
   *   The remote ID.
   * @param string $channel_id
   *   The channel ID.
   * @param string $import_config_id
   *   The import config ID.
   */
  public function __construct($remote_id, $channel_id, $import_config_id) {
    $this->remoteId = $remote_id;
    $this->channelId = $channel_id;
    $this->importConfigId = $import_config_id;
  }

  /**
   * Get remote ID.
   *
   * @return string
   *   The remote ID.
   */
  public function getRemoteId() {
    return $this->remoteId;
  }

  /**
   * Get channel ID.
   *
   * @return string
   *   The channel ID.
   */
  public function getChannelId() {
    return $this->channelId;
  }

  /**
   * Get import config ID.
   *
   * @return string
   *   The import config ID.
   */
  public function getImportConfigId() {
    return $this->importConfigId;
  }

  /**
   * Get UUIDs.
   *
   * @return string[]
   *   The UUIDs.
   */
  public function getUuids() {
    return $this->uuids;
  }

  /**
   * Set UUIDs.
   *
   * @param string[] $uuids
   *   The UUIDs.
   */
  public function setUuids(array $uuids) {
    $this->uuids = $uuids;
  }

  /**
   * Get offset.
   *
   * @return int
   *   The offset.
   */
  public function getOffset() {
    return $this->offset;
  }

  /**
   * Set offset.
   *
   * @param int $offset
   *   The offset.
   */
  public function setOffset(int $offset) {
    $this->offset = $offset;
  }

  /**
   * Get limit.
   *
   * @return int
   *   The limit.
   */
  public function getLimit() {
    return $this->limit;
  }

  /**
   * Set limit.
   *
   * @param int $limit
   *   The limit.
   */
  public function setLimit(int $limit) {
    $this->limit = $limit;
  }

  /**
   * Get remote channel count.
   *
   * @return string
   *   The remote channel count.
   */
  public function getRemoteChannelCount() {
    return $this->remoteChannelCount;
  }

  /**
   * Set remote channel count.
   *
   * @param string $remote_channel_count
   *   The remote channel count.
   */
  public function setRemoteChannelCount(string $remote_channel_count) {
    $this->remoteChannelCount = $remote_channel_count;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ImportContext::$channelId	protected	property	The channel ID.
ImportContext::$importConfigId	protected	property	The config import ID.
ImportContext::$limit	protected	property	The limit of entities to display on a JSON:API endpoint (optional).
ImportContext::$offset	protected	property	The offset on a JSON:API endpoint (optional).
ImportContext::$remoteChannelCount	protected	property	The count of entities on the remote channel (optional).
ImportContext::$remoteId	protected	property	The remote ID.
ImportContext::$uuids	protected	property	The list of entity UUIDs to import (optional).
ImportContext::getChannelId	public	function	Get channel ID.
ImportContext::getImportConfigId	public	function	Get import config ID.
ImportContext::getLimit	public	function	Get limit.
ImportContext::getOffset	public	function	Get offset.
ImportContext::getRemoteChannelCount	public	function	Get remote channel count.
ImportContext::getRemoteId	public	function	Get remote ID.
ImportContext::getUuids	public	function	Get UUIDs.
ImportContext::setLimit	public	function	Set limit.
ImportContext::setOffset	public	function	Set offset.
ImportContext::setRemoteChannelCount	public	function	Set remote channel count.
ImportContext::setUuids	public	function	Set UUIDs.
ImportContext::__construct	public	function	Constructor.