You are here

class WebformRevision in Config Entity Revisions 8.2

Class WebformRevision.

@package Drupal\webform_revisions\Entity

Hierarchy

Expanded class hierarchy of WebformRevision

1 file declares its use of WebformRevision
webform_revisions.module in modules/webform_revisions/webform_revisions.module
Webform revisions procedural hooks.

File

modules/webform_revisions/src/Entity/WebformRevision.php, line 16

Namespace

Drupal\webform_revisions\Entity
View source
class WebformRevision extends Webform implements ConfigEntityRevisionsConfigEntityInterface, EntityPublishedInterface {
  use ConfigEntityRevisionsConfigEntityTrait;
  use EntityPublishedTrait;
  private $constants = [
    'module_name' => 'webform_revisions',
    'config_entity_name' => 'webform',
    'revisions_entity_name' => 'WebformRevision',
    'bundle_name' => 'webform_revisions',
    'setting_name' => 'webform_revisions_id',
    'title' => 'Webform',
    'has_own_content' => TRUE,
    'content_entity_type' => 'webform_submissions',
    'content_entity_table' => 'webform_submissions',
    'content_parameter_name' => 'webform_submission',
    'content_parent_reference_field' => 'webform',
    'admin_permission' => 'administer webforms',
    'has_canonical_url' => TRUE,
    'preview_form_id' => '',
  ];

  /**
   * Get the number of submissions related to a revision.
   *
   * @return int
   *   The number of content entities using a particular revision.
   */
  public function contentEntityCount($rid) {
    return \Drupal::database()
      ->query("SELECT COUNT(sid) FROM {webform_submission} WHERE webform_revision = :rid", [
      ':rid' => $rid,
    ])
      ->fetchField();
  }

