TwitterProfileEntity.php in Tweet Feed 4.x

Namespace

Drupal\tweet_feed\Entity

File

src/Entity/TwitterProfileEntity.php

<?php

namespace Drupal\tweet_feed\Entity;

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

/**
 * Defines the Twitt3er Profile entity.
 *
 * @ingroup tweet_feed
 *
 * @ContentEntityType(
 *   id = "twitter_profile",
 *   label = @Translation("Twitter Profiles"),
 *   handlers = {
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\tweet_feed\TwitterProfileEntityListBuilder",
 *     "views_data" = "Drupal\tweet_feed\Entity\TwitterProfileEntityViewsData",
 *
 *     "form" = {
 *       "default" = "Drupal\tweet_feed\Form\TwitterProfileEntityForm",
 *       "delete" = "Drupal\tweet_feed\Form\TwitterProfileDeleteForm",
 *     },
 *     "access" = "Drupal\tweet_feed\TwitterProfileEntityAccessControlHandler",
 *     "route_provider" = {
 *       "html" = "Drupal\tweet_feed\TwitterProfileEntityHtmlRouteProvider",
 *     },
 *   },
 *   base_table = "twitter_profiles",
 *   admin_permission = "administer twitter profile profile entities",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "screen_name",
 *     "uuid" = "uuid",
 *   },
 *   links = {
 *     "canonical" = "/admin/structure/twitter_profile/{twitter_profile}",
 *     "delete-form" = "/admin/structure/twitter_profile/{twitter_profile}/delete",
 *     "collection" = "/admin/structure/twitter_profile",
 *   },
 *   field_ui_base_route = "twitter_profile.settings"
 * )
 */
class TwitterProfileEntity extends ContentEntityBase implements TwitterProfileEntityInterface {
  use EntityChangedTrait;

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this
      ->set('user_id', $uid);
    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 getId() {
    return $this
      ->get('id')->value;
  }

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

