StudentStorageInterface.php 1.61 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
<?php

namespace Drupal\eepal;

use Drupal\Core\Entity\ContentEntityStorageInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\eepal\Entity\StudentInterface;

/**
 * Defines the storage handler class for Student entities.
 *
 * This extends the base storage class, adding required special handling for
 * Student entities.
 *
 * @ingroup eepal
 */
interface StudentStorageInterface extends ContentEntityStorageInterface {

  /**
   * Gets a list of Student revision IDs for a specific Student.
   *
   * @param \Drupal\eepal\Entity\StudentInterface $entity
   *   The Student entity.
   *
   * @return int[]
   *   Student revision IDs (in ascending order).
   */
  public function revisionIds(StudentInterface $entity);

  /**
   * Gets a list of revision IDs having a given user as Student author.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user entity.
   *
   * @return int[]
   *   Student revision IDs (in ascending order).
   */
  public function userRevisionIds(AccountInterface $account);

  /**
   * Counts the number of revisions in the default language.
   *
   * @param \Drupal\eepal\Entity\StudentInterface $entity
   *   The Student entity.
   *
   * @return int
   *   The number of revisions in the default language.
   */
  public function countDefaultLanguageRevisions(StudentInterface $entity);

  /**
   * Unsets the language for all Student with the given language.
   *
   * @param \Drupal\Core\Language\LanguageInterface $language
   *   The language object.
   */
  public function clearRevisionsLanguage(LanguageInterface $language);

}