You are here

Home » API reference » YAML Form 8 » YamlFormSubmission.php

class YamlFormSubmission in YAML Form 8

Defines the YamlFormSubmission entity.

Plugin annotation


@ContentEntityType(
  id = "yamlform_submission",
  label = @Translation("Form submission"),
  bundle_label = @Translation("Form"),
  handlers = {
    "storage" = "Drupal\yamlform\YamlFormSubmissionStorage",
    "storage_schema" = "Drupal\yamlform\YamlFormSubmissionStorageSchema",
    "views_data" = "Drupal\views\EntityViewsData",
    "view_builder" = "Drupal\yamlform\YamlFormSubmissionViewBuilder",
    "list_builder" = "Drupal\yamlform\YamlFormSubmissionListBuilder",
    "access" = "Drupal\yamlform\YamlFormSubmissionAccessControlHandler",
    "form" = {
      "default" = "Drupal\yamlform\YamlFormSubmissionForm",
      "notes" = "Drupal\yamlform\YamlFormSubmissionNotesForm",
      "delete" = "Drupal\yamlform\Form\YamlFormSubmissionDeleteForm",
    },
  },
  bundle_entity_type = "yamlform",
  list_cache_contexts = { "user" },
  base_table = "yamlform_submission",
  admin_permission = "administer yamlform",
  entity_keys = {
    "id" = "sid",
    "bundle" = "yamlform_id",
    "uuid" = "uuid"
  },
  links = {
    "canonical" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}",
    "table" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/table",
    "text" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/text",
    "yaml" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/yaml",
    "edit-form" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/edit",
    "notes-form" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/notes",
    "resend-form" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/resend",
    "delete-form" = "/admin/structure/yamlform/manage/{yamlform}/submission/{yamlform_submission}/delete",
    "collection" = "/admin/structure/yamlform/results/manage/list"
  },
  permission_granularity = "bundle"
)

Hierarchy

Expanded class hierarchy of YamlFormSubmission

17 files declare their use of YamlFormSubmission
YamlFormElementAccessTest.php in src/Tests/YamlFormElementAccessTest.php
YamlFormElementFormatTest.php in src/Tests/YamlFormElementFormatTest.php
YamlFormElementManagedFileTest.php in src/Tests/YamlFormElementManagedFileTest.php
YamlFormElementPluginTest.php in src/Tests/YamlFormElementPluginTest.php
YamlFormHandlerEmailBasicTest.php in src/Tests/YamlFormHandlerEmailBasicTest.php

... See full list

File

src/Entity/YamlFormSubmission.php, line 63

Namespace

Drupal\yamlform\Entity
View source 
class YamlFormSubmission extends ContentEntityBase implements YamlFormSubmissionInterface {
  use EntityChangedTrait;
  use StringTranslationTrait;

  /**
   * Store a reference to the current temporary form.
   *
   * @var \Drupal\yamlform\YamlFormInterface
   *
   * @see \Drupal\yamlform\YamlFormEntityElementsValidator::validateRendering()
   */
  protected static $yamlform;

  /**
   * The data.
   *
   * @var array
   */
  protected $data = [];

