Source for file help.php

Documentation is available at help.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  Twitter
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die();
  11.  
  12. /**
  13.  * Twitter API Help class for the Joomla Platform.
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  Twitter
  17.  * @since       12.3
  18.  */
  19. class JTwitterHelp extends JTwitterObject
  20. {
  21.     /**
  22.      * Method to get the supported languages from the API.
  23.      *
  24.      * @return  array  The decoded JSON response
  25.      *
  26.      * @since   12.3
  27.      */
  28.     public function getLanguages()
  29.     {
  30.         // Check the rate limit for remaining hits
  31.         $this->checkRateLimit('help', 'languages');
  32.  
  33.         // Set the API path
  34.         $path = '/help/languages.json';
  35.  
  36.         // Send the request.
  37.         return $this->sendRequest($path);
  38.     }
  39.  
  40.     /**
  41.      * Method to get the current configuration used by Twitter including twitter.com slugs which are not usernames,
  42.      * maximum photo resolutions, and t.co URL lengths.
  43.      *
  44.      * @return  array  The decoded JSON response
  45.      *
  46.      * @since   12.3
  47.      */
  48.     public function getConfiguration()
  49.     {
  50.         // Check the rate limit for remaining hits
  51.         $this->checkRateLimit('help', 'configuration');
  52.  
  53.         // Set the API path
  54.         $path = '/help/configuration.json';
  55.  
  56.         // Send the request.
  57.         return $this->sendRequest($path);
  58.     }
  59. }

Documentation generated on Tue, 19 Nov 2013 15:04:14 +0100 by phpDocumentor 1.4.3