/media_entity_twitter

DEPRECATED: See https://drupal.org/project/media_entity_twitter for latest code and issues - Twitter integration for media entity.

Primary LanguagePHP

Build Status

About Media entity

Media entity provides a 'base' entity for a media element. This is a very basic entity which can reference to all kinds of media-objects (local files, YouTube videos, tweets, CDN-files, ...). This entity only provides a relation between Drupal (because it is an entity) and the resource. You can reference to this entity within any other Drupal entity.

About Media entity Twitter

This module provides Twitter integration for Media entity (i.e. media type provider plugin).

Without Twitter API

If you need just to embedded tweets you can use this module without using Twitter's API. That will give you access to the fields available from the url/embed code: id and user.

You will need to:

  • Create a Media bundle with the type provider "Twitter".
  • On that bundle create a field for the Tweet url/source (this should be a plain text or link field).
  • Return to the bundle configuration and set "Field with source information" to use that field.

IMPORTANT: beware that there is limit on the number of request that can be made for free. Read more

With Twitter API

If you need to get other fields, you will need to use Twitter's API. To get this working follow the steps below:

  • Download and enable composer_manager. Also make sure you have drush installed.
  • Run the following commands from within your Drupal root directory to download the library that will handle the communication:
  // Rebuild the composer.json file with updated dependencies.
  $ drush composer-json-rebuild

  // Install the required packages.
  $ drush composer-manager install
  • Create a twitter app on the twitter developer site
  • Enable read access for your twitter app
  • Grab your access tokens from the twitter developer site
  • In your Twitter bundle configuration set "Whether to use Twitter api to fetch tweets or not" to "Yes"" and paste in the "Consumer key", "Consumer secret", "Oauth access token" and the "Oauth access token secret"

Storing field values

If you want to store the fields that are retrieved from Twitter you should create appropriate fields on the created media bundle (image, content and retweet_count) and map this to the fields provided by Twitter.php.

NOTE: At the moment there is no GUI for that, so the only method of doing that for now is via CMI.

This would be an example of that (the field_map section):

langcode: en
status: true
dependencies:
  module:
    - media_entity_twitter
id: tweet
label: Tweet
description: 'Tweet to be used with content.'
type: twitter
type_configuration:
  twitter:
    source_field: field_tweet_source
    use_twitter_api: '1'
    consumer_key: YOUR_CONSUMER_KEY
    consumer_secret: YOUR_CONSUMER_SECRET
    oauth_access_token: YOUR_OAUTH_ACCESS_TOKEN
    oauth_access_token_secret: YOUR_OAUTH_ACCESS_TOKEN_SECRET
field_map:
  source: field_tweet_source
  id: field_tweet_id
  content: field_tweet_content

Project page: http://drupal.org/project/media_entity_twitter

Maintainers:

  • Janez Urevc (@slashrsm) drupal.org/user/744628
  • Primož Hmeljak (@primsi) drupal.org/user/282629

IRC channel: #drupal-media