aboutsummaryrefslogtreecommitdiff
path: root/mod/twitterservice/vendors/twitter/readme.txt
blob: a01b768af20ee60a4b8d5838e48aae36f117aa14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Twitter for PHP (c) David Grudl, 2008 (http://davidgrudl.com)


Introduction
------------

Twitter for PHP is a very small and easy-to-use library for sending 
messages to Twitter and receiving status updates.


Project at GoogleCode: http://twitter-php.googlecode.com
Twitter's API documentation: http://groups.google.com/group/twitter-development-talk/web/api-documentation
My PHP blog: http://phpfashion.com


Requirements
------------
- PHP (version 5 or better)
- cURL extension


Usage
-----

Create object using your credentials (user name and password)

	$twitter = new Twitter($userName, $password);

The send() method updates your status. The message must be encoded in UTF-8:

	$twitter->send('I am fine today.');

The load() method returns the 20 most recent status updates 
posted in the last 24 hours by you and optionally by your friends:

	$withFriends = FALSE;
	$channel = $twitter->load($withFriends);

The returned channel is a SimpleXMLElement object. Extracting 
the information from the channel is easy:

	foreach ($channel->status as $status) {
		echo "message: ", $status->text;
		echo "posted at " , $status->created_at;
		echo "posted by " , $status->user->name;
	}


Files
-----
readme.txt        - This file.
license.txt       - The license for this software (New BSD License).
twitter.class.php - The core Twitter class source.
send.php          - Example sending message to Twitter.
load.php          - Example loading statuses from Twitter.