interface StorageInterface in Checklist API 8

Provides an interface for checklist storage.

Hierarchy

• interface \Drupal\checklistapi\Storage\StorageInterface

File

src/Storage/StorageInterface.php, line 8

Namespace

Drupal\checklistapi\Storage

interface StorageInterface {

  /**
   * Sets the checklist ID.
   *
   * @param string $id
   *   The checklist ID.
   */
  public function setChecklistId($id);

  /**
   * Gets the saved checklist progress.
   *
   * @return mixed
   *   The stored value, or NULL if no value exists.
   */
  public function getSavedProgress();

  /**
   * Sets the saved checklist progress.
   *
   * @param array $progress
   *   An array of checklist progress data as built by ChecklistapiChecklist.
   */
  public function setSavedProgress(array $progress);

  /**
   * Deletes the saved checklist progress.
   */
  public function deleteSavedProgress();

}

Members

Name	Modifiers	Type	Description	Overrides
StorageInterface::deleteSavedProgress	public	function	Deletes the saved checklist progress.	2
StorageInterface::getSavedProgress	public	function	Gets the saved checklist progress.	2
StorageInterface::setChecklistId	public	function	Sets the checklist ID.	1
StorageInterface::setSavedProgress	public	function	Sets the saved checklist progress.	2