You are here

Home » API reference » Backup and Migrate 5.0.x » Schedule.php

class Schedule in Backup and Migrate 5.0.x

Same name and namespace in other branches
  1. 8.4 src/Entity/Schedule.php \Drupal\backup_migrate\Entity\Schedule

Defines the Schedule entity.

Plugin annotation


@ConfigEntityType(
  id = "backup_migrate_schedule",
  label = @Translation("Schedule"),
  module = "backup_migrate",
  admin_permission = "administer backup and migrate",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  handlers = {
    "list_builder" = "Drupal\backup_migrate\Controller\ScheduleListBuilder",
    "form" = {
      "default" = "Drupal\backup_migrate\Form\ScheduleForm",
      "delete" = "Drupal\backup_migrate\Form\EntityDeleteForm"
    },
  },
  links = {
    "edit-form" = "/admin/config/development/backup_migrate/schedule/edit/{backup_migrate_schedule}",
    "delete-form" = "/admin/config/development/backup_migrate/schedule/delete/{backup_migrate_schedule}",
    "collection" = "/admin/config/development/backup_migrate/schedule",
  },
  config_export = {
    "id",
    "label",
    "uuid",
    "enabled",
    "keep",
    "period",
    "cron",
    "source_id",
    "destination_id",
    "settings_profile_id"
  }
)

Hierarchy

Expanded class hierarchy of Schedule

4 files declare their use of Schedule
backup_migrate.install in ./backup_migrate.install
backup_migrate.module in ./backup_migrate.module
Primary hook implementations for Backup Migrate.
ScheduleForm.php in src/Form/ScheduleForm.php
ScheduleListBuilder.php in src/Controller/ScheduleListBuilder.php
3 string references to 'Schedule'
AdminFunctionalityTest::pagesListProvider in tests/src/Functional/AdminFunctionalityTest.php
A list of paths to check and a string that should be present on that page.
backup_migrate.links.menu.yml in ./backup_migrate.links.menu.yml
backup_migrate.links.menu.yml
backup_migrate.routing.yml in ./backup_migrate.routing.yml
backup_migrate.routing.yml

File

src/Entity/Schedule.php, line 51

Namespace

Drupal\backup_migrate\Entity
View source 
class Schedule extends ConfigEntityBase {

  /**
   * The name for last run information keys in State.
   */
  const STATE_NAME = 'backup_migrate.schedule.last_run';

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected static $state;

  /**
   * The Schedule ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The Schedule label.
   *
   * @var string
   */
  protected $label;

  /**
   * Run the schedule.
   *
   * @param \Drupal\backup_migrate\Core\Main\BackupMigrateInterface $bam
   *   The Backup and Migrate service object used to execute the backups.
   * @param bool $force
   *   Run the schedule even if it is not due to be run.
   */
  public function run(BackupMigrateInterface $bam, $force = FALSE) {
    $next_run_at = $this
      ->getNextRun();
    $time = \Drupal::time();
    $should_run_now = $time
      ->getRequestTime() >= $next_run_at;
    $enabled = $this
      ->get('enabled');
    if ($force || $should_run_now && $enabled) {

      // Set the last run time before attempting backup.
      // This will prevent a failing schedule from retrying on every cron run.
      $this
        ->setLastRun($time
        ->getRequestTime());
      try {
        $config = [];
        if ($settings_profile_id = $this
          ->get('settings_profile_id')) {

          // Load the settings profile if one is selected.
          $profile = SettingsProfile::load($settings_profile_id);
          if (!$profile) {
            throw new BackupMigrateException("The settings profile '%profile' does not exist", [
              '%profile' => $settings_profile_id,
            ]);
          }
          $config = $profile
            ->get('config');
        }
        \Drupal::logger('backup_migrate')
          ->info("Running schedule %name", [
          '%name' => $this
            ->get('label'),
        ]);

        // @todo Set the config (don't just use the defaults).
        // Run the backup.
        // Set the schedule id in file metadata so that we can delete our own
        // backups later. This requires the metadata writer to have knowledge
        // of 'bam_scheduleid' which is a somewhat tight coupling that I'd like
        // to unwind.
        $config['metadata']['bam_scheduleid'] = $this->id;
        $bam
          ->setConfig(new Config($config));
        $bam
          ->backup($this
          ->get('source_id'), $this
          ->get('destination_id'));

        // Delete old backups.
        if ($keep = $this
          ->get('keep')) {
          $destination = $bam
            ->destinations()
            ->get($this
            ->get('destination_id'));

          // If the destination can be listed then get the list of files.
          if ($destination instanceof ListableDestinationInterface) {

            // Get a list of files to delete. Don't attempt to delete more
            // than 10 files in one go.
            $delete = $destination
              ->queryFiles([
              'bam_scheduleid' => $this->id,
            ], 'datestamp', SORT_ASC, 10, $keep);
            foreach ($delete as $file) {
              $destination
                ->deleteFile($file
                ->getFullName());
            }
          }
        }
      } catch (BackupMigrateException $e) {
        \Drupal::logger('backup_migrate')
          ->error("Scheduled backup '%name' failed: @err", [
          '%name' => $this
            ->get('label'),
          '@err' => $e
            ->getMessage(),
        ]);
      }
    }
  }

  /**
   * Return the unix time this schedule was last run.
   *
   * @return int
   *   The timestamp.
   */
  public function getLastRun() : int {
    $allLast = static::state()
      ->get(static::STATE_NAME);
    return (int) ($allLast[$this
      ->id()] ?? 0);
  }

