Class: Services_Twitter_DirectMessages

Source Location: /Services_Twitter-0.2.1/Services/Twitter/DirectMessages.php

Class Overview

Services_Twitter_Common
   |
   --Services_Twitter_DirectMessages

Services_Twitter_DirectMessages

Author(s):

Joe Stump <joe at joestump.net>

Inherited Variables

Class: Services_Twitter_Common

Services_Twitter_Common::$options
Services_Twitter_Common::$pass
Services_Twitter_Common::$user

Inherited Methods

Class: Services_Twitter_Common

Services_Twitter_Common::__construct(): Constructor
Services_Twitter_Common::sendRequest(): Send a request to the Twitter API
Services_Twitter_Common::setOption(): Set an option in Services_Twitter_Common::$options
Services_Twitter_Common::setOptions(): Set a number of options at once
Services_Twitter_Common::__call(): Overloaded call for API passthrough

Class Details

[line 55]
Services_Twitter_DirectMessages

Author: Joe Stump <joe@joestump.net>
Link: http://twitter.com
License: New BSD License

[ Top ]

Class Variables

$name = 'direct_messages'

[line 63]

Group name

Var: Overload name of API group
See: Services_Twitter_Common::$name
Access: protected

Type:	string
Overrides:	Array

[ Top ]

Method Detail

destroy [line 74]

object Instance destroy(
integer
$id)

Delete/Destroy a direct message

Return: of SimpleXMLElement
See: Services_Twitter_Common::sendRequest()
Throws: Services_Twitter_Exception
Access: public

Parameters:

integer $id — The direct message id to delete

[ Top ]

dmNew [line 131]

object Instance dmNew(
string
$user, string
$text)

Send a direct message

Return: of SimpleXMLElement of new status
See: Services_Twitter_Common::sendRequest()
Throws: Services_Twitter_Exception
Access: protected

Parameters:

string	`$user`	—	The id or username to send to
string	`$text`	—	The direct text to send

[ Top ]

__call [line 104]

object Instance __call(
string
$function, [array
$args = array()])

__call

Evidently, PHP considers 'new' a reserved keyword. I really, really wanted to keep the interface the same across the board and Twitter uses /direct_messages/new so Services_Twitter should use $foo->direct_messages->new(), which was causing parse errors. This is an ugly hack to work around this issue.

Return: of SimpleXMLElement
See: Services_Twitter_Common::__call()
See: Services_Twitter_DirectMessages::dmNew()
Throws: Services_Twitter_Exception
Access: public

Overrides Services_Twitter_Common::__call() (Overloaded call for API passthrough)

Parameters:

string	`$function`	—	The API endpoint to call
array	`$args`	—	The arguments for the API endpoint

[ Top ]