You are here

EntityLegalDocumentInterface.php in Entity Legal 8

File

src/Entity/EntityLegalDocumentInterface.php
View source
<?php

/**
 * @file
 * Contains \Drupal\entity_legal\Entity\EntityLegalDocumentInterface.
 */
namespace Drupal\entity_legal\Entity;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides interface for defining legal document entities.
 */
interface EntityLegalDocumentInterface extends ConfigEntityInterface {

  /**
   * Get the name of the current published version.
   *
   * @return string
   */
  public function getPublishedVersionName();

  /**
   * Get whether document acceptance is required on signup.
   *
   * @return bool
   */
  public function getNewUserRequirement();

  /**
   * Get whether document acceptance is required by existing users.
   *
   * @return bool
   */
  public function getExistingUserRequirement();

  /**
   * Get the plugin name for the new user acceptance.
   *
   * @return string
   */
  public function getNewUserPluginName();

  /**
   * Get the plugin name for the existing user acceptance.
   *
   * @return string
   */
  public function getExistingUserPluginName();

}

Interfaces

Namesort descending Description
EntityLegalDocumentInterface Provides interface for defining legal document entities.