  /**
   * Reference to original data loaded before any updates.
   *
   * @var array
   */
  protected $originalData = [];

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['serial'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Serial number'))
      ->setDescription(t('The serial number of the form submission entity.'))
      ->setReadOnly(TRUE);
    $fields['sid'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Submission ID'))
      ->setDescription(t('The ID of the form submission entity.'))
      ->setReadOnly(TRUE);
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('Submission UUID'))
      ->setDescription(t('The UUID of the form submission entity.'))
      ->setReadOnly(TRUE);
    $fields['token'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Token'))
      ->setDescription(t('A secure token used to look up a submission.'))
      ->setSetting('max_length', 255)
      ->setReadOnly(TRUE);
    $fields['uri'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Submission URI'))
      ->setDescription(t('The URI the user submitted the form.'))
      ->setSetting('max_length', 2000)
      ->setReadOnly(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the form submission was first saved as draft or submitted.'));
    $fields['completed'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(t('Completed'))
      ->setDescription(t('The time that the form submission was submitted as complete (not draft).'));
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the form submission was last saved (complete or draft).'));
    $fields['in_draft'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Is draft'))
      ->setDescription(t('Is this a draft of the submission?'))
      ->setDefaultValue(FALSE);
    $fields['current_page'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Current page'))
      ->setDescription(t('The current wizard page.'))
      ->setSetting('max_length', 128);
    $fields['remote_addr'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Remote IP address'))
      ->setDescription(t('The IP address of the user that submitted the form.'))
      ->setSetting('max_length', 128);
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Submitted by'))
      ->setDescription(t('The submitter.'))
      ->setSetting('target_type', 'user');
    $fields['langcode'] = BaseFieldDefinition::create('language')
      ->setLabel(t('Language'))
      ->setDescription(t('The submission language code.'));
    $fields['yamlform_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Form'))
      ->setDescription(t('The associated yamlform.'))
      ->setSetting('target_type', 'yamlform');
    $fields['entity_type'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Submitted to: Entity type'))
      ->setDescription(t('The entity type to which this submission was submitted from.'))
      ->setSetting('is_ascii', TRUE)
      ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH);

    // Can't use entity reference without a target type because it defaults to
    // an integer which limits reference to only content entities (and not
    // config entities like Views, Panels, etc...).
    // @see \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem::propertyDefinitions()
    $fields['entity_id'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Submitted to: Entity ID'))
      ->setDescription(t('The ID of the entity of which this form submission was submitted from.'))
      ->setSetting('max_length', 255);
    $fields['sticky'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Sticky'))
      ->setDescription(t('A flag that indicate the status of the form submission.'))
      ->setDefaultValue(FALSE);
    $fields['notes'] = BaseFieldDefinition::create('string_long')
      ->setLabel(t('Notes'))
      ->setDescription(t('Administrative notes about the form submission.'))
      ->setDefaultValue('');
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function serial() {
    return $this->serial->value;
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    $t_args = [
      '@id' => $this
        ->serial(),
    ];
    if ($source_entity = $this
      ->getSourceEntity()) {
      $t_args['@form'] = $source_entity
        ->label();
    }
    else {
      $t_args['@form'] = $this
        ->getYamlForm()
        ->label();
    }
    return $this
      ->t('@form: Submission #@id', $t_args);
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    if (isset($this
      ->get('created')->value)) {
      return $this
        ->get('created')->value;
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($created) {
    $this
      ->set('created', $created);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getChangedTime() {
    return $this
      ->get('changed')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setChangedTime($timestamp) {
    $this
      ->set('changed', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCompletedTime() {
    return $this
      ->get('completed')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCompletedTime($timestamp) {
    $this
      ->set('completed', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getNotes() {
    return $this
      ->get('notes')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setNotes($notes) {
    $this
      ->set('notes', $notes);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSticky() {
    return $this
      ->get('sticky')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setSticky($sticky) {
    $this
      ->set('sticky', $sticky);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRemoteAddr() {
    return $this
      ->get('remote_addr')->value ?: $this
      ->t('(unknown)');
  }

  /**
   * {@inheritdoc}
   */
  public function setRemoteAddr($ip_address) {
    $this
      ->set('remote_addr', $ip_address);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCurrentPage() {
    return $this
      ->get('current_page')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCurrentPage($current_page) {
    $this
      ->set('current_page', $current_page);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCurrentPageTitle() {
    $current_page = $this
      ->getCurrentPage();
    $page = $this
      ->getYamlForm()
      ->getPage($current_page);
    return $page && isset($page['#title']) ? $page['#title'] : $current_page;
  }

  /**
   * {@inheritdoc}
   */
  public function getData($key = NULL) {
    if (isset($key)) {
      return isset($this->data[$key]) ? $this->data[$key] : NULL;
    }
    else {
      return $this->data;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setData(array $data) {
    $this->data = $data;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOriginalData($key = NULL) {
    if ($key !== NULL) {
      return isset($this->originalData[$key]) ? $this->originalData[$key] : NULL;
    }
    else {
      return $this->originalData;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setOriginalData(array $data) {
    $this->originalData = $data;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getToken() {
    return $this->token->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getYamlForm() {
    if (isset($this->yamlform_id->entity)) {
      return $this->yamlform_id->entity;
    }
    else {
      return self::$yamlform;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getSourceEntity() {
    if ($this->entity_type->value && $this->entity_id->value) {
      $entity_type = $this->entity_type->value;
      $entity_id = $this->entity_id->value;
      return $this
        ->entityTypeManager()
        ->getStorage($entity_type)
        ->load($entity_id);
    }
    else {
      return NULL;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getSourceUrl() {
    $uri = $this->uri->value;
    if ($uri !== NULL && ($url = \Drupal::pathValidator()
      ->getUrlIfValid($uri))) {
      return $url
        ->setOption('absolute', TRUE);
    }
    elseif ($entity = $this
      ->getSourceEntity()) {
      return $entity
        ->toUrl()
        ->setOption('absolute', TRUE);
    }
    else {
      return $this
        ->getYamlForm()
        ->toUrl()
        ->setOption('absolute', TRUE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getTokenUrl() {
    return $this
      ->getSourceUrl()
      ->setOption('query', [
      'token' => $this->token->value,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function invokeYamlFormHandlers($method, &$context1 = NULL, &$context2 = NULL) {
    if ($yamlform = $this
      ->getYamlForm()) {
      $yamlform
        ->invokeHandlers($method, $this, $context1, $context2);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function invokeYamlFormElements($method, &$context1 = NULL, &$context2 = NULL) {
    if ($yamlform = $this
      ->getYamlForm()) {
      $yamlform
        ->invokeElements($method, $this, $context1, $context2);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    $user = $this
      ->get('uid')->entity;
    if (!$user || $user
      ->isAnonymous()) {
      $user = User::getAnonymousUser();
    }
    return $user;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->get('uid')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this
      ->set('uid', $uid);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this
      ->set('uid', $account
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isDraft() {
    return $this
      ->get('in_draft')->value ? TRUE : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isCompleted() {
    return $this
      ->get('completed')->value ? TRUE : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isSticky() {
    return (bool) $this
      ->get('sticky')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function hasNotes() {
    return $this->notes ? TRUE : FALSE;
  }

  /**
   * Track the state of a submission.
   *
   * @return int
   *    Either STATE_NEW, STATE_DRAFT, STATE_COMPLETED, or STATE_UPDATED,
   *   depending on the last save operation performed.
   */
  public function getState() {
    if (!$this
      ->id()) {
      return self::STATE_UNSAVED;
    }
    elseif ($this
      ->isDraft()) {
      return self::STATE_DRAFT;
    }
    elseif ($this->completed->value == $this->changed->value) {
      return self::STATE_COMPLETED;
    }
    else {
      return self::STATE_UPDATED;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    $uri_route_parameters = parent::urlRouteParameters($rel);
    $uri_route_parameters['yamlform'] = $this
      ->getYamlForm()
      ->id();
    return $uri_route_parameters;
  }

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage, array &$values) {
    if (empty($values['yamlform_id']) && empty($values['yamlform'])) {
      if (empty($values['yamlform_id'])) {
        throw new \Exception('Form id (yamlform_id) is required to create a form submission.');
      }
      elseif (empty($values['yamlform'])) {
        throw new \Exception('Form (yamlform) is required to create a form submission.');
      }
    }

    // Get temporary form entity and store it in the static
    // YamlFormSubmission::$yamlform property.
    // This could be reworked to use \Drupal\user\PrivateTempStoreFactory
    // but it might be overkill since we are just using this to validate
    // that a form's elements can be rendered.
    // @see \Drupal\yamlform\YamlFormEntityElementsValidator::validateRendering()
    // @see \Drupal\yamlform_ui\Form\YamlFormUiElementTestForm::buildForm()
    if (isset($values['yamlform']) && $values['yamlform'] instanceof YamlFormInterface) {
      $yamlform = $values['yamlform'];
      self::$yamlform = $values['yamlform'];
      $values['yamlform_id'] = 'temp';
    }
    else {

      /** @var \Drupal\yamlform\YamlFormInterface $yamlform */
      $yamlform = YamlForm::load($values['yamlform_id']);
      self::$yamlform = NULL;
    }

    // Get request's source entity parameter.

    /** @var \Drupal\yamlform\YamlFormRequestInterface $request_handler */
    $request_handler = \Drupal::service('yamlform.request');
    $source_entity = $request_handler
      ->getCurrentSourceEntity('yamlform');
    $values += [
      'entity_type' => $source_entity ? $source_entity
        ->getEntityTypeId() : NULL,
      'entity_id' => $source_entity ? $source_entity
        ->id() : NULL,
    ];

    // Decode all data in an array.
    if (empty($values['data'])) {
      $values['data'] = [];
    }
    elseif (is_string($values['data'])) {
      $values['data'] = Yaml::decode($values['data']);
    }

    // Get default date from source entity 'yamlform' field.
    if ($values['entity_type'] && $values['entity_id']) {
      $source_entity = \Drupal::entityTypeManager()
        ->getStorage($values['entity_type'])
        ->load($values['entity_id']);
      if ($source_entity && method_exists($source_entity, 'hasField') && $source_entity
        ->hasField('yamlform')) {
        foreach ($source_entity->yamlform as $item) {
          if ($item->target_id == $yamlform
            ->id() && $item->default_data) {
            $values['data'] += Yaml::decode($item->default_data);
          }
        }
      }
    }

    // Set default uri and remote_addr.
    $current_request = \Drupal::requestStack()
      ->getCurrentRequest();
    $values += [
      'uri' => preg_replace('#^' . base_path() . '#', '/', $current_request
        ->getRequestUri()),
      'remote_addr' => $yamlform && $yamlform
        ->isConfidential() ? '' : $current_request
        ->getClientIp(),
    ];

    // Get default uid and langcode.
    $values += [
      'uid' => \Drupal::currentUser()
        ->id(),
      'langcode' => \Drupal::languageManager()
        ->getCurrentLanguage()
        ->getId(),
    ];

    // Hard code the token.
    $values['token'] = Crypt::randomBytesBase64();

    // Set is draft.
    $values['in_draft'] = FALSE;
    $yamlform
      ->invokeHandlers(__FUNCTION__, $values);
    $yamlform
      ->invokeElements(__FUNCTION__, $values);
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    $this->changed->value = REQUEST_TIME;
    if ($this
      ->isDraft()) {
      $this->completed->value = NULL;
    }
    elseif (!$this
      ->isCompleted()) {
      $this->completed->value = REQUEST_TIME;
    }
    parent::preSave($storage);
  }

  /**
   * {@inheritdoc}
   */
  public function save() {

    // Clear the remote_addr for confidential submissions.
    if ($this
      ->getYamlForm()
      ->isConfidential()) {
      $this
        ->get('remote_addr')->value = '';
    }
    return parent::save();
  }

  /**
   * {@inheritdoc}
   */
  public function toArray($custom = FALSE) {
    if ($custom === FALSE) {
      return parent::toArray();
    }
    else {
      $values = parent::toArray();
      foreach ($values as $key => $item) {

        // Issue #2567899 It seems it is impossible to save an empty string to an entity.
        // @see https://www.drupal.org/node/2567899
        // Solution: Set empty (aka NULL) items to an empty string.
        if (empty($item)) {
          $values[$key] = '';
        }
        else {
          $value = reset($item);
          $values[$key] = reset($value);
        }
      }
      $values['data'] = $this
        ->getData();
      return $values;
    }
  }

}

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.
ContentEntityBase::$activeLangcode protected property Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode protected property Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey protected property The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected protected property Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys protected property Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions protected property Local cache for field definitions.
ContentEntityBase::$fields protected property The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck protected static property Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision protected property Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey protected property The language entity key.
ContentEntityBase::$languages protected property Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId protected property The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision protected property Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey protected property The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys protected property Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize protected property A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations protected property An array of entity translation metadata.
ContentEntityBase::$validated protected property Whether entity validation was performed.
ContentEntityBase::$validationRequired protected property Whether entity validation is required before saving the entity.
ContentEntityBase::$values protected property The plain data values of the contained fields.
ContentEntityBase::access public function Checks data value access. Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions 4
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions public function Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields public function Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. 1
ContentEntityBase::getIterator public function
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId public function Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields public function Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages public function Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField public function Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation public function Checks there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id public function Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation public function Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision public function Checks if this entity is the latest revision. Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision public function Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation public function Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable public function Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired public function Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
ContentEntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 5
ContentEntityBase::preSaveRevision public function Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision 2
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set public function Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected public function Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired public function Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
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
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::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::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 2
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
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::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
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::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 1
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
EntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 1
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 4
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::url public function Gets the public URL for this entity. Overrides EntityInterface::url 2
EntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangedTrait::getChangedTimeAcrossTranslations public function Returns the timestamp of the last entity change across all translations.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
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
TranslationStatusInterface::TRANSLATION_CREATED constant Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING constant Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED constant Status code identifying a removed translation.
YamlFormSubmission::$data protected property The data.
YamlFormSubmission::$originalData protected property Reference to original data loaded before any updates.
YamlFormSubmission::$yamlform protected static property Store a reference to the current temporary form.
YamlFormSubmission::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
YamlFormSubmission::getChangedTime public function Gets the timestamp of the last entity change for the current translation. Overrides EntityChangedTrait::getChangedTime
YamlFormSubmission::getCompletedTime public function Gets the timestamp of the submission completion. Overrides YamlFormSubmissionInterface::getCompletedTime
YamlFormSubmission::getCreatedTime public function Returns the time that the submission was created. Overrides YamlFormSubmissionInterface::getCreatedTime
YamlFormSubmission::getCurrentPage public function Gets the submission's current page. Overrides YamlFormSubmissionInterface::getCurrentPage
YamlFormSubmission::getCurrentPageTitle public function Get the submission's current page title. Overrides YamlFormSubmissionInterface::getCurrentPageTitle
YamlFormSubmission::getData public function Gets the form submission's data. Overrides YamlFormSubmissionInterface::getData
YamlFormSubmission::getNotes public function Get the submission's notes. Overrides YamlFormSubmissionInterface::getNotes
YamlFormSubmission::getOriginalData public function Gets the form submission's original data before any changes.. Overrides YamlFormSubmissionInterface::getOriginalData
YamlFormSubmission::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
YamlFormSubmission::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
YamlFormSubmission::getRemoteAddr public function Gets the remote IP address of the submission. Overrides YamlFormSubmissionInterface::getRemoteAddr
YamlFormSubmission::getSourceEntity public function Gets the form submission's source entity. Overrides YamlFormSubmissionInterface::getSourceEntity
YamlFormSubmission::getSourceUrl public function Gets the form submission's source URL. Overrides YamlFormSubmissionInterface::getSourceUrl
YamlFormSubmission::getState public function Track the state of a submission. Overrides YamlFormSubmissionInterface::getState
YamlFormSubmission::getSticky public function Get the submission's sticky flag. Overrides YamlFormSubmissionInterface::getSticky
YamlFormSubmission::getToken public function Gets the form submission's token. Overrides YamlFormSubmissionInterface::getToken
YamlFormSubmission::getTokenUrl public function Gets the form submission's secure tokenized URL. Overrides YamlFormSubmissionInterface::getTokenUrl
YamlFormSubmission::getYamlForm public function Gets the form submission's form entity. Overrides YamlFormSubmissionInterface::getYamlForm
YamlFormSubmission::hasNotes public function Checks submission notes. Overrides YamlFormSubmissionInterface::hasNotes
YamlFormSubmission::invokeYamlFormElements public function Invoke a form element elements method. Overrides YamlFormSubmissionInterface::invokeYamlFormElements
YamlFormSubmission::invokeYamlFormHandlers public function Invoke all form handlers method. Overrides YamlFormSubmissionInterface::invokeYamlFormHandlers
YamlFormSubmission::isCompleted public function Is the current submission completed. Overrides YamlFormSubmissionInterface::isCompleted
YamlFormSubmission::isDraft public function Is the current submission in draft. Overrides YamlFormSubmissionInterface::isDraft
YamlFormSubmission::isSticky public function Returns the submission sticky status. Overrides YamlFormSubmissionInterface::isSticky
YamlFormSubmission::label public function Gets the label of the entity. Overrides ContentEntityBase::label
YamlFormSubmission::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
YamlFormSubmission::preSave public function Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
YamlFormSubmission::save public function Saves an entity permanently. Overrides EntityBase::save
YamlFormSubmission::serial public function Gets the serial number. Overrides YamlFormSubmissionInterface::serial
YamlFormSubmission::setChangedTime public function Sets the timestamp of the last entity change for the current translation. Overrides EntityChangedTrait::setChangedTime
YamlFormSubmission::setCompletedTime public function Sets the timestamp of the submission completion. Overrides YamlFormSubmissionInterface::setCompletedTime
YamlFormSubmission::setCreatedTime public function Sets the creation date of the submission. Overrides YamlFormSubmissionInterface::setCreatedTime
YamlFormSubmission::setCurrentPage public function Sets the submission's current page. Overrides YamlFormSubmissionInterface::setCurrentPage
YamlFormSubmission::setData public function Set the form submission's data. Overrides YamlFormSubmissionInterface::setData
YamlFormSubmission::setNotes public function Sets the submission's notes. Overrides YamlFormSubmissionInterface::setNotes
YamlFormSubmission::setOriginalData public function Set the form submission's original data. Overrides YamlFormSubmissionInterface::setOriginalData
YamlFormSubmission::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
YamlFormSubmission::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
YamlFormSubmission::setRemoteAddr public function Sets remote IP address of the submission. Overrides YamlFormSubmissionInterface::setRemoteAddr
YamlFormSubmission::setSticky public function Sets the submission's sticky flag. Overrides YamlFormSubmissionInterface::setSticky
YamlFormSubmission::toArray public function Gets an array of all property values. Overrides ContentEntityBase::toArray
YamlFormSubmission::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
YamlFormSubmissionInterface::STATE_COMPLETED constant Return status for submission that has been completed.
YamlFormSubmissionInterface::STATE_DRAFT constant Return status for submission in draft.
YamlFormSubmissionInterface::STATE_UNSAVED constant Return status for new submission.
YamlFormSubmissionInterface::STATE_UPDATED constant Return status for submission that has been updated.