public function RegistrationMetadataController::entityPropertyInfo in Entity Registration 8.2

Same name in this branch

1. 8.2 lib/registration.metadata.inc \RegistrationMetadataController::entityPropertyInfo()
2. 8.2 src/RegistrationMetadataController.php \Drupal\registration\RegistrationMetadataController::entityPropertyInfo()

Same name and namespace in other branches

1. 8 src/RegistrationMetadataController.php \Drupal\registration\RegistrationMetadataController::entityPropertyInfo()

File

src/RegistrationMetadataController.php, line 10

Class

RegistrationMetadataController

@file

Namespace

Drupal\registration

Code

public function entityPropertyInfo() {
  $info = parent::entityPropertyInfo();
  $properties =& $info[$this->type]['properties'];
  $properties['registration_id'] = array(
    'label' => t("Registration ID"),
    'type' => 'integer',
    'description' => t("The unique ID of the registration."),
    'schema field' => 'registration_id',
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['type'] = array(
    'label' => t("Registration type"),
    'type' => 'token',
    'description' => t("The type of the registration."),
    'options list' => 'registration_type_get_names',
    'required' => TRUE,
    'schema field' => 'type',
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['entity_type'] = array(
    'label' => t("Host entity type"),
    'type' => 'token',
    'description' => t("The entity type of the host entity."),
    'required' => TRUE,
    'schema field' => 'entity_type',
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['entity_id'] = array(
    'label' => t("Host entity ID"),
    'type' => 'integer',
    'description' => t("The entity ID of the host entity."),
    'required' => TRUE,
    'schema field' => 'entity_id',
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['count'] = array(
    'label' => t("Slots consumed"),
    'type' => 'integer',
    'description' => t("How many slots the registration consumes from the host entity."),
    'schema field' => 'count',
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['created'] = array(
    'label' => t("Date created"),
    'type' => 'date',
    'schema field' => 'created',
    'description' => t("The date the registration was created."),
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['updated'] = array(
    'label' => t("Date updated"),
    'type' => 'date',
    'schema field' => 'updated',
    'description' => t("The date the registration was most recently updated."),
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['anon_mail'] = array(
    'label' => t('Anonymous e-mail'),
    'type' => 'text',
    'schema field' => 'anon_mail',
    'description' => t('An e-mail address associated with the registration of an anonymous user.'),
    'setter callback' => 'entity_property_verbatim_set',
  );

  // Provides a single calculated property that contains the associated registrant's email address.
  $properties['registrant_mail'] = array(
    'label' => t('Registrant e-mail'),
    'type' => 'text',
    'description' => t('The registrant\'s email address.'),
    'getter callback' => 'registration_property_registrant_mail_get',
    'computed' => TRUE,
  );

  // Entities
  $properties['entity'] = array(
    'label' => t("Host entity"),
    'type' => 'entity',
    'schema field' => 'entity',
    'description' => t("The host entity."),
    'getter callback' => 'registration_property_host_get',
    'setter callback' => 'registration_property_host_set',
  );
  $properties['author'] = array(
    'label' => t("Author entity"),
    'type' => 'user',
    'schema field' => 'author_uid',
    'description' => t("The user who created the registration."),
    'getter callback' => 'registration_property_author_get',
    'setter callback' => 'entity_property_verbatim_set',
  );
  $properties['registrant'] = array(
    'label' => t("Registrant entity"),
    'type' => 'entity',
    'schema field' => 'registrant_id',
    'description' => t("The entity for which the registration belongs to. Usually a user."),
    'getter callback' => 'registration_property_registrant_get',
    'setter callback' => 'registration_property_registrant_set',
  );
  $properties['state'] = array(
    'label' => t("State entity"),
    'type' => 'registration_state',
    'schema field' => 'state',
    'options list' => 'registration_get_states_options',
    'description' => t("The state of the registration."),
    'setter callback' => 'entity_property_verbatim_set',
  );
  return $info;
}