interactive-map-item-entity

<?php

namespace Drupal\og_sydneymetrod9\Entity;

use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Entity\EditorialContentEntityBase;
use Drupal\Core\Entity\RevisionableInterface;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityPublishedTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\user\UserInterface;

/**
 * Defines the Interactive Map Item entity.
 *
 * @ingroup og_sydneymetrod9
 *
 * @ContentEntityType(
 *   id = "interactive_map_item",
 *   label = @Translation("Interactive Map Item"),
 *   handlers = {
 *     "storage" = "Drupal\og_sydneymetrod9\InteractiveMapItemEntityStorage",
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\og_sydneymetrod9\InteractiveMapItemEntityListBuilder",
 *     "views_data" = "Drupal\og_sydneymetrod9\Entity\InteractiveMapItemEntityViewsData",
 *     "translation" = "Drupal\og_sydneymetrod9\InteractiveMapItemEntityTranslationHandler",
 *
 *     "form" = {
 *       "default" = "Drupal\og_sydneymetrod9\Form\InteractiveMapItemEntityForm",
 *       "add" = "Drupal\og_sydneymetrod9\Form\InteractiveMapItemEntityForm",
 *       "edit" = "Drupal\og_sydneymetrod9\Form\InteractiveMapItemEntityForm",
 *       "delete" = "Drupal\og_sydneymetrod9\Form\InteractiveMapItemEntityDeleteForm",
 *     },
 *     "route_provider" = {
 *       "html" = "Drupal\og_sydneymetrod9\InteractiveMapItemEntityHtmlRouteProvider",
 *     },
 *     "access" = "Drupal\og_sydneymetrod9\InteractiveMapItemEntityAccessControlHandler",
 *   },
 *   base_table = "interactive_map_item",
 *   data_table = "interactive_map_item_field_data",
 *   revision_table = "interactive_map_item_revision",
 *   revision_data_table = "interactive_map_item_field_revision",
 *   translatable = TRUE,
 *   admin_permission = "administer interactive map item entities",
 *   entity_keys = {
 *     "id" = "id",
 *     "revision" = "vid",
 *     "label" = "name",
 *     "uuid" = "uuid",
 *     "uid" = "user_id",
 *     "langcode" = "langcode",
 *     "published" = "status",
 *   },
 *   links = {
 *     "canonical" = "/admin/structure/interactive_map_item/{interactive_map_item}",
 *     "add-form" = "/admin/structure/interactive_map_item/add",
 *     "edit-form" = "/admin/structure/interactive_map_item/{interactive_map_item}/edit",
 *     "delete-form" = "/admin/structure/interactive_map_item/{interactive_map_item}/delete",
 *     "version-history" = "/admin/structure/interactive_map_item/{interactive_map_item}/revisions",
 *     "revision" = "/admin/structure/interactive_map_item/{interactive_map_item}/revisions/{interactive_map_item_revision}/view",
 *     "revision_revert" = "/admin/structure/interactive_map_item/{interactive_map_item}/revisions/{interactive_map_item_revision}/revert",
 *     "revision_delete" = "/admin/structure/interactive_map_item/{interactive_map_item}/revisions/{interactive_map_item_revision}/delete",
 *     "translation_revert" = "/admin/structure/interactive_map_item/{interactive_map_item}/revisions/{interactive_map_item_revision}/revert/{langcode}",
 *     "collection" = "/admin/structure/interactive_map_item",
 *   },
 *   field_ui_base_route = "interactive_map_item.settings",
 *   revision_metadata_keys = {
 *     "revision_user" = "revision_uid",
 *     "revision_created" = "revision_timestamp",
 *     "revision_log_message" = "revision_log"
 *   }
 * )
 */
class InteractiveMapItemEntity extends EditorialContentEntityBase implements InteractiveMapItemEntityInterface {