  /**
   * {@inheritdoc}
   */
  public function setUuid($uuid) {
    $this
      ->set('uuid', $uuid);
    return $this;
  }
  public function getTwitterUserId() {
    return $this
      ->get('twitter_user_id')->value;
  }
  public function setTwitterUserId($twitter_user_id) {
    $this
      ->set('twitter_user_id', $twitter_user_id);
    return $this;
  }
  public function getName() {
    return $this
      ->get('name')->value;
  }
  public function setName($name) {
    $this
      ->set('name', $name);
    return $this;
  }
  public function getScreenName() {
    return $this
      ->get('screen_name')->value;
  }
  public function setScreenName($screen_name) {
    $this
      ->set('screen_name', $screen_name);
    return $this;
  }
  public function getLocation() {
    return $this
      ->get('locatiom')->value;
  }
  public function setLocation($location) {
    $this
      ->set('location', $location);
    return $this;
  }
  public function getDescription() {
    return $this
      ->get('description')->value;
  }
  public function setDescription($description) {
    $this
      ->set('description', $description);
    return $this;
  }
  public function getFollowersCount() {
    return $this
      ->get('followers_count')->value;
  }
  public function setFollowersCount($followers_count) {
    $this
      ->set('followers_count', $followers_count);
    return $this;
  }
  public function getVerified() {
    return $this
      ->get('verified')->value;
  }
  public function setVerified($verified) {
    $this
      ->set('verified', $verified);
    return $this;
  }
  public function getStatusesCount() {
    return $this
      ->get('statuses_count')->value;
  }
  public function setStatusesCount($statuses_count) {
    $this
      ->set('statuses_count', $statuses_count);
    return $this;
  }
  public function getHash() {
    return $this
      ->get('hash')->value;
  }
  public function setHash($hash) {
    $this
      ->set('hash', $hash);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setProfileImage($image) {
    $this
      ->set('profile_image', $image);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProfileImage() {
    $files = $this
      ->get('profile_image')
      ->getValue();
    $images = [];
    foreach ($files as $file) {
      $fo = File::load($file['target_id']);
      $images[] = $fo;
    }
    return $images;
  }

  /**
   * {@inheritdoc}
   */
  public function setBannerImage($image) {
    $this
      ->set('banner_image', $image);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBannerImage() {
    $files = $this
      ->get('banner_image')
      ->getValue();
    $images = [];
    foreach ($files as $file) {
      $fo = File::load($file['target_id']);
      $images[] = $fo;
    }
    return $images;
  }

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

    // Standard field, used as unique if primary index.
    $fields['id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('ID'))
      ->setDescription(t('The ID of the tweet entity.'))
      ->setReadOnly(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the entity was created.'));

    // Standard field, unique outside of the scope of the current project.
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the entity was last changed.'));

    // Standard field, unique outside of the scope of the current project.
    $fields['user_id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('User Id'))
      ->setReadOnly(FALSE);

    // Standard field, unique outside of the scope of the current project.
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The UUID of the tweet entity.'))
      ->setReadOnly(TRUE);
    $fields['twitter_user_id'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Twitter User ID'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 0,
    ])
      ->setDisplayOptions('form', [
      'weight' => 0,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The name used on this profile.'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 5,
    ])
      ->setDisplayOptions('form', [
      'weight' => 5,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['screen_name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Screen Name'))
      ->setDescription(t('The screen name for this profile.'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 10,
    ])
      ->setDisplayOptions('form', [
      'weight' => 10,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['location'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Listed Profile Location'))
      ->setDescription(t('The location of the user of this profile.'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 15,
    ])
      ->setDisplayOptions('form', [
      'weight' => 15,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['description'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Description'))
      ->setDescription(t('The description/information text under the profile name for this profile.'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 20,
    ])
      ->setDisplayOptions('form', [
      'weight' => 20,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['followers_count'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Number of Followers'))
      ->setDescription(t('The number of followers this profile has.'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 25,
    ])
      ->setDisplayOptions('form', [
      'weight' => 25,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['verified'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Twitter Author Verified'))
      ->setDescription(t('Is this author verified?'))
      ->setDefaultValue(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'boolean',
      'weight' => 30,
    ])
      ->setDisplayOptions('form', [
      'weight' => 30,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['statuses_count'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Tweet Count'))
      ->setDescription(t('The number of tweets for this profile.'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 35,
    ])
      ->setDisplayOptions('form', [
      'weight' => 35,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['profile_image'] = BaseFieldDefinition::create('image')
      ->setLabel(t('Profile Image'))
      ->setDescription(t('The user profile image.'))
      ->setSettings([
      'uri_scheme' => 'public',
      'file_directory' => 'tweet_feed/[date:custom:Y]-[date:custom:m]',
      'alt_field_required' => FALSE,
      'file_extensions' => 'png jpg jpeg gif',
    ])
      ->setDisplayOptions('view', array(
      'label' => 'hidden',
      'type' => 'default',
      'weight' => 40,
    ))
      ->setDisplayOptions('form', array(
      'weight' => 40,
    ))
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['banner_image'] = BaseFieldDefinition::create('image')
      ->setLabel(t('Banner Image'))
      ->setDescription(t('The banner image for this user\'s profile.'))
      ->setSettings([
      'uri_scheme' => 'public',
      'file_directory' => 'tweet_feed/[date:custom:Y]-[date:custom:m]',
      'alt_field_required' => FALSE,
      'file_extensions' => 'png jpg jpeg gif',
    ])
      ->setDisplayOptions('view', array(
      'label' => 'hidden',
      'type' => 'default',
      'weight' => 45,
    ))
      ->setDisplayOptions('form', array(
      'weight' => 45,
    ))
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['hash'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Hash'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'weight' => 50,
    ])
      ->setDisplayOptions('form', [
      'weight' => 50,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    return $fields;
  }

}

Classes

Name	Description
TwitterProfileEntity	Defines the Twitt3er Profile entity.