  /**
   * Delete submissions related to a revision.
   */
  public function deleteRelatedContentEntities($rid) {
    $sids = \Drupal::database()
      ->query("SELECT sid FROM {webform_submission} WHERE webform_revision = :rid", [
      ':rid' => $rid,
    ])
      ->fetchCol();
    $storage = \Drupal::entityTypeManager()
      ->getStorage('webform_submission');
    $submissions = $storage
      ->loadMultiple($sids);
    $storage
      ->delete($submissions);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteElement($key) {

    // Delete element from the elements render array.
    $elements = $this
      ->getElementsDecoded();
    $sub_element_keys = $this
      ->deleteElementRecursive($elements, $key);
    $this
      ->setElements($elements);

    // Don't delete submission data so that it can still be viewed for previous
    // revisions.
  }

}

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::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
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::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::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
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::__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
ConfigEntityRevisionsConfigEntityTrait::$isDefaultRevision public property Whether this revision is the default one.
ConfigEntityRevisionsConfigEntityTrait::$loadedRevisionId public property The ID of the revision that was loaded.
ConfigEntityRevisionsConfigEntityTrait::$moderation_state public property The current moderation state for this revision.
ConfigEntityRevisionsConfigEntityTrait::$revision protected property The revision. 1
ConfigEntityRevisionsConfigEntityTrait::$revision_log_message protected property The revision_log_message. 1
ConfigEntityRevisionsConfigEntityTrait::adminPermission public function Return the name of the admin permission for this entity.
ConfigEntityRevisionsConfigEntityTrait::configEntityName public function The config entity name.
ConfigEntityRevisionsConfigEntityTrait::contentEntityStorage public function Get the revisions entity storage.
ConfigEntityRevisionsConfigEntityTrait::contentEntityType public function The name of the content entity type.
ConfigEntityRevisionsConfigEntityTrait::contentParameterName public function Get the name of the parameter for this content.
ConfigEntityRevisionsConfigEntityTrait::contentParentReferenceField public function Get the content's parent reference field.
ConfigEntityRevisionsConfigEntityTrait::getBundleName public function The bundle name for content entities.
ConfigEntityRevisionsConfigEntityTrait::getContentEntity public function Default revision of revisions entity that matches the config entity.
ConfigEntityRevisionsConfigEntityTrait::getContentEntityId public function Get from the configEntity the ID of the matching content entity.
ConfigEntityRevisionsConfigEntityTrait::getLoadedRevisionId public function Gets the loaded Revision ID of the entity.
ConfigEntityRevisionsConfigEntityTrait::getRevisionId public function Gets the revision identifier of the entity.
ConfigEntityRevisionsConfigEntityTrait::hasCanonicalUrl public function Return whether the entity has a canonical URL.
ConfigEntityRevisionsConfigEntityTrait::hasOwnContent public function Whether this config entity has its own content entities.
ConfigEntityRevisionsConfigEntityTrait::isDefaultRevision public function Checks if this entity is the default revision.
ConfigEntityRevisionsConfigEntityTrait::isLatestRevision public function Checks if this entity is the latest revision.
ConfigEntityRevisionsConfigEntityTrait::isNewRevision public function Determines whether a new revision should be created on save.
ConfigEntityRevisionsConfigEntityTrait::moduleName public function The module implementing config entity revisions.
ConfigEntityRevisionsConfigEntityTrait::preSaveRevision public function Acts on a revision before it gets saved.
ConfigEntityRevisionsConfigEntityTrait::previewFormId public function Return the preview form ID, if applicable.
ConfigEntityRevisionsConfigEntityTrait::revisionedEntity public function Get the revisioned entity - itself by default. 1
ConfigEntityRevisionsConfigEntityTrait::revisionsEntityName public function The content entity name in which revisions are being stored.
ConfigEntityRevisionsConfigEntityTrait::save public function Save an updated version of the entity.
ConfigEntityRevisionsConfigEntityTrait::set public function
ConfigEntityRevisionsConfigEntityTrait::setContentEntityId public function Set in the configEntity an identifier for the matching content entity.
ConfigEntityRevisionsConfigEntityTrait::setNewRevision public function Enforces an entity to be saved as a new revision.
ConfigEntityRevisionsConfigEntityTrait::settingName public function The config entity setting name in which content entity ids are stored.
ConfigEntityRevisionsConfigEntityTrait::title public function The human readable title for this entity.
ConfigEntityRevisionsConfigEntityTrait::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID.
ConfigEntityRevisionsConfigEntityTrait::urlRouteParameters protected function Gets an array of placeholders for this entity.
ConfigEntityRevisionsConfigEntityTrait::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved.
ConfigEntityRevisionsConfigEntityTrait::__construct public function Constructs an Entity object. 1
ConfigEntityRevisionsConfigEntityTrait::__wakeup public function Restore the entity type manager after deserialisation.
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
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::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::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityPublishedTrait::isPublished public function
EntityPublishedTrait::publishedBaseFieldDefinitions public static function Returns an array of base field definitions for publishing status.
EntityPublishedTrait::setPublished public function
EntityPublishedTrait::setUnpublished public function
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
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.
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
Webform::$access protected property The webform access controls.
Webform::$archive protected property The webform archive indicator.
Webform::$category protected property The webform options category.
Webform::$close protected property The webform close date/time.
Webform::$css protected property The CSS style sheet.
Webform::$description protected property The webform description.
Webform::$elements protected property The webform elements.
Webform::$elementsActions protected property Track the elements that are 'webform_actions' (aka submit buttons).
Webform::$elementsAttachments protected property Track attachment elements.
Webform::$elementsComputed protected property Track computed elements.
Webform::$elementsCss protected property Track elements CSS.
Webform::$elementsDecoded protected property The webform elements decoded.
Webform::$elementsDecodedAndFlattened protected property The webform elements decoded and flattened.
Webform::$elementsDefaultData protected property A webform's default data extracted from each element's default value or value.
Webform::$elementsInitialized protected property The webform elements initializes (and decoded).
Webform::$elementsInitializedAndFlattened protected property The webform elements initialized and flattened.
Webform::$elementsInitializedFlattenedAndHasValue protected property The webform elements initialized, flattened, and has value.
Webform::$elementsJavaScript protected property Track elements JavaScript.
Webform::$elementsManagedFiles protected property Track managed file elements.
Webform::$elementsOriginal protected property The webform elements original.
Webform::$elementsPrepopulate protected property Track the elements that are prepopulated.
Webform::$elementsTranslated protected property The webform translated elements state.
Webform::$elementsTranslations protected property The webform elements translations.
Webform::$elementsVariant protected property Track variant elements.
Webform::$elementsWizardPages protected property Track the elements that are 'webform_pages' (aka Wizard pages).
Webform::$handlers protected property The array of webform handlers for this webform.
Webform::$handlersCollection protected property Holds the collection of webform handlers that are used by this webform.
Webform::$hasAnonymousSubmissionTrackingHandler protected property Track if a webform handler requires anonymous submission tracking .
Webform::$hasConditions protected property Track if the webform has conditions (i.e. #states).
Webform::$hasContainer protected property Track if the webform has container.
Webform::$hasFlexboxLayout protected property Track if the webform is using a flexbox layout.
Webform::$hasMessageHandler protected property Track if the webform has message handler.
Webform::$hasRequired protected property Track if the webform has required elements.
Webform::$hasTranslations protected property Track if the webform has translations.
Webform::$id protected property The webform ID.
Webform::$javascript protected property The JavaScript.
Webform::$open protected property The webform open date/time.
Webform::$operation protected property The webform's current operation.
Webform::$override protected property The webform override state.
Webform::$pages protected property The webform pages.
Webform::$settings protected property The webform settings.
Webform::$settingsOriginal protected property The webform settings original.
Webform::$status protected property The webform status. Overrides ConfigEntityBase::$status
Webform::$template protected property The webform template indicator.
Webform::$title protected property The webform title.
Webform::$uid protected property The owner's uid.
Webform::$updating protected property The webform elements are being updated.
Webform::$uuid protected property The webform UUID. Overrides ConfigEntityBase::$uuid
Webform::$variants protected property The array of webform variants for this webform.
Webform::$variantsCollection protected property Holds the collection of webform variants that are used by this webform.
Webform::$weight protected property The webform weight.
Webform::addWebformHandler public function Saves a webform handler for this webform. Overrides WebformInterface::addWebformHandler
Webform::addWebformVariant public function Saves a webform variant for this webform. Overrides WebformInterface::addWebformVariant
Webform::applyVariant public function Apply webform variant.
Webform::applyVariants public function Apply webform variants based on a webform submission or parameter. Overrides WebformInterface::applyVariants
Webform::buildPages protected function Build and cache a webform's wizard pages based on the current operation.
Webform::checkElementsFlattenedAccess protected function Check operation access for each element.
Webform::collectSubElementKeysRecursive protected function Collect sub element keys from a render array.
Webform::createDuplicate public function Creates a duplicate of the entity. Overrides ConfigEntityBase::createDuplicate
Webform::deleteElementRecursive protected function Remove an element by key from a render array.
Webform::deletePaths public function Update submit and confirm paths associated with this webform. Overrides WebformInterface::deletePaths
Webform::deleteState public function Deletes an item from the webform's state. Overrides WebformInterface::deleteState
Webform::deleteUserData public function Deletes an item from the webform's user data. Overrides WebformInterface::deleteUserData
Webform::deleteWebformHandler public function Deletes a webform handler from this webform. Overrides WebformInterface::deleteWebformHandler
Webform::deleteWebformVariant public function Deletes a webform variant from this webform. Overrides WebformInterface::deleteWebformVariant
Webform::getAccessRules public function Returns the webform access rules. Overrides WebformInterface::getAccessRules
Webform::getAssets public function Returns the webform's global and custom CSS and JavaScript assets. Overrides WebformInterface::getAssets
Webform::getCacheContexts public function The cache contexts associated with this object. Overrides EntityBase::getCacheContexts
Webform::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides EntityBase::getCacheMaxAge
Webform::getCacheTags public function The cache tags associated with this object. Overrides EntityBase::getCacheTags
Webform::getCss public function Returns the webform's CSS. Overrides WebformInterface::getCss
Webform::getDefaultSettings public static function Returns the webform default settings. Overrides WebformInterface::getDefaultSettings
Webform::getDescription public function Returns the webform's description. Overrides WebformInterface::getDescription
Webform::getElement public function Get a webform's initialized element. Overrides WebformInterface::getElement
Webform::getElementDecoded public function Get a webform's raw (uninitialized) element. Overrides WebformInterface::getElementDecoded
Webform::getElementInitialized public function
Webform::getElementsAttachments public function Get webform attachment elements. Overrides WebformInterface::getElementsAttachments
Webform::getElementsComputed public function Get webform computed elements. Overrides WebformInterface::getElementsComputed
Webform::getElementsDecoded public function Get webform elements decoded as an associative array. Overrides WebformInterface::getElementsDecoded
Webform::getElementsDecodedAndFlattened public function Get webform raw elements decoded and flattened into an associative array. Overrides WebformInterface::getElementsDecodedAndFlattened
Webform::getElementsDefaultData public function Get webform elements default data. Overrides WebformInterface::getElementsDefaultData
Webform::getElementsInitialized public function Get webform elements initialized as an associative array. Overrides WebformInterface::getElementsInitialized
Webform::getElementsInitializedAndFlattened public function Get webform elements initialized and flattened into an associative array. Overrides WebformInterface::getElementsInitializedAndFlattened
Webform::getElementsInitializedFlattenedAndHasValue public function Get webform flattened list of elements. Overrides WebformInterface::getElementsInitializedFlattenedAndHasValue
Webform::getElementsManagedFiles public function Get webform managed file elements. Overrides WebformInterface::getElementsManagedFiles
Webform::getElementsOriginalDecoded public function Get original elements decoded as an associative array. Overrides WebformInterface::getElementsOriginalDecoded
Webform::getElementsOriginalRaw public function Get original elements (YAML) value. Overrides WebformInterface::getElementsOriginalRaw
Webform::getElementsPrepopulate public function Get webform elements that can be prepopulated. Overrides WebformInterface::getElementsPrepopulate
Webform::getElementsRaw public function Get elements (YAML) value. Overrides WebformInterface::getElementsRaw
Webform::getElementsSelectorOptions public function Get webform element's selectors as options. Overrides WebformInterface::getElementsSelectorOptions
Webform::getElementsSelectorSourceValues public function Get webform element options as autocomplete source values. Overrides WebformInterface::getElementsSelectorSourceValues
Webform::getElementsVariant public function Get webform variant elements. Overrides WebformInterface::getElementsVariant
Webform::getHandler public function Returns a specific webform handler. Overrides WebformInterface::getHandler
Webform::getHandlers public function Returns the webform handlers for this webform. Overrides WebformInterface::getHandlers
Webform::getIterator public function Define empty array iterator.
Webform::getJavaScript public function Returns the webform's JavaScript. Overrides WebformInterface::getJavaScript
Webform::getLangcode public function Returns the webform's (original) langcode. Overrides WebformInterface::getLangcode
Webform::getNumberOfActions public function Get the number of actions (aka submit buttons). Overrides WebformInterface::getNumberOfActions
Webform::getNumberOfWizardPages public function Get the number of wizard pages. Overrides WebformInterface::getNumberOfWizardPages
Webform::getOperation public function Returns the webform's current operation. Overrides WebformInterface::getOperation
Webform::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
Webform::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
Webform::getPage public function Get webform wizard page. Overrides WebformInterface::getPage
Webform::getPages public function Get webform wizard pages. Overrides WebformInterface::getPages
Webform::getPluginCollections public function Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
Webform::getSetting public function Returns the webform settings for a given key. Overrides WebformInterface::getSetting
Webform::getSettings public function Returns the webform settings. Overrides WebformInterface::getSettings
Webform::getState public function Returns the stored value for a given key in the webform's state. Overrides WebformInterface::getState
Webform::getSubmissionForm public function Get webform submission webform. Overrides WebformInterface::getSubmissionForm
Webform::getUserData public function Returns the stored value for a given key in the webform's user data. Overrides WebformInterface::getUserData
Webform::getVariant public function Returns a specific webform variant. Overrides WebformInterface::getVariant
Webform::getVariants public function Returns the webform variants for this webform. Overrides WebformInterface::getVariants
Webform::getVariantsData public function Get variants data from a webform submission. Overrides WebformInterface::getVariantsData
Webform::getWebformHandlerPluginManager protected function Returns the webform handler plugin manager.
Webform::getWebformVariantPluginManager protected function Returns the webform variant plugin manager.
Webform::getWeight public function Returns the webform's weight. Overrides WebformInterface::getWeight
Webform::hasActions public function Determine if the webform has any custom actions (aka submit buttons). Overrides WebformInterface::hasActions
Webform::hasAnonymousSubmissionTrackingHandler public function Determine if a webform handler requires anonymous submission tracking. Overrides WebformInterface::hasAnonymousSubmissionTrackingHandler
Webform::hasAttachments public function Determine if the webform's elements include attachments. Overrides WebformInterface::hasAttachments
Webform::hasComputed public function Determine if the webform's elements include computed values. Overrides WebformInterface::hasComputed
Webform::hasConditions public function Determine if the webform has conditional logic (i.e. #states). Overrides WebformInterface::hasConditions
Webform::hasContainer public function Determine if the webform has any containers. Overrides WebformInterface::hasContainer
Webform::hasFlexboxLayout public function Determine if the webform is using a Flexbox layout. Overrides WebformInterface::hasFlexboxLayout
Webform::hasManagedFile public function Determine if the webform's elements include a managed_file upload element. Overrides WebformInterface::hasManagedFile
Webform::hasMessageHandler public function Determine if the webform has any message handlers. Overrides WebformInterface::hasMessageHandler
Webform::hasPage public function Determine if the webform has page or is attached to other entities. Overrides WebformInterface::hasPage
Webform::hasPreview public function Determine if the webform has preview page. Overrides WebformInterface::hasPreview
Webform::hasRemoteAddr public function Determine if remote IP address is being stored. Overrides WebformInterface::hasRemoteAddr
Webform::hasRequired public function Determine if the webform has required elements. Overrides WebformInterface::hasRequired
Webform::hasState public function Determine if the stored value for a given key exists in the webform's state. Overrides WebformInterface::hasState
Webform::hasSubmissionLog public function Determine if submissions are being logged. Overrides WebformInterface::hasSubmissionLog
Webform::hasSubmissions public function Checks if a webform has submissions. Overrides WebformInterface::hasSubmissions
Webform::hasTranslations public function Determine if the current webform is translated. Overrides WebformInterface::hasTranslations
Webform::hasUserData public function Determine if the stored value for a given key exists in the webform's user data. Overrides WebformInterface::hasUserData
Webform::hasVariant public function Determine if a specific webform variant exists. Overrides WebformInterface::hasVariant
Webform::hasVariants public function Determine if the webform's elements include variants. Overrides WebformInterface::hasVariants
Webform::hasWizardPages public function Determine if the webform has multi-step form wizard pages. Overrides WebformInterface::hasWizardPages
Webform::initElements protected function Initialize and parse webform elements.
Webform::initElementsRecursive protected function Initialize webform elements into a flatten array.
Webform::initElementsTranslation protected function Initialize elements translation.
Webform::initElementsTranslationsRecursive protected function Init elements translations before variants are applied.
Webform::invokeElements public function Invoke elements method. Overrides WebformInterface::invokeElements
Webform::invokeHandlerAlter protected function Alter a webform handler when it is invoked.
Webform::invokeHandlers public function Invoke a handlers method. Overrides WebformInterface::invokeHandlers
Webform::isArchived public function Returns the webform archive indicator. Overrides WebformInterface::isArchived
Webform::isClosed public function Returns the webform closed status indicator. Overrides WebformInterface::isClosed
Webform::isConfidential public function Returns the webform confidential indicator. Overrides WebformInterface::isConfidential
Webform::isHandlerEnabled protected function Determine if a webform handler is enabled.
Webform::isOpen public function Returns the webform opened status indicator. Overrides WebformInterface::isOpen
Webform::isOpening public function Determines if the webform is currently closed but scheduled to open. Overrides WebformInterface::isOpening
Webform::isOverridden public function Returns the webform override status. Overrides WebformInterface::isOverridden
Webform::isResultsDisabled public function Determine if the saving of submissions is disabled. Overrides WebformInterface::isResultsDisabled
Webform::isScheduled public function Returns the webform scheduled status indicator. Overrides WebformInterface::isScheduled
Webform::isTemplate public function Returns the webform template indicator. Overrides WebformInterface::isTemplate
Webform::isTest public function Determine if the webform is being tested. Overrides WebformInterface::isTest
Webform::isUpdating public function Returns the webform updating status. Overrides WebformInterface::isUpdating
Webform::link public function Overriding so that links to webform default to 'canonical' submission webform and not the back-end 'edit-form'. Overrides ConfigEntityBase::link
Webform::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase::onDependencyRemoval
Webform::postLoad public static function Acts on loaded entities. Overrides EntityBase::postLoad
Webform::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
Webform::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
Webform::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
Webform::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBundleBase::preSave
Webform::resetElements protected function Reset parsed and cached webform elements.
Webform::resetHandlers protected function Reset cached handler settings.
Webform::resetSettings public function Reset overridden settings to original settings. Overrides WebformInterface::resetSettings
Webform::setAccessRules public function Sets the webform access rules. Overrides WebformInterface::setAccessRules
Webform::setCss public function Sets the webform's CSS. Overrides WebformInterface::setCss
Webform::setDescription public function Sets a webform's description. Overrides WebformInterface::setDescription
Webform::setElementProperties public function Set element properties. Overrides WebformInterface::setElementProperties
Webform::setElementPropertiesRecursive protected function Set element properties.
Webform::setElements public function Sets elements (YAML) value. Overrides WebformInterface::setElements
Webform::setJavaScript public function Sets the webform's JavaScript. Overrides WebformInterface::setJavaScript
Webform::setOperation public function Sets the webform's current operation . Overrides WebformInterface::setOperation
Webform::setOverride public function Sets the webform settings and properties override state. Overrides WebformInterface::setOverride
Webform::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
Webform::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
Webform::setPropertyOverride public function Sets the value of an overridden property. Overrides WebformInterface::setPropertyOverride
Webform::setSetting public function Sets a webform setting for a given key. Overrides WebformInterface::setSetting
Webform::setSettingOverride public function Sets a webform setting override for a given key. Overrides WebformInterface::setSettingOverride
Webform::setSettings public function Sets the webform settings. Overrides WebformInterface::setSettings
Webform::setSettingsOverride public function Sets the webform settings override. Overrides WebformInterface::setSettingsOverride
Webform::setState public function Saves a value for a given key in the webform's state. Overrides WebformInterface::setState
Webform::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityBase::setStatus
Webform::setUpdating public function Sets the webform updating state. Overrides WebformInterface::setUpdating
Webform::setUserData public function Saves a value for a given key in the webform's user data. Overrides WebformInterface::setUserData
Webform::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. Overrides ConfigEntityBase::sort
Webform::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityBase::status
Webform::toLink public function Overriding so that links to webform default to 'canonical' submission webform and not the back-end 'edit-form'. Overrides EntityBase::toLink
Webform::toUrl public function Overriding so that URLs pointing to webform default to 'canonical' submission webform and not the back-end 'edit-form'. Overrides ConfigEntityBase::toUrl
Webform::unsetThirdPartySettings public function Unsets all third-party settings of a given module. Overrides WebformInterface::unsetThirdPartySettings
Webform::updatePath protected function Saves a path alias to the database.
Webform::updatePaths public function Update submit and confirm paths (i.e. URL aliases) associated with this webform. Overrides WebformInterface::updatePaths
Webform::updateWebformHandler public function Update a webform handler for this webform. Overrides WebformInterface::updateWebformHandler
Webform::updateWebformVariant public function Update a webform variant for this webform. Overrides WebformInterface::updateWebformVariant
Webform::url public function Overriding so that URLs pointing to webform default to 'canonical' submission webform and not the back-end 'edit-form'. Overrides ConfigEntityBase::url
Webform::urlInfo public function Overriding so that URLs pointing to webform default to 'canonical' submission webform and not the back-end 'edit-form'. Overrides ConfigEntityBase::urlInfo
Webform::__toString public function Define empty to string method.
WebformInterface::ACCESS_DENIED_DEFAULT constant Display standard 403 access denied page.
WebformInterface::ACCESS_DENIED_LOGIN constant Redirect to user login with custom message.
WebformInterface::ACCESS_DENIED_MESSAGE constant Display customized access denied message.
WebformInterface::ACCESS_DENIED_PAGE constant Display customized 403 access denied page.
WebformInterface::CONFIRMATION_DEFAULT constant Webform confirmation default.
WebformInterface::CONFIRMATION_INLINE constant Webform confirmation inline.
WebformInterface::CONFIRMATION_MESSAGE constant Webform confirmation message.
WebformInterface::CONFIRMATION_MODAL constant Webform confirmation modal.
WebformInterface::CONFIRMATION_NONE constant Webform confirmation none.
WebformInterface::CONFIRMATION_PAGE constant Webform confirmation page.
WebformInterface::CONFIRMATION_URL constant Webform confirmation URL.
WebformInterface::CONFIRMATION_URL_MESSAGE constant Webform confirmation URL with message.
WebformInterface::DRAFT_ALL constant Denote drafts are allowed for authenticated and anonymous users.
WebformInterface::DRAFT_AUTHENTICATED constant Denote drafts are allowed for authenticated users only.
WebformInterface::DRAFT_NONE constant Denote drafts are not allowed.
WebformInterface::PAGE_CONFIRMATION constant Wizard confirmation page.
WebformInterface::PAGE_PREVIEW constant Wizard preview page.
WebformInterface::PAGE_START constant Wizard start page.
WebformInterface::STATUS_ARCHIVED constant Webform status archived.
WebformInterface::STATUS_CLOSED constant Webform status closed.
WebformInterface::STATUS_OPEN constant Webform status open.
WebformInterface::STATUS_SCHEDULED constant Webform status scheduled.
WebformInterface::TITLE_SOURCE_ENTITY constant Source entity title.
WebformInterface::TITLE_SOURCE_ENTITY_WEBFORM constant Both source entity and webform title.
WebformInterface::TITLE_WEBFORM constant Webform title.
WebformInterface::TITLE_WEBFORM_SOURCE_ENTITY constant Both webform and source entity title.
WebformRevision::$constants private property
WebformRevision::contentEntityCount public function Get the number of submissions related to a revision.
WebformRevision::deleteElement public function Remove an element. Overrides Webform::deleteElement
WebformRevision::deleteRelatedContentEntities public function Delete submissions related to a revision.