You are here

Home » API reference » Scheduled Updates 8 » ScheduledUpdateType.php

class ScheduledUpdateType in Scheduled Updates 8

Defines the Scheduled update type entity.

Plugin annotation


@ConfigEntityType(
  id = "scheduled_update_type",
  label = @Translation("Scheduled update type"),
  handlers = {
    "list_builder" = "Drupal\scheduled_updates\ScheduledUpdateTypeListBuilder",
    "access" = "Drupal\scheduled_updates\ScheduledUpdateTypeAccessControlHandler",
    "form" = {
      "add" = "Drupal\scheduled_updates\Form\ScheduledUpdateTypeForm",
      "edit" = "Drupal\scheduled_updates\Form\ScheduledUpdateTypeForm",
      "delete" = "Drupal\scheduled_updates\Form\ScheduledUpdateTypeDeleteForm",
      "add-as-field" = "Drupal\scheduled_updates\Form\ScheduledUpdateTypeAddAsFieldForm"
    }
  },
  config_prefix = "scheduled_update_type",
  admin_permission = "administer scheduled update types",
  bundle_of = "scheduled_update",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  links = {
    "edit-form" = "/admin/config/workflow/scheduled-update-type/{scheduled_update_type}/edit",
    "delete-form" = "/admin/config/workflow/scheduled-update-type/{scheduled_update_type}/delete",
    "collection" = "/admin/config/workflow/scheduled-update-type/list",
    "clone-fields" = "/admin/config/workflow/scheduled-update-type/{scheduled_update_type}/clone-fields"
  }
)

Hierarchy

Expanded class hierarchy of ScheduledUpdateType

8 files declare their use of ScheduledUpdateType
AddFieldScheduledUpdateTypeTest.php in tests/src/FunctionalJavascript/AddFieldScheduledUpdateTypeTest.php
Contains \Drupal\Tests\scheduled_updates\AddFieldScheduledUpdateTypeTest.
BaseUpdateRunner.php in src/Plugin/BaseUpdateRunner.php
Contains \Drupal\scheduled_updates\Plugin\BaseUpdateRunner.
IndependentScheduledUpdateTypeTest.php in tests/src/FunctionalJavascript/IndependentScheduledUpdateTypeTest.php
Contains \Drupal\Tests\scheduled_updates\IndependentScheduledUpdateTypeTest.
Permissions.php in src/Permissions.php
Contains \Drupal\scheduled_updates\Permissions.
ScheduledUpdateTypeAddAsFieldForm.php in src/Form/ScheduledUpdateTypeAddAsFieldForm.php
Contains \Drupal\scheduled_updates\Form\ScheduledUpdateTypeAddAsFieldForm.

... See full list

File

src/Entity/ScheduledUpdateType.php, line 45
Contains \Drupal\scheduled_updates\Entity\ScheduledUpdateType.

Namespace

Drupal\scheduled_updates\Entity
View source 
class ScheduledUpdateType extends ConfigEntityBundleBase implements ScheduledUpdateTypeInterface {

  /**
   * The Scheduled update type ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The Scheduled update type label.
   *
   * @var string
   */
  protected $label;

  /**
   * The updates types this Scheduled Update types supports.
   *
   * Know update types are embedded and indepedent.
   * @var array
   */
  protected $update_types_supported = [];

  /**
   * @return array
   */
  public function getUpdateTypesSupported() {
    return $this->update_types_supported;
  }

  /**
   * @param array $update_types_supported
   */
  public function setUpdateTypesSupported($update_types_supported) {
    $this->update_types_supported = $update_types_supported;
  }

  /**
   * @param array $field_map
   */
  public function setFieldMap($field_map) {
    $this->field_map = $field_map;
  }

  /**
   * The entity type id of the entities to be updated.
   *
   * @var string
   */
  protected $update_entity_type;

  /**
   * The map of the source and destination fields
   *
   * The keys of the array are the source fields and the values are the destination fields.
   * @var array
   */
  protected $field_map = [];

  /**
   * @var array
   */
  protected $update_runner = [
    'id' => 'default_embedded',
  ];

  /**
   * @return array
   */
  public function getUpdateRunnerSettings() {
    return $this->update_runner;
  }

  /**
   * @return array
   */
  public function getFieldMap() {
    if (!$this->field_map) {
      $this->field_map = [];
    }
    return $this->field_map;
  }

  /**
   * @return string
   */
  public function getUpdateEntityType() {
    return $this->update_entity_type;
  }

  /**
   * @param string $update_entity_type
   */
  public function setUpdateEntityType($update_entity_type) {
    $this->update_entity_type = $update_entity_type;
  }
  public function isEmbeddedType() {
    return in_array('embedded', $this->update_types_supported);
  }
  public function isIndependentType() {
    return in_array('independent', $this->update_types_supported);
  }
  public function cloneField($new_field) {
  }

  /**
   * {@inheritdoc}
   */
  public function addNewFieldMappings($new_map) {
    $this
      ->setFieldMap($new_map + $this->field_map);
  }

}

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 Information maintained by Drupal core about configuration.
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 13
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::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
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::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
ConfigEntityBundleBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 2
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
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 Aliased as: traitSleep 1
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::entityManager Deprecated protected function Gets the entity manager.
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::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
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
ScheduledUpdateType::$field_map protected property The map of the source and destination fields
ScheduledUpdateType::$id protected property The Scheduled update type ID.
ScheduledUpdateType::$label protected property The Scheduled update type label.
ScheduledUpdateType::$update_entity_type protected property The entity type id of the entities to be updated.
ScheduledUpdateType::$update_runner protected property
ScheduledUpdateType::$update_types_supported protected property The updates types this Scheduled Update types supports.
ScheduledUpdateType::addNewFieldMappings public function Add new mappings to existing field map. Overrides ScheduledUpdateTypeInterface::addNewFieldMappings
ScheduledUpdateType::cloneField public function Overrides ScheduledUpdateTypeInterface::cloneField
ScheduledUpdateType::getFieldMap public function Overrides ScheduledUpdateTypeInterface::getFieldMap
ScheduledUpdateType::getUpdateEntityType public function Overrides ScheduledUpdateTypeInterface::getUpdateEntityType
ScheduledUpdateType::getUpdateRunnerSettings public function Overrides ScheduledUpdateTypeInterface::getUpdateRunnerSettings
ScheduledUpdateType::getUpdateTypesSupported public function
ScheduledUpdateType::isEmbeddedType public function Overrides ScheduledUpdateTypeInterface::isEmbeddedType
ScheduledUpdateType::isIndependentType public function Overrides ScheduledUpdateTypeInterface::isIndependentType
ScheduledUpdateType::setFieldMap public function Overrides ScheduledUpdateTypeInterface::setFieldMap
ScheduledUpdateType::setUpdateEntityType public function
ScheduledUpdateType::setUpdateTypesSupported public function
ScheduledUpdateTypeInterface::REFERENCED constant
ScheduledUpdateTypeInterface::REFERENCER constant
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