Relation.php in Relation 8

Contains \Drupal\relation\Entity\Relation.

Namespace

Drupal\relation\Entity

File

src/Entity/Relation.php

<?php

/**
 * @file
 * Contains \Drupal\relation\Entity\Relation.
 */
namespace Drupal\relation\Entity;

use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\relation\RelationInterface;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\user\UserInterface;

/**
 * Defines relation entity.
 *
 * @ContentEntityType(
 *   id = "relation",
 *   label = @Translation("Relation"),
 *   bundle_label = @Translation("Relation type"),
 *   module = "relation",
 *   handlers = {
 *     "access" = "Drupal\relation\RelationAccessControlHandler",
 *     "storage" = "Drupal\relation\RelationStorage",
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\relation\RelationListBuilder",
 *     "form" = {
 *       "default" = "Drupal\relation\RelationForm",
 *       "edit" = "Drupal\relation\RelationForm",
 *       "delete" = "Drupal\relation\Form\RelationDeleteConfirm"
 *     },
 *   },
 *   base_table = "relation",
 *   revision_table = "relation_revision",
 *   field_ui_base_route = "entity.relation_type.edit_form",
 *   entity_keys = {
 *     "id" = "relation_id",
 *     "revision" = "revision_id",
 *     "bundle" = "relation_type",
 *     "label" = "relation_id",
 *     "uuid" = "uuid"
 *   },
 *   bundle_keys = {
 *     "bundle" = "relation_type"
 *   },
 *   links = {
 *     "canonical" = "/relation/{relation}",
 *     "edit-form" = "/relation/{relation}/edit",
 *     "delete-form" = "/relation/{relation}/delete",
 *     "collection" = "/admin/content/relation",
 *   },
 *   bundle_entity_type = "relation_type",
 *   admin_permission = "administer relations",
 *   permission_granularity = "bundle"
 * )
 */
class Relation extends ContentEntityBase implements RelationInterface {
  use EntityChangedTrait;

  /**
   * {@inheritdoc}
   */
  public function label($langcode = NULL) {
    return t('Relation @id', array(
      '@id' => $this
        ->id(),
    ));
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('User ID'))
      ->setDescription(t('The {users}.uid that owns this relation; initially, this is the user that created it.'))
      ->setSettings(array(
      'target_type' => 'user',
      'default_value' => 0,
    ))
      ->setRevisionable(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The date the Relation was created.'))
      ->setRevisionable(TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The date the Relation was last edited.'))
      ->setRevisionable(TRUE);
    $fields['arity'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('ArityD'))
      ->setDescription(t('Number of endpoints on the Relation. Cannot exceed max_arity, or be less than min_arity in relation_type table.'))
      ->setRevisionable(TRUE)
      ->setSetting('unsigned', TRUE);
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    $this->arity = count($this->endpoints);
  }

  /**
   * {@inheritdoc}
   */
  public function endpoints() {
    $entities = array();
    foreach ($this->endpoints as $endpoint) {
      $entities[$endpoint->entity_type][$endpoint->entity_id] = $endpoint->entity_type;
    }
    return $entities;
  }

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

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

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

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

}

Classes

Name	Description
Relation	Defines relation entity.