  /**
   * Store the timestamp for the last time this schedule was run.
   *
   * @param int $timestamp
   *   The unix time this schedule was last run. 0 means never.
   */
  public function setLastRun(int $timestamp) : void {
    $name = static::STATE_NAME;
    $allLast = $this
      ->state()
      ->get($name);
    if (empty($timestamp)) {
      unset($allLast[$this
        ->id()]);
    }
    else {
      $allLast[$this
        ->id()] = $timestamp;
    }
    if (empty($allLast)) {
      $this
        ->state()
        ->delete($name);
    }
    else {
      $this
        ->state()
        ->set($name, $allLast);
    }
  }

  /**
   * Return the state service.
   *
   * Easier to replace in unit tests than mocking the actual state service.
   *
   * @return \Drupal\Core\State\StateInterface
   *   The state service.
   */
  protected static function state() : StateInterface {
    if (empty(static::$state)) {
      static::$state = \Drupal::state();
    }
    return static::$state;
  }

  /**
   * Get the next time this schedule should run.
   *
   * @return int
   *   The timestamp for the next run.
   */
  public function getNextRun() {
    $last_run_at = $this
      ->getLastRun();
    if ($last_run_at) {
      return $last_run_at + $this
        ->get('period');
    }
    return \Drupal::time()
      ->getRequestTime() - 1;
  }

  /**
   * Return the schedule frequency formatted for display in human language.
   *
   * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
   *   The schedule frequency.
   *
   * @throws \Drupal\backup_migrate\Core\Exception\BackupMigrateException
   */
  public function getPeriodFormatted() {
    return Schedule::formatPeriod(Schedule::secondsToPeriod($this
      ->get('period')));
  }

  /**
   * Convert a number of seconds into a period array.
   *
   * @param int $seconds
   *   The number of seconds to convert.
   *
   * @return array
   *   An array containing the period definition and the number of them.
   *   ['number' => 123, 'type' => [...]]
   *
   * @throws \Drupal\backup_migrate\Core\Exception\BackupMigrateException
   */
  public static function secondsToPeriod($seconds) {
    foreach (array_reverse(Schedule::getPeriodTypes()) as $type) {
      if ($seconds % $type['seconds'] === 0) {
        return [
          'number' => $seconds / $type['seconds'],
          'type' => $type,
        ];
      }
    }
    throw new BackupMigrateException('Invalid period.');
  }

  /**
   * Convert a period array into seconds.
   *
   * @param array $period
   *   A period array.
   *
   * @return mixed
   *   The number of seconds. Should be an integer value.
   *
   * @throws \Drupal\backup_migrate\Core\Exception\BackupMigrateException
   */
  public static function periodToSeconds(array $period) {
    return $period['number'] * $period['type']['seconds'];
  }

  /**
   * Convert a period array into seconds.
   *
   * @param int $period
   *   The array to convert.
   *
   * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
   *   The converted period.
   */
  public static function formatPeriod($period) {
    return \Drupal::translation()
      ->formatPlural($period['number'], $period['type']['singular'], $period['type']['plural']);
  }

  /**
   * Get a list of available backup periods.
   *
   * Only returns time periods which have a (reasonably) consistent number of
   * seconds (ie: no months).
   *
   * @return array
   *   The list of available periods, keyed by unit.
   */
  public static function getPeriodTypes() {
    return [
      'seconds' => [
        'type' => 'seconds',
        'seconds' => 1,
        'title' => 'Seconds',
        'singular' => 'Once a second',
        'plural' => 'Every @count seconds',
      ],
      'minutes' => [
        'type' => 'minutes',
        'seconds' => 60,
        'title' => 'Minutes',
        'singular' => 'Once a minute',
        'plural' => 'Every @count minutes',
      ],
      'hours' => [
        'type' => 'hours',
        'seconds' => 3600,
        'title' => 'Hours',
        'singular' => 'Hourly',
        'plural' => 'Every @count hours',
      ],
      'days' => [
        'type' => 'days',
        'seconds' => 86400,
        'title' => 'Days',
        'singular' => 'Daily',
        'plural' => 'Every @count days',
      ],
      'weeks' => [
        'type' => 'weeks',
        'seconds' => 604800,
        'title' => 'Weeks',
        'singular' => 'Weekly',
        'plural' => 'Every @count weeks',
      ],
    ];
  }

  /**
   * Get a backup period type given its key.
   *
   * @param string $type
   *   The period type. MUST be one of the keys in Schedule::getPeriodTypes().
   *
   * @return array
   *   The period description.
   */
  public static function getPeriodType($type) {
    return Schedule::getPeriodTypes()[$type];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 14
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
Schedule::$id protected property The Schedule ID.
Schedule::$label protected property The Schedule label.
Schedule::$state protected static property The state service.
Schedule::formatPeriod public static function Convert a period array into seconds.
Schedule::getLastRun public function Return the unix time this schedule was last run.
Schedule::getNextRun public function Get the next time this schedule should run.
Schedule::getPeriodFormatted public function Return the schedule frequency formatted for display in human language.
Schedule::getPeriodType public static function Get a backup period type given its key.
Schedule::getPeriodTypes public static function Get a list of available backup periods.
Schedule::periodToSeconds public static function Convert a period array into seconds.
Schedule::run public function Run the schedule.
Schedule::secondsToPeriod public static function Convert a number of seconds into a period array.
Schedule::setLastRun public function Store the timestamp for the last time this schedule was run.
Schedule::state protected static function Return the state service.
Schedule::STATE_NAME constant The name for last run information keys in State.
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function