class ScheduleListBuilder in Backup and Migrate 8.4

Provides a listing of Schedule entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
      • class \Drupal\backup_migrate\Controller\ScheduleListBuilder

File

src/Controller/ScheduleListBuilder.php, line 13

Namespace

Drupal\backup_migrate\Controller

class ScheduleListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Schedule Name');
    $header['enabled'] = $this
      ->t('Enabled');
    $header['period'] = $this
      ->t('Frequency');
    $header['last_run'] = $this
      ->t('Last Run');
    $header['next_run'] = $this
      ->t('Next Run');
    $header['keep'] = $this
      ->t('Keep');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   *
   * ScheduleListBuilder save implementation requires instance of Schedule.
   * Signature enforced by EntityListBuilder.
   *
   * @throw InvalidArgumentException
   */
  public function buildRow(EntityInterface $entity) {
    if (!$entity instanceof Schedule) {
      throw new Exception();
    }
    $row['label'] = $entity
      ->label();
    $row['enabled'] = $entity
      ->get('enabled') ? $this
      ->t('Yes') : $this
      ->t('No');
    $row['period'] = $entity
      ->getPeriodFormatted();
    $row['last_run'] = $this
      ->t('Never');
    $time = \Drupal::time();
    if ($last_run = $entity
      ->getLastRun()) {
      $row['last_run'] = \Drupal::service('date.formatter')
        ->format($last_run, 'small');
      $row['last_run'] .= ' (' . $this
        ->t('@time ago', [
        '@time' => \Drupal::service('date.formatter')
          ->formatInterval($time
          ->getRequestTime() - $last_run),
      ]) . ')';
    }
    $row['next_run'] = $this
      ->t('Not Scheduled');
    if (!$entity
      ->get('enabled')) {
      $row['next_run'] = $this
        ->t('Disabled');
    }
    elseif ($next_run = $entity
      ->getNextRun()) {
      $interval = \Drupal::service('date.formatter')
        ->formatInterval(abs($next_run - $time
        ->getRequestTime()));
      if ($next_run > $time
        ->getRequestTime()) {
        $row['next_run'] = \Drupal::service('date.formatter')
          ->format($next_run, 'small');
        $row['next_run'] .= ' (' . $this
          ->t('in @time', [
          '@time' => $interval,
        ]) . ')';
      }
      else {
        $row['next_run'] = $this
          ->t('Next cron run');
        if ($last_run) {
          $row['next_run'] .= ' (' . $this
            ->t('was due @time ago', [
            '@time' => $interval,
          ]) . ')';
        }
      }
    }
    $row['keep'] = \Drupal::translation()
      ->formatPlural($entity
      ->get('keep'), 'Last 1 backup', 'Last @count backups');
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    drupal_set_message(t('The schedule settings have been updated.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
ScheduleListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ScheduleListBuilder::buildRow	public	function	ScheduleListBuilder save implementation requires instance of Schedule. Signature enforced by EntityListBuilder. Overrides EntityListBuilder::buildRow
ScheduleListBuilder::submitForm	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.