You are here

class WebformInfoDataDefinition in RULES WEBFORM 8

Same name and namespace in other branches
  1. 3.x src/WebformInfoDataDefinition.php \Drupal\rules_webform\WebformInfoDataDefinition

A typed data definition class for defining 'webform_info'.

Hierarchy

Expanded class hierarchy of WebformInfoDataDefinition

File

src/WebformInfoDataDefinition.php, line 10

Namespace

Drupal\rules_webform
View source
class WebformInfoDataDefinition extends MapDataDefinition {

  /**
   * Creates a new 'webform_info' definition.
   *
   * @param string $type
   *   (optional) The data type of the map Defaults to 'webform_info'.
   *
   * @return static
   */
  public static function create($type = 'webform_info') {
    $definition['type'] = $type;
    $webform_info_definition = new static($definition);
    $webform_info_definition
      ->setPropertyDefinition('id', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Webform ID'));
    $webform_info_definition
      ->setPropertyDefinition('title', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Webform Title'));
    $webform_info_definition
      ->setPropertyDefinition('submitter_id', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submitter ID'));
    $webform_info_definition
      ->setPropertyDefinition('submitter_name', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submitter Name'));
    $webform_info_definition
      ->setPropertyDefinition('submitter_email', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submitter Email'));

    /* ------ Submission Created Date and Time in different formats ---------------------------- */
    $created_definition = \Drupal::typedDataManager()
      ->createDataDefinition('map')
      ->setLabel('Submission Creation Date and Time');
    $created_definition
      ->setPropertyDefinition('timestamp', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Timestamp'));
    $created_definition
      ->setPropertyDefinition('date_short', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Short'));
    $created_definition
      ->setPropertyDefinition('date_medium', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Medium'));
    $created_definition
      ->setPropertyDefinition('date_long', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Long'));
    $created_definition
      ->setPropertyDefinition('html_datetime', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_datetime'));
    $created_definition
      ->setPropertyDefinition('html_date', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_date'));
    $created_definition
      ->setPropertyDefinition('html_time', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_time'));
    $webform_info_definition
      ->setPropertyDefinition('created', $created_definition);

    /* ------ Submission Completed Date and Time in different formats ---------------------------- */
    $completed_definition = \Drupal::typedDataManager()
      ->createDataDefinition('map')
      ->setLabel('Submission Completed Date and Time');
    $completed_definition
      ->setPropertyDefinition('timestamp', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Timestamp'));
    $completed_definition
      ->setPropertyDefinition('date_short', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Short'));
    $completed_definition
      ->setPropertyDefinition('date_medium', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Medium'));
    $completed_definition
      ->setPropertyDefinition('date_long', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Long'));
    $completed_definition
      ->setPropertyDefinition('html_datetime', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_datetime'));
    $completed_definition
      ->setPropertyDefinition('html_date', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_date'));
    $completed_definition
      ->setPropertyDefinition('html_time', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_time'));
    $webform_info_definition
      ->setPropertyDefinition('completed', $completed_definition);

    /* ------ Submission Changed Date and Time in different formats ---------------------------- */
    $changed_definition = \Drupal::typedDataManager()
      ->createDataDefinition('map')
      ->setLabel('Submission Changed Date and Time');
    $changed_definition
      ->setPropertyDefinition('timestamp', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Timestamp'));
    $changed_definition
      ->setPropertyDefinition('date_short', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Short'));
    $changed_definition
      ->setPropertyDefinition('date_medium', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Medium'));
    $changed_definition
      ->setPropertyDefinition('date_long', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: Date Long'));
    $changed_definition
      ->setPropertyDefinition('html_datetime', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_datetime'));
    $changed_definition
      ->setPropertyDefinition('html_date', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_date'));
    $changed_definition
      ->setPropertyDefinition('html_time', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Format: html_time'));
    $webform_info_definition
      ->setPropertyDefinition('changed', $changed_definition);

    /* ----------------------------------------------------------------------------------------- */
    $webform_info_definition
      ->setPropertyDefinition('number', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission Number'));
    $webform_info_definition
      ->setPropertyDefinition('id_submission', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission ID'));
    $webform_info_definition
      ->setPropertyDefinition('uuid', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission UUID'));
    $webform_info_definition
      ->setPropertyDefinition('uri', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission URI'));
    $webform_info_definition
      ->setPropertyDefinition('ip', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submitter IP address'));
    $webform_info_definition
      ->setPropertyDefinition('language', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission language'));
    $webform_info_definition
      ->setPropertyDefinition('is_draft', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission Is draft'));
    $webform_info_definition
      ->setPropertyDefinition('current_page', \Drupal::typedDataManager()
      ->createDataDefinition('string')
      ->setLabel('Submission Current page'));
    return $webform_info_definition;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ComplexDataDefinitionBase::$propertyDefinitions protected property An array of data definitions.
ComplexDataDefinitionBase::getPropertyDefinition public function Gets the definition of a contained property. Overrides ComplexDataDefinitionInterface::getPropertyDefinition
ComplexDataDefinitionBase::__sleep public function Overrides DataDefinition::__sleep
DataDefinition::$definition protected property The array holding values for all definition keys.
DataDefinition::addConstraint public function Adds a validation constraint. Overrides DataDefinitionInterface::addConstraint
DataDefinition::getClass public function Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass 1
DataDefinition::getConstraint public function Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints public function Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints 1
DataDefinition::getDataType public function Returns the data type of the data. Overrides DataDefinitionInterface::getDataType 2
DataDefinition::getDescription public function Returns a human readable description. Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel public function Returns a human readable label. Overrides DataDefinitionInterface::getLabel
DataDefinition::getSetting public function Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting 2
DataDefinition::getSettings public function Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings 2
DataDefinition::isComputed public function Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isInternal public function Determines whether the data value is internal. Overrides DataDefinitionInterface::isInternal 1
DataDefinition::isList public function Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly public function Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired public function Determines whether a data value is required. Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetGet public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetSet public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetUnset public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::setClass public function Sets the class used for creating the typed data object.
DataDefinition::setComputed public function Sets whether the data is computed.
DataDefinition::setConstraints public function Sets an array of validation constraints.
DataDefinition::setDataType public function Sets the data type. 1
DataDefinition::setDescription public function Sets the human-readable description.
DataDefinition::setInternal public function Sets the whether the data value should be internal.
DataDefinition::setLabel public function Sets the human-readable label.
DataDefinition::setReadOnly public function Sets whether the data is read-only.
DataDefinition::setRequired public function Sets whether the data is required.
DataDefinition::setSetting public function Sets a definition setting. 2
DataDefinition::setSettings public function Sets the array of settings, as required by the used class. 2
DataDefinition::toArray public function Returns all definition values as array.
DataDefinition::__construct public function Constructs a new data definition object. 1
MapDataDefinition::$mainPropertyName protected property The name of the main property, or NULL if there is none.
MapDataDefinition::createFromDataType public static function Creates a new data definition object. Overrides DataDefinition::createFromDataType
MapDataDefinition::getMainPropertyName public function Returns the name of the main property, if any. Overrides ComplexDataDefinitionBase::getMainPropertyName
MapDataDefinition::getPropertyDefinitions public function Gets an array of property definitions of contained properties. Overrides ComplexDataDefinitionBase::getPropertyDefinitions
MapDataDefinition::setMainPropertyName public function Sets the main property name.
MapDataDefinition::setPropertyDefinition public function Sets the definition of a map property.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2
WebformInfoDataDefinition::create public static function Creates a new 'webform_info' definition. Overrides MapDataDefinition::create