renus/last-tweet

Symfony 2 bundle to add quickly last tweets on your website

Installs: 233

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

Type:symfony-bundle

v1.0.2 2015-05-15 10:54 UTC

This package is not auto-updated.

Last update: 2022-05-14 05:31:08 UTC


README

Symfony 2 bundle to add quickly last tweets on your website, you can choose and change the screen name, override template and use your own template, this bundle reqiure dependency on abraham/twitteroauth bundle

Installation

prerequisites

when you install RenusLastTweetBundle for symfony, this dependency will be add :

https://github.com/abraham/twitteroauth

installation

1. Add this bundle to your project in composer.json:

{
    "require": {
        "renus/last-tweet": "1.*",
    }
}

2. OR Install with composer

composer.phar require renus/last-tweet dev-master

3. Register the bundle

<?php
// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        // ...
        new \Renus\LastTweetBundle\RenusLastTweetBundle(),
    );
    // ...
}

#configuration

##application twitter

first you must create an twitter application on https://apps.twitter.com/ ,and create a token (read permission)

##parameters

1.config file

you must add your twitter api parameters in app/config/config.yml, the required parameters must be added like this :

# app/config/config.yml
renus_last_tweet:
    twitter:
        consumer_key: "your_application_key"
        consumer_secret: "your_application_secret_key"
        token: "your_application_token"
        token_secret: "your_application_token_secret"

2. routing file

# app/config/routing.yml
renus_last_tweet:
    resource: "@RenusLastTweetBundle/Resources/config/routing.yml"
    prefix:   /

#Usage

##twig usage:

just add this render command in your twig template (in this example we display the last 3 tweets from the @renus_net account) :

{% render path('renus_last_tweet', {screen: 'renus_net', number: 3}) %}

##controller usage:

if you want to use it in a controller you can get an entity Array with this code:

<?php
// src/controller/someController.php
public function someAction()
{
    $tweets = $this->get('renus.twitter')->getLastTweets($screen, $number);
    // ...
    
    //if you want retweets and mention 
    $tweets = $this->get('renus.twitter')->getLastTweets($screen, $number, false, true);
}

#Override template

if you want to custom the render (in a twig template usage), you cans specify the path of your override template in the app/config/config.yml :

##config

# app/config/config.yml
renus_last_tweet:
    twitter:
        consumer_key: "your_application_key"
        consumer_secret: "your_application_secret_key"
        token: "your_application_token"
        token_secret: "your_application_token_secret"
    template:
        path: "path/of/custom/template/tweet.html.twig"

##template

you can use the "tweets" entitties Array like this :

{% for tweet in tweets %}
    <dl>
        <dt>{{ tweet.getDate() }}</dt>
        <dd>{{ tweet.getFormatText() | raw }}</dd>
    </dl>
{% endfor %}

to see all the 'tweet' parameters open the Entity/Tweet.php