You are here

interface LingotekModerationSettingsFormInterface in Lingotek Translation 3.8.x

Same name and namespace in other branches
  1. 8.2 src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  2. 4.0.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  3. 3.0.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  4. 3.1.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  5. 3.2.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  6. 3.3.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  7. 3.4.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  8. 3.5.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  9. 3.6.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface
  10. 3.7.x src/Moderation/LingotekModerationSettingsFormInterface.php \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface

Workbench moderation settings form helper.

@package Drupal\lingotek\Moderation

Hierarchy

Expanded class hierarchy of LingotekModerationSettingsFormInterface

All classes that implement LingotekModerationSettingsFormInterface

1 file declares its use of LingotekModerationSettingsFormInterface
LingotekModerationFactoryTest.php in tests/src/Unit/Moderation/LingotekModerationFactoryTest.php

File

src/Moderation/LingotekModerationSettingsFormInterface.php, line 10

Namespace

Drupal\lingotek\Moderation
View source
interface LingotekModerationSettingsFormInterface extends LingotekModerationServiceInterface {

  /**
   * Gets the column header title.
   *
   * @return string
   *   The column header title.
   */
  public function getColumnHeader();

  /**
   * Checks if there is a need for a moderation column.
   *
   * @param string $entity_type_id
   *   The entity type id.
   *
   * @return bool
   *   If the entity is enabled for moderation, return TRUE. FALSE otherwise.
   */
  public function needsColumn($entity_type_id);

  /**
   * Gets the moderation statuses.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle id.
   *
   * @return array
   *   Array with statuses ids as keys and label as value.
   */
  public function getModerationUploadStatuses($entity_type_id, $bundle);

  /**
   * Gets the default upload status.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle id.
   *
   * @return string
   *   The default status ID. If there is a setting, that will be returned.
   */
  public function getDefaultModerationUploadStatus($entity_type_id, $bundle);

  /**
   * Gets the default download transition.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle id.
   *
   * @return string
   *   The default transition ID. If there is a setting, that will be returned.
   */
  public function getModerationDownloadTransitions($entity_type_id, $bundle);

  /**
   * Gets the default transition.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle id.
   *
   * @return string
   *   The default transition ID. If there is a setting, that will be returned.
   */
  public function getDefaultModerationDownloadTransition($entity_type_id, $bundle);

  /**
   * Gets the subform for configuring the settings for a given bundle.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle id.
   *
   * @return array
   *   The array defining the form.
   */
  public function form($entity_type_id, $bundle);

  /**
   * Submit handler for saving the settings for a given bundle.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle id.
   * @param array $form_values
   *   The submitted form values.
   */
  public function submitHandler($entity_type_id, $bundle, array $form_values);

}

Members

Namesort descending Modifiers Type Description Overrides
LingotekModerationServiceInterface::applies public function Checks if this service applies.
LingotekModerationServiceInterface::setModuleHandler public function Sets the module handler for this service.
LingotekModerationSettingsFormInterface::form public function Gets the subform for configuring the settings for a given bundle. 3
LingotekModerationSettingsFormInterface::getColumnHeader public function Gets the column header title. 3
LingotekModerationSettingsFormInterface::getDefaultModerationDownloadTransition public function Gets the default transition. 3
LingotekModerationSettingsFormInterface::getDefaultModerationUploadStatus public function Gets the default upload status. 3
LingotekModerationSettingsFormInterface::getModerationDownloadTransitions public function Gets the default download transition. 3
LingotekModerationSettingsFormInterface::getModerationUploadStatuses public function Gets the moderation statuses. 3
LingotekModerationSettingsFormInterface::needsColumn public function Checks if there is a need for a moderation column. 3
LingotekModerationSettingsFormInterface::submitHandler public function Submit handler for saving the settings for a given bundle. 3