HomeboxLayout.php in Homebox 8

Namespace

Drupal\homebox\Entity

File

src/Entity/HomeboxLayout.php

<?php

namespace Drupal\homebox\Entity;

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

/**
 * Defines the Homebox Layout entity.
 *
 * @ingroup homebox
 *
 * @ContentEntityType(
 *   id = "homebox_layout",
 *   label = @Translation("Homebox Layout"),
 *   bundle_label = @Translation("Homebox"),
 *   handlers = {
 *     "storage" = "Drupal\homebox\HomeboxLayoutStorage",
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\homebox\HomeboxLayoutListBuilder",
 *     "views_data" = "Drupal\homebox\Entity\HomeboxLayoutViewsData",
 *     "translation" = "Drupal\content_translation\ContentTranslationHandler",
 *
 *     "form" = {
 *       "default" = "Drupal\homebox\Form\HomeboxLayoutForm",
 *       "add" = "Drupal\homebox\Form\HomeboxLayoutForm",
 *       "edit" = "Drupal\homebox\Form\HomeboxLayoutForm",
 *       "delete" = "Drupal\homebox\Form\HomeboxLayoutDeleteForm",
 *     },
 *     "access" = "Drupal\homebox\HomeboxLayoutAccessControlHandler",
 *     "route_provider" = {
 *       "html" = "Drupal\homebox\HomeboxLayoutHtmlRouteProvider",
 *     },
 *   },
 *   common_reference_target = TRUE,
 *   bundle_entity_type = "homebox",
 *   base_table = "homebox_layout",
 *   data_table = "homebox_layout_field_data",
 *   revision_table = "homebox_layout_revision",
 *   revision_data_table = "homebox_layout_field_revision",
 *   translatable = TRUE,
 *   admin_permission = "administer homebox",
 *   entity_keys = {
 *     "id" = "id",
 *     "revision" = "vid",
 *     "bundle" = "type",
 *     "label" = "name",
 *     "uuid" = "uuid",
 *     "uid" = "user_id",
 *     "langcode" = "langcode",
 *     "status" = "status",
 *   },
 *   links = {
 *     "canonical" = "/admin/structure/homebox_layout/{homebox_layout}",
 *     "add-form" = "/admin/structure/homebox_layout/add",
 *     "edit-form" = "/admin/structure/homebox_layout/{homebox_layout}/edit",
 *     "delete-form" = "/admin/structure/homebox_layout/{homebox_layout}/delete",
 *     "version-history" = "/admin/structure/homebox_layout/{homebox_layout}/revisions",
 *     "revision" = "/admin/structure/homebox_layout/{homebox_layout}/revisions/{homebox_layout_revision}/view",
 *     "revision_revert" = "/admin/structure/homebox_layout/{homebox_layout}/revisions/{homebox_layout_revision}/revert",
 *     "revision_delete" = "/admin/structure/homebox_layout/{homebox_layout}/revisions/{homebox_layout_revision}/delete",
 *     "translation_revert" = "/admin/structure/homebox_layout/{homebox_layout}/revisions/{homebox_layout_revision}/revert/{langcode}",
 *     "collection" = "/admin/structure/homebox_layout",
 *   },
 * )
 */
class HomeboxLayout extends RevisionableContentEntityBase implements HomeboxLayoutInterface {
  use EntityChangedTrait;

  /**
   * {@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 homebox_layout
    // 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 function isPublished() {
    return (bool) $this
      ->getEntityKey('status');
  }

  /**
   * {@inheritdoc}
   */
  public function setPublished($published) {
    $this
      ->set('status', $published ? TRUE : FALSE);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Authored by'))
      ->setDescription(t('The user ID of author of the Homebox Layout 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('Name'))
      ->setDescription(t('The name of the Homebox Layout 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'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Publishing status'))
      ->setDescription(t('A boolean indicating whether the Homebox Layout is published.'))
      ->setRevisionable(TRUE)
      ->setDefaultValue(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'weight' => -3,
    ]);
    $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['settings'] = BaseFieldDefinition::create('text_long')
      ->setLabel(t('Settings'))
      ->setDescription(t('User layout settings'));
    $fields['layout_id'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Layout'))
      ->setDescription(t('Active homebox layout id.'))
      ->setSettings([
      'max_length' => 50,
      'text_processing' => 0,
    ]);
    return $fields;
  }

}

Classes

Name	Description
HomeboxLayout	Defines the Homebox Layout entity.