Connection.php in RedHen CRM 8

Namespace

Drupal\redhen_connection\Entity

File

modules/redhen_connection/src/Entity/Connection.php

<?php

namespace Drupal\redhen_connection\Entity;

use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\redhen_connection\ConnectionInterface;

/**
 * Defines the Connection entity.
 *
 * @ingroup redhen_connection
 *
 * @ContentEntityType(
 *   id = "redhen_connection",
 *   label = @Translation("Connection"),
 *   label_singular = @Translation("Connection"),
 *   label_plural = @Translation("Connections"),
 *   label_count = @PluralTranslation(
 *     singular = "@count Connection",
 *     plural = "@count Connections",
 *   ),
 *   bundle_label = @Translation("Connection type"),
 *   handlers = {
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\redhen_connection\ConnectionListBuilder",
 *     "views_data" = "Drupal\redhen_connection\Entity\ConnectionViewsData",
 *
 *     "form" = {
 *       "default" = "Drupal\redhen_connection\Form\ConnectionForm",
 *       "add" = "Drupal\redhen_connection\Form\ConnectionForm",
 *       "edit" = "Drupal\redhen_connection\Form\ConnectionForm",
 *       "delete" = "Drupal\redhen_connection\Form\ConnectionDeleteForm",
 *     },
 *     "access" = "Drupal\redhen_connection\ConnectionAccessControlHandler",
 *     "route_provider" = {
 *       "html" = "Drupal\redhen_connection\ConnectionHtmlRouteProvider",
 *     },
 *   },
 *   base_table = "redhen_connection",
 *   revision_table = "redhen_connection_revision",
 *   admin_permission = "administer connection entities",
 *   entity_keys = {
 *     "id" = "id",
 *     "revision" = "revision_id",
 *     "bundle" = "type",
 *     "uuid" = "uuid",
 *     "uid" = "user_id",
 *     "langcode" = "langcode",
 *     "status" = "status",
 *   },
 *   links = {
 *     "canonical" = "/redhen/connection/{redhen_connection}",
 *     "add-form" = "/redhen/{redhen_type}/{entity}/connection/add/{redhen_connection_type}",
 *     "edit-form" = "/redhen/connection/{redhen_connection}/edit",
 *     "delete-form" = "/redhen/connection/{redhen_connection}/delete",
 *     "collection" = "/redhen/connection",
 *   },
 *   bundle_entity_type = "redhen_connection_type",
 *   field_ui_base_route = "entity.redhen_connection_type.edit_form"
 * )
 */
class Connection extends ContentEntityBase implements ConnectionInterface {
  use EntityChangedTrait;
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function label() {
    $label_pattern = $this->type->entity
      ->get('connection_label_pattern');
    return $this
      ->t($label_pattern, [
      '@label1' => $this
        ->get('endpoint_1')->entity ? $this
        ->get('endpoint_1')->entity
        ->label() : "[entity 1 not found]",
      '@label2' => $this
        ->get('endpoint_2')->entity ? $this
        ->get('endpoint_2')->entity
        ->label() : "[entity 2 not found]",
    ]);
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function isActive() {
    return (bool) $this
      ->getEntityKey('status');
  }

  /**
   * {@inheritdoc}
   */
  public function setActive($active) {
    $this
      ->set('status', $active ? REDHEN_CONNECTION_ACTIVE : REDHEN_CONNECTION_INACTIVE);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);

    // Define base fields "endpoint_X" for each our endpoints.
    for ($x = 1; $x <= REDHEN_CONNECTION_ENDPOINTS; $x++) {

      // Set first endpoint to redhen_contact and second to redhen_org by default.
      $default_type = $x & 1 ? 'redhen_contact' : 'redhen_org';
      $fields["endpoint_{$x}"] = BaseFieldDefinition::create('entity_reference')
        ->setLabel(t('Endpoint @x', [
        '@x' => $x,
      ]))
        ->setRequired(TRUE)
        ->setSetting('target_type', $default_type)
        ->setDisplayOptions('form', [
        'type' => 'entity_reference_autocomplete',
        'weight' => -1,
        'settings' => [
          'match_operator' => 'CONTAINS',
          'size' => '60',
          'placeholder' => '',
        ],
      ])
        ->setDisplayConfigurable('form', TRUE)
        ->setDisplayConfigurable('view', TRUE);
    }
    $fields['role'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Role'))
      ->setRequired(TRUE)
      ->setRevisionable(TRUE)
      ->setSetting('target_type', 'redhen_connection_role')
      ->setSetting('handler', 'default')
      ->setDisplayOptions('form', [
      'type' => 'options_select',
      'weight' => -1,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['status'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Active'))
      ->setDescription(t('A boolean indicating whether the connection is active.'))
      ->setDefaultValue(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'settings' => [
        'display_label' => TRUE,
      ],
      'weight' => 16,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setRevisionable(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the connection was created.'))
      ->setRevisionable(TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the connection was last edited.'))
      ->setRevisionable(TRUE);
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {

    /** @var \Drupal\redhen_connection\ConnectionTypeInterface $connection_type */
    $connection_type = ConnectionType::load($bundle);
    $fields = [];

    // Set bundle specific settings for each of our endpoint fields.
    for ($x = 1; $x <= REDHEN_CONNECTION_ENDPOINTS; $x++) {

      /** @var \Drupal\Core\Field\BaseFieldDefinition $fields[$field] */
      $endpoint_type = $connection_type
        ->getEndpointEntityTypeId($x);
      $field = 'endpoint_' . $x;
      $fields[$field] = clone $base_field_definitions[$field];
      if ($endpoint_type) {
        $bundles = $connection_type
          ->getEndpointBundles($x);
        $endpoint_entity = \Drupal::entityTypeManager()
          ->getDefinition($endpoint_type);
        $label = !empty($connection_type
          ->getEndpointLabel($x)) ? $connection_type
          ->getEndpointLabel($x) : $endpoint_entity
          ->getLabel();
        $fields[$field]
          ->setSetting('target_type', $endpoint_type)
          ->setLabel($label);
        if (!empty($connection_type
          ->getEndpointDescription($x))) {
          $fields[$field]
            ->setDescription($connection_type
            ->getEndpointDescription($x));
        }
        if (!empty($bundles)) {
          $fields[$field]
            ->setSetting('handler_settings', [
            'target_bundles' => $bundles,
          ]);
        }
      }
    }
    $fields['role'] = clone $base_field_definitions['role'];
    $fields['role']
      ->setSetting('handler_settings', [
      'connection_type' => $connection_type
        ->id(),
    ]);
    return $fields;
  }

}

Classes

Name	Description
Connection	Defines the Connection entity.