Org.php in RedHen CRM 8

Namespace

Drupal\redhen_org\Entity

File

modules/redhen_org/src/Entity/Org.php

<?php

namespace Drupal\redhen_org\Entity;

use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\redhen_org\OrgInterface;

/**
 * Defines the Organization entity.
 *
 * @ingroup redhen_org
 *
 * @ContentEntityType(
 *   id = "redhen_org",
 *   label = @Translation("Organization"),
 *   label_singular = @Translation("organiation"),
 *   label_plural = @Translation("organizations"),
 *   label_count = @PluralTranslation(
 *     singular = "@count organization",
 *     plural = "@count organizations",
 *   ),
 *   bundle_label = @Translation("Organization type"),
 *   handlers = {
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\redhen_org\OrgListBuilder",
 *     "views_data" = "Drupal\views\EntityViewsData",
 *
 *     "form" = {
 *       "default" = "Drupal\redhen_org\Form\OrgForm",
 *       "add" = "Drupal\redhen_org\Form\OrgForm",
 *       "edit" = "Drupal\redhen_org\Form\OrgForm",
 *       "delete" = "Drupal\redhen_org\Form\OrgDeleteForm",
 *     },
 *     "access" = "Drupal\redhen_org\OrgAccessControlHandler",
 *     "route_provider" = {
 *       "html" = "Drupal\redhen_org\OrgHtmlRouteProvider",
 *     },
 *   },
 *   base_table = "redhen_org",
 *   revision_table = "redhen_org_revision",
 *   admin_permission = "administer org entities",
 *   entity_keys = {
 *     "id" = "id",
 *     "revision" = "revision_id",
 *     "bundle" = "type",
 *     "uuid" = "uuid",
 *     "uid" = "user_id",
 *     "langcode" = "langcode",
 *     "status" = "status",
 *   },
 *   links = {
 *     "canonical" = "/redhen/org/{redhen_org}",
 *     "add-form" = "/redhen/org/add/{redhen_org_type}",
 *     "edit-form" = "/redhen/org/{redhen_org}/edit",
 *     "delete-form" = "/redhen/org/{redhen_org}/delete",
 *     "collection" = "/redhen/org",
 *   },
 *   bundle_entity_type = "redhen_org_type",
 *   field_ui_base_route = "entity.redhen_org_type.edit_form"
 * )
 */
class Org extends ContentEntityBase implements OrgInterface {
  use EntityChangedTrait;

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

  /**
   * {@inheritdoc}
   */
  public function getName() {
    $name = $this
      ->get('name')->value;

    // Allow other modules to alter the name of the org.
    \Drupal::moduleHandler()
      ->alter('redhen_org_name', $name, $this);
    return $name;
  }

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

  /**
   * {@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_ORG_ACTIVE : REDHEN_ORG_INACTIVE);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The name of the org.'))
      ->setSettings([
      'max_length' => 255,
      'text_processing' => 0,
    ])
      ->setDefaultValue('')
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => -10,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE)
      ->setRequired(TRUE)
      ->setRevisionable(TRUE);
    $fields['status'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Active'))
      ->setDescription(t('A boolean indicating whether the Org 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 org was created.'))
      ->setRevisionable(TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the org was last edited.'))
      ->setRevisionable(TRUE);
    return $fields;
  }

}

Classes

Name	Description
Org	Defines the Organization entity.