AnonymousFox

/home/develito/httpdocs/libraries/joomla/twitter/profile.php

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Twitter
 *
 * @copyright   (C) 2013 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die();

/**
 * Twitter API Profile class for the Joomla Platform.
 *
 * @since       3.1.4
 * @deprecated  4.0  Use the `joomla/twitter` package via Composer instead
 */
class JTwitterProfile extends JTwitterObject
{
	/**
	 * Method to et values that users are able to set under the "Account" tab of their settings page.
	 *
	 * @param   string   $name         Full name associated with the profile. Maximum of 20 characters.
	 * @param   string   $url          URL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.
	 * @param   string   $location     The city or country describing where the user of the account is located. The contents are not normalized
	 * 								   or geocoded in any way. Maximum of 30 characters.
	 * @param   string   $description  A description of the user owning the account. Maximum of 160 characters.
	 * @param   boolean  $entities     When set to either true, t or 1, each tweet will include a node called "entities,". This node offers a
	 * 								   variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
	 * @param   boolean  $skipStatus   When set to either true, t or 1 statuses will not be included in the returned user objects.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.1.4
	 */
	public function updateProfile($name = null, $url = null, $location = null, $description = null, $entities = null, $skipStatus = null)
	{
		// Check the rate limit for remaining hits
		$this->checkRateLimit('account', 'update_profile');

$data = array();

// Check if name is specified.
		if ($name)
		{
			$data['name'] = $name;
		}

// Check if url is specified.
		if ($url)
		{
			$data['url'] = $url;
		}

// Check if location is specified.
		if ($location)
		{
			$data['location'] = $location;
		}

// Check if description is specified.
		if ($description)
		{
			$data['description'] = $description;
		}

// Check if entities is specified.
		if (!is_null($entities))
		{
			$data['include_entities'] = $entities;
		}

// Check if skip_status is specified.
		if (!is_null($skipStatus))
		{
			$data['skip_status'] = $skipStatus;
		}

// Set the API path
		$path = '/account/update_profile.json';

// Send the request.
		return $this->sendRequest($path, 'POST', $data);
	}

/**
	 * Method to update the authenticating user's profile background image. This method can also be used to enable or disable the profile
	 * background image.
	 *
	 * @param   string   $image       The background image for the profile.
	 * @param   boolean  $tile        Whether or not to tile the background image.
	 * @param   boolean  $entities    When set to either true, t or 1, each tweet will include a node called "entities,". This node offers a
	 * 								  variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
	 * @param   boolean  $skipStatus  When set to either true, t or 1 statuses will not be included in the returned user objects.
	 * @param   boolean  $use         Determines whether to display the profile background image or not.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.1.4
	 */
	public function updateProfileBackgroundImage($image = null, $tile = false, $entities = null, $skipStatus = null, $use = false)
	{
		// Check the rate limit for remaining hits
		$this->checkRateLimit('account', 'update_profile_background_image');

$data = array();

// Check if image is specified.
		if ($image)
		{
			$data['image'] = "@{$image}";
		}

// Check if url is true.
		if ($tile)
		{
			$data['tile'] = $tile;
		}

// Check if entities is specified.
		if (!is_null($entities))
		{
			$data['include_entities'] = $entities;
		}

// Check if skip_status is specified.
		if (!is_null($skipStatus))
		{
			$data['skip_status'] = $skipStatus;
		}

// Check if use is true.
		if ($use)
		{
			$data['use'] = $use;
		}

// Set the API path
		$path = '/account/update_profile_background_image.json';

$header = array('Content-Type' => 'multipart/form-data', 'Expect' => '');

// Send the request.
		return $this->sendRequest($path, 'POST', $data, $header);
	}

/**
	 * Method to update the authenticating user's profile image.
	 *
	 * @param   string   $image       The background image for the profile.
	 * @param   boolean  $entities    When set to either true, t or 1, each tweet will include a node called "entities,". This node offers a
	 * 								  variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
	 * @param   boolean  $skipStatus  When set to either true, t or 1 statuses will not be included in the returned user objects.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.1.4
	 */
	public function updateProfileImage($image = null, $entities = null, $skipStatus = null)
	{
		// Check the rate limit for remaining hits
		$this->checkRateLimit('account', 'update_profile_image');

$data = array();

// Check if image is specified.
		if ($image)
		{
			$data['image'] = "@{$image}";
		}

// Check if entities is specified.
		if (!is_null($entities))
		{
			$data['include_entities'] = $entities;
		}

// Check if skip_status is specified.
		if (!is_null($skipStatus))
		{
			$data['skip_status'] = $skipStatus;
		}

// Set the API path
		$path = '/account/update_profile_image.json';

$header = array('Content-Type' => 'multipart/form-data', 'Expect' => '');

// Send the request.
		return $this->sendRequest($path, 'POST', $data, $header);
	}

/**
	 * Method to set one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com.
	 *
	 * @param   string   $background     Profile background color.
	 * @param   string   $link           Profile link color.
	 * @param   string   $sidebarBorder  Profile sidebar's border color.
	 * @param   string   $sidebarFill    Profile sidebar's fill color.
	 * @param   string   $text           Profile text color.
	 * @param   boolean  $entities       When set to either true, t or 1, each tweet will include a node called "entities,". This node offers a
	 * 									 variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
	 * @param   boolean  $skipStatus     When set to either true, t or 1 statuses will not be included in the returned user objects.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.1.4
	 */
	public function updateProfileColors($background = null, $link = null, $sidebarBorder = null, $sidebarFill = null, $text = null,
		$entities = null, $skipStatus = null)
	{
		// Check the rate limit for remaining hits
		$this->checkRateLimit('account', 'update_profile_colors');

$data = array();

// Check if background is specified.
		if ($background)
		{
			$data['profile_background_color'] = $background;
		}

// Check if link is specified.
		if ($link)
		{
			$data['profile_link_color'] = $link;
		}

// Check if sidebar_border is specified.
		if ($sidebarBorder)
		{
			$data['profile_sidebar_border_color'] = $sidebarBorder;
		}

// Check if sidebar_fill is specified.
		if ($sidebarFill)
		{
			$data['profile_sidebar_fill_color'] = $sidebarFill;
		}

// Check if text is specified.
		if ($text)
		{
			$data['profile_text_color'] = $text;
		}

// Check if entities is specified.
		if (!is_null($entities))
		{
			$data['include_entities'] = $entities;
		}

// Check if skip_status is true.
		if (!is_null($skipStatus))
		{
			$data['skip_status'] = $skipStatus;
		}

// Set the API path
		$path = '/account/update_profile_colors.json';

// Send the request.
		return $this->sendRequest($path, 'POST', $data);
	}

/**
	 * Method to get the settings (including current trend, geo and sleep time information) for the authenticating user.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.1.4
	 */
	public function getSettings()
	{
		// Check the rate limit for remaining hits
		$this->checkRateLimit('account', 'settings');

// Set the API path
		$path = '/account/settings.json';

// Send the request.
		return $this->sendRequest($path);
	}

/**
	 * Method to update the authenticating user's settings.
	 *
	 * @param   integer  $location    The Yahoo! Where On Earth ID to use as the user's default trend location.
	 * @param   boolean  $sleepTime   When set to true, t or 1, will enable sleep time for the user.
	 * @param   integer  $startSleep  The hour that sleep time should begin if it is enabled.
	 * @param   integer  $endSleep    The hour that sleep time should end if it is enabled.
	 * @param   string   $timeZone    The timezone dates and times should be displayed in for the user. The timezone must be one of the
	 * 								  Rails TimeZone names.
	 * @param   string   $lang        The language which Twitter should render in for this user.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.1.4
	 */
	public function updateSettings($location = null, $sleepTime = false, $startSleep = null, $endSleep = null,
		$timeZone = null, $lang = null)
	{
		$data = array();

// Check if location is specified.
		if ($location)
		{
			$data['trend_location_woeid '] = $location;
		}

// Check if sleep_time is true.
		if ($sleepTime)
		{
			$data['sleep_time_enabled'] = $sleepTime;
		}

// Check if start_sleep is specified.
		if ($startSleep)
		{
			$data['start_sleep_time'] = $startSleep;
		}

// Check if end_sleep is specified.
		if ($endSleep)
		{
			$data['end_sleep_time'] = $endSleep;
		}

// Check if time_zone is specified.
		if ($timeZone)
		{
			$data['time_zone'] = $timeZone;
		}

// Check if lang is specified.
		if ($lang)
		{
			$data['lang'] = $lang;
		}

// Set the API path
		$path = '/account/settings.json';

// Send the request.
		return $this->sendRequest($path, 'POST', $data);
	}
}