  use EntityChangedTrait;
  use EntityPublishedTrait;

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
    $values += [
      'user_id' => \Drupal::currentUser()->id(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    $uri_route_parameters = parent::urlRouteParameters($rel);

    if ($rel === 'revision_revert' && $this instanceof RevisionableInterface) {
      $uri_route_parameters[$this->getEntityTypeId() . '_revision'] = $this->getRevisionId();
    }
    elseif ($rel === 'revision_delete' && $this instanceof RevisionableInterface) {
      $uri_route_parameters[$this->getEntityTypeId() . '_revision'] = $this->getRevisionId();
    }

    return $uri_route_parameters;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);

    foreach (array_keys($this->getTranslationLanguages()) as $langcode) {
      $translation = $this->getTranslation($langcode);

      // If no owner has been set explicitly, make the anonymous user the owner.
      if (!$translation->getOwner()) {
        $translation->setOwnerId(0);
      }
    }

    // If no revision author has been set explicitly,
    // make the interactive_map_item owner the revision author.
    if (!$this->getRevisionUser()) {
      $this->setRevisionUserId($this->getOwnerId());
    }
  }

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this->get('user_id')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this->get('user_id')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this->set('user_id', $uid);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this->set('user_id', $account->id());
    return $this;
  }

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

    // Add the published field.
    $fields += static::publishedBaseFieldDefinitions($entity_type);

    $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Authored by'))
      ->setDescription(t('The user ID of author of the Interactive Map Item entity.'))
      ->setRevisionable(TRUE)
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setTranslatable(TRUE)
      ->setDisplayOptions('view', [
        'label' => 'hidden',
        'type' => 'author',
        'weight' => 0,
      ])
      ->setDisplayOptions('form', [
        'type' => 'entity_reference_autocomplete',
        'weight' => 5,
        'settings' => [
          'match_operator' => 'CONTAINS',
          'size' => '60',
          'autocomplete_type' => 'tags',
          'placeholder' => '',
        ],
      ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);

    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Title'))
      ->setDescription(t('The name of the Interactive Map Item entity.'))
      ->setRevisionable(TRUE)
      ->setSettings([
        'max_length' => 50,
        'text_processing' => 0,
      ])
      ->setDefaultValue('')
      ->setDisplayOptions('view', [
        'label' => 'above',
        'type' => 'string',
        'weight' => -4,
      ])
      ->setDisplayOptions('form', [
        'type' => 'string_textfield',
        'weight' => -4,
      ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE)
      ->setRequired(TRUE);

    $fields['status']->setDescription(t('A boolean indicating whether the Interactive Map Item is published.'))
      ->setDisplayOptions('form', [
        'type' => 'boolean_checkbox',
        'weight' => 1,
      ]);

    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the entity was created.'));

    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the entity was last edited.'));

    $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Revision translation affected'))
      ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.'))
      ->setReadOnly(TRUE)
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE);

    $fields['map'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Interactive Map'))
      ->setDescription(t('Where this item should be placed.'))
      ->setRequired(TRUE)
      ->setSetting('target_type', 'interactive_map')
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);

    $fields['item_category'] = BaseFieldDefinition::create('list_string')
      ->setLabel(t('Map item category'))
//      ->setSetting('allowed_values_function','og_sydneymetrod9_allowed_values_item_category' )
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);;

    $item_type_desc = '<ul>';
    $item_type_desc .= '<li>' . t('POI will render marker on the location.') . '</li>';
    $item_type_desc .= '<li>' . t('KML  allow editor to upload KML file, it will render instructions defined in KML.') . '</li>';
    $item_type_desc .= '<li>' . t('Use Polyline to create line from several lat/long coordinates.') . '</li>';
    $item_type_desc .= '</ul>';

    $fields['item_type'] = BaseFieldDefinition::create('list_string')
      ->setLabel(t('Map item type'))
      ->setDescription($item_type_desc)
      ->setRequired(TRUE)
      ->setSetting('allowed_values', [
        'poi' => t('POI'),
        'kml' => t('KML'),
        'polyline' => t('Polyline'),
      ])
      ->setDefaultValue('poi')
      ->setDisplayOptions('form', [
        'type' => 'options_select',
        'weight' => -2,
      ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);;


    return $fields;
  }

  public function getItemCategoryData() {
    return [];
  }

}