class Registration in Entity Registration 8.2

Main class for Registration entities.

Hierarchy

• class \Entity
  • class \Registration

39 string references to 'Registration'

registration.info.yml in ./registration.info.yml

registration.info.yml

RegistrationAPITestCase::getInfo in tests/registration.test

RegistrationAPITestCase::getInfo in src/RegistrationAPITestCase.php

RegistrationAPITestCase::testHookAccess in tests/registration.test

Test hook_registration_access().

RegistrationAPITestCase::testHookAccess in src/RegistrationAPITestCase.php

Test hook_registration_access().

... See full list

File

lib/registration.entity.inc, line 11

Entity hooks and callbacks for registrations.

class Registration extends Entity {
  public $registration_id, $type, $entity_id, $entity_type, $anon_mail, $registrant_id, $count, $author_uid, $state, $created, $updated;

  /**
   * Specifies the default label, which is picked up by label() by default.
   */
  protected function defaultLabel() {
    $wrapper = entity_metadata_wrapper('registration', $this);
    $host = $wrapper->entity
      ->value();
    if ($host) {
      return t('Registration for !title', array(
        '!title' => $host
          ->label(),
      ));
    }
    return '';
  }

  /**
   * Build content for Registration.
   *
   * @return array
   *   Render array for a registration entity.
   */
  public function buildContent($view_mode = 'full', $langcode = NULL) {
    $build = parent::buildContent($view_mode, $langcode);
    $wrapper = entity_metadata_wrapper('registration', $this);
    $host_entity_type_info = \Drupal::entityManager()
      ->getDefinition($this->entity_type);
    $host_entity = $wrapper->entity
      ->value();
    $state = $wrapper->state
      ->value();
    $author = $wrapper->author
      ->value();
    $registrant_type = $wrapper->registrant
      ->type();
    $registrant = $wrapper->registrant
      ->value();
    list(, , $host_entity_bundle) = entity_extract_ids($this->entity_type, $host_entity);
    $host_label = $host_entity
      ->label();
    $host_uri = $host_entity ? entity_uri($this->entity_type, $host_entity) : NULL;
    $build['mail'] = array(
      '#theme' => 'registration_property_field',
      '#label' => t('Email Address'),
      '#items' => array(
        array(
          '#markup' => $wrapper->registrant_mail
            ->value(),
        ),
      ),
      '#classes' => 'field field-label-inline clearfix',
    );

    // Link to host entity.
    $host_entity_link_label = isset($host_entity_type_info['bundles'][$host_entity_bundle]['label']) ? '<div class="field-label">' . $host_entity_type_info['bundles'][$host_entity_bundle]['label'] . '</div>' : '';

    // @FIXME
    // l() expects a Url object, created from a route name or external URI.
    // $build['host_entity_link'] = array(
    //       '#theme' => 'registration_property_field',
    //       '#label' => $host_entity_link_label,
    //       '#items' => array(
    //         array(
    //           '#markup' => l($host_label, $host_uri['path']),
    //         ),
    //       ),
    //       '#classes' => 'field field-label-inline clearfix',
    //     );
    $build['created'] = array(
      '#theme' => 'registration_property_field',
      '#label' => t('Created'),
      '#items' => array(
        array(
          '#markup' => format_date($this->created),
        ),
      ),
      '#classes' => 'field field-label-inline clearfix',
    );
    $build['updated'] = array(
      '#theme' => 'registration_property_field',
      '#label' => t('Updated'),
      '#items' => array(
        array(
          '#markup' => format_date($this->updated),
        ),
      ),
      '#classes' => 'field field-label-inline clearfix',
    );
    $build['spaces'] = array(
      '#theme' => 'registration_property_field',
      '#label' => t('Slots Used'),
      '#items' => array(
        array(
          '#markup' => $this->count,
        ),
      ),
      '#classes' => 'field field-label-inline clearfix',
    );
    if ($author) {

      // @FIXME
      // theme() has been renamed to _theme() and should NEVER be called directly.
      // Calling _theme() directly can alter the expected output and potentially
      // introduce security issues (see https://www.drupal.org/node/2195739). You
      // should use renderable arrays instead.
      //
      //
      // @see https://www.drupal.org/node/2195739
      // $build['author'] = array(
      //         '#theme' => 'registration_property_field',
      //         '#label' => t('Author'),
      //         '#items' => array(
      //           array(
      //             '#markup' => theme('username', array('account' => $author)),
      //           ),
      //         ),
      //         '#classes' => 'field field-label-inline clearfix',
      //         '#attributes' => '',
      //       );
    }

    // @FIXME
    // theme() has been renamed to _theme() and should NEVER be called directly.
    // Calling _theme() directly can alter the expected output and potentially
    // introduce security issues (see https://www.drupal.org/node/2195739). You
    // should use renderable arrays instead.
    //
    //
    // @see https://www.drupal.org/node/2195739
    // $build['registrant'] = array(
    //       '#theme' => 'registration_property_field',
    //       '#label' => t('Registrant'),
    //       '#items' => array(
    //         array(
    //           '#markup' => theme('registration_registrant_link', array(
    //             'registrant_type' => $registrant_type,
    //             'registrant' => $registrant,
    //           )),
    //         ),
    //       ),
    //       '#classes' => 'field field-label-inline clearfix',
    //       '#attributes' => '',
    //     );
    $build['state'] = array(
      '#theme' => 'registration_property_field',
      '#label' => t('State'),
      '#items' => array(
        array(
          '#markup' => $state ? \Drupal\Component\Utility\Xss::filterAdmin($state
            ->label()) : '',
        ),
      ),
      '#classes' => 'field field-label-inline clearfix',
    );
    return $build;
  }

  /**
   * Save registration.
   *
   * @see entity_save()
   */
  public function save() {

    // Set a default state if not provided.
    $wrapper = entity_metadata_wrapper('registration', $this);
    $state = $wrapper->state
      ->value();
    if (!$state) {
      $default_state = registration_get_default_state($wrapper->type
        ->value());
      if ($default_state) {
        $this->state = $default_state
          ->identifier();
      }
    }
    $this->updated = REQUEST_TIME;
    if (!$this->registration_id && empty($this->created)) {
      $this->created = REQUEST_TIME;
    }
    return parent::save();
  }

  /**
   * Specify URI.
   */
  protected function defaultUri() {
    return array(
      'path' => 'registration/' . $this
        ->internalIdentifier(),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Registration::$registration_id	public	property
Registration::buildContent	public	function	Build content for Registration.
Registration::defaultLabel	protected	function	Specifies the default label, which is picked up by label() by default.
Registration::defaultUri	protected	function	Specify URI.
Registration::save	public	function	Save registration.