class LingotekDocumentArchivedException in Lingotek Translation 3.2.x

An exception for issues when a document is already archived.

@package Drupal\lingotek\Exception

Hierarchy

• class \Drupal\lingotek\Exception\LingotekException extends \Drupal\lingotek\Exception\Exception
  • class \Drupal\lingotek\Exception\LingotekDocumentArchivedException

18 files declare their use of LingotekDocumentArchivedException

lingotek.batch.inc in ./lingotek.batch.inc

Lingotek batch functions

lingotek.module in ./lingotek.module

Implements Drupal-related hooks for the Lingotek Translation module.

Lingotek.php in src/Lingotek.php

LingotekConfigManagementForm.php in src/Form/LingotekConfigManagementForm.php

LingotekConfigTranslationController.php in src/Controller/LingotekConfigTranslationController.php

... See full list

File

src/Exception/LingotekDocumentArchivedException.php, line 10

Namespace

Drupal\lingotek\Exception

class LingotekDocumentArchivedException extends LingotekException {

  /**
   * The document id.
   *
   * @var string
   */
  protected $documentId;

  /**
   * Construct the exception. Note: The message is NOT binary safe.
   *
   * @param string $document_id
   *   The document id.
   * @param string $message
   *   (optional) The Exception message to throw.
   * @param int $code
   *   (optional) The Exception code.
   * @param \Throwable $previous
   *   (optional) The previous throwable used for the exception chaining.
   */
  public function __construct($document_id, $message = "", int $code = 0, \Throwable $previous = NULL) {
    parent::__construct($message, $code, $previous);
    $this->documentId = $document_id;
  }

  /**
   * Get the document id which was already archived.
   *
   * @return string
   */
  public function getDocumentId() {
    return $this->documentId;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekDocumentArchivedException::$documentId	protected	property	The document id.
LingotekDocumentArchivedException::getDocumentId	public	function	Get the document id which was already archived.
LingotekDocumentArchivedException::__construct	public	function	Construct the exception. Note: The message is NOT binary safe.