Services_Scribd
[ class tree: Services_Scribd ] [ index: Services_Scribd ] [ all elements ]

Source for file Account.php

Documentation is available at Account.php

  1. <?php
  2. /**
  3.  * Defines values that are tied to a specific Scribd account.
  4.  *
  5.  * PHP version 5.2.0+
  6.  *
  7.  * LICENSE: This source file is subject to the New BSD license that is
  8.  * available through the world-wide-web at the following URI:
  9.  * http://www.opensource.org/licenses/bsd-license.php. If you did not receive
  10.  * a copy of the New BSD License and are unable to obtain it through the web,
  11.  * please send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @category  Services
  14.  * @package   Services_Scribd
  15.  * @author    Rich Schumacher <rich.schu@gmail.com>
  16.  * @copyright 2009 Rich Schumacher <rich.schu@gmail.com>
  17.  * @license   http://www.opensource.org/licenses/bsd-license.php New BSD License
  18.  * @version   Release: 0.2.0
  19.  * @link      http://pear.php.net/package/Services_Scribd
  20.  */
  21.  
  22. /**
  23.  * Basic value object that contains information for a Scribd account.  Can be
  24.  * passed into {@link Services_Scribd::__construct()} and
  25.  * {@link Services_Scribd_Common::__construct()} to make requests.
  26.  *
  27.  * @category  Services
  28.  * @package   Services_Scribd
  29.  * @author    Rich Schumacher <rich.schu@gmail.com>
  30.  * @copyright 2009 Rich Schumacher <rich.schu@gmail.com>
  31.  * @license   http://www.opensource.org/licenses/bsd-license.php New BSD License
  32.  * @link      http://www.scribd.com/developers/platform
  33.  * @link      http://www.scribd.com/developers/platform#authentication
  34.  */
  35. {
  36.     /**
  37.      * API key for this account
  38.      *
  39.      * @var string 
  40.      */
  41.     private $_apiKey = null;
  42.  
  43.     /**
  44.      * API secret for this account
  45.      *
  46.      * @var string 
  47.      */
  48.     private $_apiSecret = null;
  49.  
  50.     /**
  51.      * The custom user id to use
  52.      *
  53.      * @var string 
  54.      */
  55.     private $_myUserId = null;
  56.  
  57.     /**
  58.      * The session identifier to use for this account
  59.      *
  60.      * @see Services_Scribd_User::login()
  61.      * @var string 
  62.      */
  63.     private $_apiSessionKey = null;
  64.  
  65.     /**
  66.      * Sets up the API key and secret if passed in
  67.      *
  68.      * @param string $apiKey    The API key
  69.      * @param string $apiSecret The API secret
  70.      *
  71.      * @return void 
  72.      */
  73.     public function __construct($apiKey$apiSecret = null)
  74.     {
  75.         $this->_apiKey    $apiKey;
  76.         $this->_apiSecret $apiSecret;
  77.     }
  78.  
  79.     /**
  80.      * Gets a property of the class
  81.      *
  82.      * @param string $name The property to retrieve
  83.      *
  84.      * @return string|null
  85.      */
  86.     public function __get($name)
  87.     {
  88.         if (property_exists($this'_' $name)) {
  89.             return $this->{'_' $name};
  90.         }
  91.     }
  92.  
  93.     /**
  94.      * Sets a property of the class
  95.      * 
  96.      * @param string $name  The property to set
  97.      * @param string $value The value to use
  98.      * 
  99.      * @return void 
  100.      */
  101.     public function __set($name$value)
  102.     {
  103.         if (property_exists($this'_' $name)) {
  104.             $this->{'_' $name$value;
  105.         }
  106.     }
  107. }
  108.  
  109. ?>

Documentation generated on Sat, 06 Apr 2013 14:30:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.