2017 © Pedro Peláez
 

silverstripe-vendormodule twitter-tools

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

image

weboftalent/twitter-tools

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  • Sunday, March 18, 2018
  • by weboftalent
  • Repository
  • 1 Watchers
  • 3 Stars
  • 197 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 1 Forks
  • 5 Open issues
  • 8 Versions
  • 0 % Grown

The README.md

Twitter Utilities

Build Status Scrutinizer Code Quality Code Coverage Build Status codecov.io, (*1)

Latest Stable Version Latest Unstable Version Total Downloads License Monthly Downloads Daily Downloads, (*2)

Dependency Status Reference Status, (*3)

codecov.io, (*4)

Introduction

This module provides the following functionality * Embed tweets using a shortcode * Optionally include a script to enlarge images in embedded tweets so that you can have them larger than Twitter's normal minimum width * Twitter cards can be any type extending Page, provided an interface is implemented., (*5)

Incorporate Twitter

, (*6)

##Embedding Tweets
Tweets can be embedded into content using a shortcode like the following - the id parameter is the id of the tweet.

    [tweet id='537136515445710848']

## Enlarging Embedded Images

**** THIS NEEDS RETESTED ****, (*7)

A script is included that you can include in your theme (either using require_javascript or a direct
 script include in the template) called twitteruril.js - include this and larger (at source size, 
 perhaps not theme size) embedded images will render on your site.

## Twitter Cards
In order for a page to render an title, description and image when included as a link in a tweet, it needs provide metadata known as a Twitter Card.  There are two steps to take in order to achieve this:

### Implement RenderableAsTwitterCard Interface
A  minimal example of a class implementing a Twitter card is shown below.

class PageWithImage extends Page implements RenderableAsTwitterCard { private static $db = array( 'ImageAttribution' => 'Varchar(255)', 'BriefIntroduction' => 'Text' );, (*8)

static $has_one = array( 'MainImage' => 'Image' );, (*9)

// implement the twitter card interface public function getTwitterTitle() { return $this->Title; }, (*10)

public function getTwitterImage() { return $this->MainImage(); }, (*11)

public function getTwitterDescription() { return $this->BriefIntroduction; }, (*12)

}, (*13)


### Template Changes In your page template, add the following to inside <head></head> section of your page: ```txt <% include TwitterSummaryCardLargeImage %>

This will check if the current page implements the RenderableAsTwitterCard interface. If so it will produce the relevant metadata for Twitter to render a Twitter Card., (*14)

Test With Card Validator

Test out your twitter card using the Card Validator, https://cards-dev.twitter.com/validator on a publicly accessible version of your site - this will highlight any issues. It should also be noted that your site will probably need whitelisted., (*15)

TODO

  • ShortCode for follow button allowing content editors to add them inline.
  • Allow different types of TwitterCard and make this configurable.

The Versions

18/03 2018

dev-master

9999999-dev

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe twitter shortcode twitter cards

18/03 2018

2.0.2

2.0.2.0

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe twitter shortcode twitter cards

15/03 2018

2.0.1

2.0.1.0

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe twitter shortcode twitter cards

15/03 2018

dev-silverstripe4

dev-silverstripe4

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe twitter shortcode twitter cards

15/03 2018

2.0.0

2.0.0.0

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe twitter shortcode twitter cards

20/01 2016

1.0.0

1.0.0.0

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

BSD-3-Clause

The Requires

 

silverstripe twitter shortcode twitter cards

20/01 2016

dev-continuous_integration

dev-continuous_integration

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

The Requires

 

silverstripe twitter shortcode twitter cards

17/04 2015

3.1.x-dev

3.1.9999999.9999999-dev

Embed tweets using shortcodes. Optionally add Twitter cards to pages.

  Sources   Download

The Requires

 

silverstripe twitter shortcode twitter cards