interface OgDeleteOrphansInterface in Organic groups 8

Interface for OgDeleteOrphans plugins.

Depending on the needs of a project there are different ways to deal with orphaned memberships and content after a group entity is deleted. This plugin type allows to register a group entity for having its orphans deleted, to customize the query that will gather the orphans, and to start the deletion process.

It is up to the implementing plugin to deal with the specifics. A long running batch process will need to store the list of orphans somewhere, and will be responsible for running the deletion to the end.

Hierarchy

• interface \Drupal\og\OgDeleteOrphansInterface

File

src/OgDeleteOrphansInterface.php, line 23

Namespace

Drupal\og

interface OgDeleteOrphansInterface {

  /**
   * Registers a soon to be deleted group entity, for processing.
   *
   * During processing its orphaned members or content will be deleted.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The group entity to register.
   */
  public function register(EntityInterface $entity);

  /**
   * Starts the deletion process.
   */
  public function process();

  /**
   * Returns the configuration form elements specific to this plugin.
   *
   * @param array $form
   *   The form definition array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The renderable form array representing the entire configuration form.
   */
  public function configurationForm(array $form, FormStateInterface $form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
OgDeleteOrphansInterface::configurationForm	public	function	Returns the configuration form elements specific to this plugin.	1
OgDeleteOrphansInterface::process	public	function	Starts the deletion process.	3
OgDeleteOrphansInterface::register	public	function	Registers a soon to be deleted group entity, for processing.	1