<?php
/**
 * Twitter_Dm
 *
 * @package php-twitter 2.0
 * @subpackage direct_messages
 * @author Aaron Brazell
 **/

class Twitter_Dm extends Twitter {
	/**
	 * Setup Twitter client connection details
	 *
	 * Ensure you set a user agent, whether via the constructor or by assigning a value to the property directly.
	 * Also, if you are not running this from the Eastern timezone, be sure to set your proper timezone.
	 *
	 * @access public
	 * @since 2.0
	 * @return Twitter_Lists
	 */
	public function __construct( $username = null, $password = null, $user_agent = null, $headers = null, $timezone = 'America/New_York')
	{
		parent::__construct($username, $password, $user_agent, $headers, $timezone);
	}
	
	/**
	 * Send a request for Direct Messages
	 *
	 * @access public
	 * @since 2.0
	 * @param string $scope public for public timeline, user for user timeline, mentions for @ replies
	 * @param array $args Parameters that can be passed in key/pair format. All are optional. Some only apply to certain scopes.
	 *  - since_id: INT. Only tweets after the specified Status ID are returned
	 *  - max_id: INT. Only tweets up to a specified Status ID are returned
	 *  - count: INT. Number of tweets to return. Defaults to 20.
	 *  - page: INT: Paged result set to display.
	 * @return object
	 */
	public function get_dms( $args = array() )
	{
		if( !class_exists('Twitter_Timeline') )
			require('class.timeline.php');
		
		$defaults = array(
			'count'	=> 20
			);
		$args = wp_parse_args( $defaults, $args );
		
		return Twitter_Timeline::get_timeline( 'dm', $args )
	}
	
	/**
	 * Get a listing of direct messages sent by the authenticating user
	 *
	 * @access public
	 * @since 2.0
	 * @param string $scope public for public timeline, user for user timeline, mentions for @ replies
	 * @param array $args Parameters that can be passed in key/pair format. All are optional. Some only apply to certain scopes.
	 *  - since_id: INT. Only tweets after the specified Status ID are returned
	 *  - max_id: INT. Only tweets up to a specified Status ID are returned
	 *  - count: INT. Number of tweets to return. Defaults to 20.
	 *  - page: INT: Paged result set to display.
	 * @return object
	 */
	public function sent_dms( $args = array() )
	{
		if( !class_exists('Twitter_Timeline') )
			require('class.timeline.php');
		
		$defaults = array(
			'count'	=> 20
			);
		$args = wp_parse_args( $defaults, $args );
		
		return Twitter_Timeline::get_timeline( 'dmsent', $args )
	}
	
	/**
	 * Send a new Direct Message
	 * 
	 * @access public
	 * @since 2.0
	 * @param string/integer $recipient. Required. The username or user ID of the recipient
	 * @param string $message. Required. Will be URL encoded and truncated to 140 charachters.
	 * @return object
	 **/
	public function send_dm( $recipient, $message )
	{
		$data = array();
		
		if( is_int( $recipient ) )
			$data['user_id'] => $recipient;
		else
			$data['screen_name'] => $recipient;
		
		$data['text'] = substr( urlencode( $message ), 0, 140 );
		
		$this->api_url = 'http://twitter.com/direct_messages/new.' . $this->type;
		return $this->_post( $this->api_url, $data );
	}
	
	/**
	 * Delete a DM
	 *
	 * @access public
	 * @since 2.0
	 * @param integer $dmid. Required. Specified ID of DM must be sent to authenticating user.
	 * @return object
	 **/
	public function delete_dm( $dmid )
	{
		if( !is_int( $dmid ) )
			return false;
			
		$this->api_url = 'http://twitter.com/direct_messages/' . $dmid . '.' . $this->type;
		return $this->_post( $this->api_url, array( 'id' => $dmid ) );
	}
	
	public function __destruct() {}
}