• Home
• Swiftriver
• Core
• Modules
• Phirehose

PHP Class Swiftriver\Core\Modules\Phirehose

Show file Open project: ushahidi/Swiftriver-2011

Protected Properties

Property	Type	Description
$avgPeriod
$buff
$conn
$connectFailuresMax		Config type vars - override in subclass if desired
$connectTimeout
$count
$fdrPool
$filterChanged		State vars
$followIds
$format
$idleReconnectTimeout
$lastErrorMsg
$lastErrorNo
$locationBoxes
$method
$password
$readTimeout
$reconnect
$statusRate
$trackWords
$username		Member Attribs

Public Methods

Method	Description
__construct ( string $username, string $password, string $method = Phirehose::METHOD_SAMPLE, string $format = self::FORMAT_JSON )	Create a new Phirehose object attached to the appropriate twitter stream method.
consume ( boolean $reconnect = TRUE )	Connects to the stream API and consumes the stream. Each status update in the stream will cause a call to the handleStatus() method.
enqueueStatus ( string $status )	This is the one and only method that must be implemented additionally. As per the streaming API documentation, statuses should NOT be processed within the same process that is performing collection
getFollow ( ) : array	Returns an array of followed Twitter userIds (integers)
getLastErrorMsg ( ) : string	Returns the last error message (TCP or HTTP) that occured with the streaming API or client. State is cleared upon successful reconnect
getLastErrorNo ( ) : string	Returns the last error number that occured with the streaming API or client. Numbers correspond to either the fsockopen() error states (in the case of TCP errors) or HTTP error codes from Twitter (in the case of HTTP errors).
getLocations ( ) : array	Returns an array of 4 element arrays that denote the monitored location bounding boxes for tweets using the Geotagging API.
getTrack ( ) : array	Returns an array of keywords being tracked
setCount ( integer $count )	Sets the number of previous statuses to stream before transitioning to the live stream. Applies only to firehose and filter + track methods. This is generally used internally and should not be needed by client applications.
setFollow ( array $userIds )	Returns public statuses from or in reply to a set of users. Mentions ("Hello @user!") and implicit replies ("@user Hello!" created without pressing the reply button) are not matched. It is up to you to find the integer IDs of each twitter user.
setLocations ( array $boundingBoxes )	Specifies a set of bounding boxes to track as an array of 4 element lon/lat pairs denoting , . Only tweets that are both created using the Geotagging API and are placed from within a tracked bounding box will be included in the stream. The user's location field is not used to filter tweets. Bounding boxes are logical ORs and must be less than or equal to 1 degree per side. A locations parameter may be combined with track parameters, but note that all terms are logically ORd.
setLocationsByCircle ( $locations )	Convenience method that sets location bounding boxes by an array of lon/lat/radius sets, rather than manually specified bounding boxes. Each array element should contain 3 element subarray containing a latitude, longitude and radius. Radius is specified in kilometers and is approximate (as boxes are square).
setTrack ( array $trackWords )	Specifies keywords to track. Track keywords are case-insensitive logical ORs. Terms are exact-matched, ignoring punctuation. Phrases, keywords with spaces, are not supported. Queries are subject to Track Limitations.

Protected Methods

Method	Description
checkFilterPredicates ( )	Method called as frequently as practical (every 5+ seconds) that is responsible for checking if filter predicates (ie: track words or follow IDs) have changed. If they have, they should be set using the setTrack() and setFollow() methods respectively within the overridden implementation.
connect ( )	Connects to the stream URL using the configured method.
disconnect ( )	Performs forcible disconnect from stream (if connected) and cleanup.
log ( $message )	Basic log function that outputs logging to the standard error_log() handler. This should generally be overridden to suit the application environment.

Private Methods

Method	Description
reconnect ( )	Reconnects as quickly as possible. Should be called whenever a reconnect is required rather that connect/disconnect to preserve streams reconnect state

Method Details

Property Details