#!/usr/bin/php

<?php

//----------------------------------------------------------------------------//

// twitterStream

//----------------------------------------------------------------------------//

/*

* (c) Copyright 2013 Flame Herbohn

*

* a command line PHP script that outputs tweets to standard output

*

*/

//----------------------------------------------------------------------------//

// Configuration

//----------------------------------------------------------------------------//

// Connection

define("CONNECT_BASE_URL", "stream.twitter.com");

define("CONNECT_ENDPOINT", "/1.1/statuses/sample.json");

define("CONNECT_PORT", 443);

define("CONNECT_TIMEOUT", 30);

define("CONNECT_IDLE_TIMEOUT", 90);

// Script options

define("SCRIPT_NAME", $_SERVER['argv'][0]);

define("SCRIPT_OPTIONS", "u:p:n:t:");

// help message

define("SCRIPT_HELP",

"Usage: ".SCRIPT_NAME." -u USER_NAME -p PASSWORD [OPTION]...

-n=# exit after # tweets have been output.

-t=# exit after # seconds.

Connects to the twitter streaming API and outputs tweets from the

statuses/sample endpoint.

Important note : Twitter will disconnect clients that do not consume the stream

fast enough. The connection may be disconnected if you do anything that causes

the collection of tweets to slow down, such as piping the output in a way that

causes the output buffer to fill up and start blocking, for example:

".SCRIPT_NAME." | more

");

// error messages

define("ERROR_USERNAME_MISSING", "missing username");

define("ERROR_PASSWORD_MISSING", "missing password");

define("ERROR_HTTP_ERROR", "HTTP error");

define("ERROR_SOCKET_ERROR", "connection error");

define("ERROR_SOCKET_TIMEOUT", "connection timed out");

define("ERROR_SOCKET_EOF", "remote server disconnected (EOF)");

define("ERROR_CONNECT_RETRY_TOP", "maximum backoff time reached");

define("ERROR_CONNECT_RETRY" , "connection error, waiting for reconnect");

define("ERROR_DNS_HOST_NOT_FOUND", "host not found");

define("ERROR_OUT_OF_TIME", "maximum execution time reached");

define("ERROR_OUT_OF_TWEETS", "maximum tweet count reached");

// verbosity (for debugging)

define("SCRIPT_VERBOSITY", 0);

// Define non-configurable constants

// (constant definitions can be found at the end of the script)

define_constants();

//----------------------------------------------------------------------------//

// Exception & Error Handlers

//----------------------------------------------------------------------------//

function exception_handler($objException)

}

set_exception_handler("exception_handler");

//----------------------------------------------------------------------------//

// Script

//----------------------------------------------------------------------------//

if (!defined("UNIT_TEST") || true !== UNIT_TEST)

{

main();

}

function main()

}

//============================================================================//

// Classes

//============================================================================//

//----------------------------------------------------------------------------//

// script options class

//----------------------------------------------------------------------------//

/*

* A class for working with options passed on the command line

*/

class getOptions

}

//----------------------------------------------------------------------------//

// Twitter stream class

//----------------------------------------------------------------------------//

/*

* A class for working with the Twitter streaming API

*

* Example usage:

*

* $objTwitter = new twitterStream('username', 'password');

* $objTwitter->connect('/1.1/statuses/sample.json');

* while ($objTweet = $objTwitter->getTweet())

* {

* // do something with the tweet...

* // Note : Do not process tweets here, they should be queued for

* // asynchronous processing so as not to slow down the collection

* // of tweets from the stream.

* }

*

*/

class twitterStream