interface CleanStateInterface in Feeds 8.3

Status of the clean phase of an import.

Hierarchy

• interface \Drupal\feeds\StateInterface
  • interface \Drupal\feeds\Feeds\State\CleanStateInterface extends \IteratorAggregate \Countable

3 files declare their use of CleanStateInterface

CleanableInterface.php in src/Plugin/Type/CleanableInterface.php

EntityProcessorBase.php in src/Feeds/Processor/EntityProcessorBase.php

FeedTest.php in tests/src/Kernel/Entity/FeedTest.php

File

src/Feeds/State/CleanStateInterface.php, line 13

Namespace

Drupal\feeds\Feeds\State

interface CleanStateInterface extends StateInterface, IteratorAggregate, Countable {

  /**
   * Returns if the list is initiated.
   *
   * @return bool
   *   True if the list was initiated, false otherwise.
   */
  public function initiated();

  /**
   * Sets the list of entity ID's.
   *
   * @param array $ids
   *   An array of entity ID's.
   */
  public function setList(array $ids);

  /**
   * Returns the list of entity ID's.
   *
   * @return array
   *   An array of entity ID's.
   */
  public function getList();

  /**
   * Removes a specific item from the list.
   *
   * @param mixed $entity_id
   *   The ID of the entity to remove.
   */
  public function removeItem($entity_id);

  /**
   * Returns the next entity in the list and removes the ID from the list.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   (optional) The entity storage.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   Returns the next the entity in the list, if found.
   */
  public function nextEntity(EntityStorageInterface $storage = NULL);

  /**
   * Sets the entity type ID of the entity ID's on the list.
   *
   * @param string $entity_type_id
   *   An entity type ID.
   */
  public function setEntityTypeId($entity_type_id);

  /**
   * Returns the entity type ID of the entity ID's on the list.
   *
   * @return string
   *   An entity type ID.
   */
  public function getEntityTypeId();

}

Members

Name	Modifiers	Type	Description	Overrides
CleanStateInterface::getEntityTypeId	public	function	Returns the entity type ID of the entity ID's on the list.	1
CleanStateInterface::getList	public	function	Returns the list of entity ID's.	1
CleanStateInterface::initiated	public	function	Returns if the list is initiated.	1
CleanStateInterface::nextEntity	public	function	Returns the next entity in the list and removes the ID from the list.	1
CleanStateInterface::removeItem	public	function	Removes a specific item from the list.	1
CleanStateInterface::setEntityTypeId	public	function	Sets the entity type ID of the entity ID's on the list.	1
CleanStateInterface::setList	public	function	Sets the list of entity ID's.	1
StateInterface::BATCH_COMPLETE		constant	Batch operation complete.
StateInterface::CLEAN		constant	Denotes the clean stage.
StateInterface::CLEAR		constant	Denotes the clear stage.
StateInterface::displayMessages	public	function	Shows the messages to the user.	1
StateInterface::EXPIRE		constant	Denotes the expire stage.
StateInterface::FETCH		constant	Denotes the fetch stage.
StateInterface::logMessages	public	function	Logs all messages.	1
StateInterface::PARSE		constant	Denotes the parse stage.
StateInterface::PROCESS		constant	Denotes the process stage.
StateInterface::progress	public	function	Reports the progress of a batch.	1
StateInterface::setCompleted	public	function	Immediately completes the batch.	1
StateInterface::setMessage	public	function	Sets a message to display to the user.	1
StateInterface::START		constant	The start time key.