Source for file OnpubAuthor.php

Documentation is available at OnpubAuthor.php

  1. <?php
  2.  
  3. /**
  4.  * An author.
  5.  *
  6.  * @author {@link mailto:corey@onpub.com Corey H.M. Taylor}
  7.  * @copyright Onpub (TM). Copyright 2012, Onpub.com.
  8.  *  {@link http://onpub.com/}
  9.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
  10.  *  Version 2
  11.  * @package OnpubAPI
  12.  */
  13. class OnpubAuthor
  14. {
  15.   /**
  16.    * Author ID. Default is NULL.
  17.    *
  18.    * @var int 
  19.    */
  20.   public $ID;
  21.   /**
  22.    * Image ID. Default is NULL.
  23.    *
  24.    * @var int 
  25.    */
  26.   public $imageID;
  27.   /**
  28.    * Author's given names. Default is an empty string.
  29.    *
  30.    * @var string 
  31.    */
  32.   public $givenNames;
  33.   /**
  34.    * Author's family name. Default is an empty string.
  35.    *
  36.    * @var string 
  37.    */
  38.   public $familyName;
  39.   /**
  40.    * Author's display name. Default is an empty string.
  41.    *
  42.    * @var string 
  43.    */
  44.   public $displayAs;
  45.   /**
  46.    * Author's URL. Default is an empty string.
  47.    *
  48.    * @var string 
  49.    */
  50.   public $url;
  51.   private $created;
  52.   private $modified;
  53.   /**
  54.    * Author image. Default is NULL.
  55.    *
  56.    * @var OnpubImage 
  57.    */
  58.   public $image;
  59.  
  60.   function __construct()
  61.   {
  62.     $this->ID = NULL;
  63.     $this->imageID = NULL;
  64.     $this->givenNames = "";
  65.     $this->familyName = "";
  66.     $this->displayAs = "";
  67.     $this->url = "";
  68.     $this->created = NULL;
  69.     $this->modified = NULL;
  70.     $this->image = NULL;
  71.   }
  72.  
  73.   /**
  74.    * Get this author's creation date.
  75.    *
  76.    * By default, returns the date at the time this method was called for the
  77.    * first time. Call {@link OnpubAuthor::setCreated()} to explicitly set
  78.    * this author's creation date.
  79.    *
  80.    * @return DateTime 
  81.    */
  82.   public function getCreated()
  83.   {
  84.     if ($this->created === NULL) {
  85.       $this->created = new DateTime();
  86.     }
  87.  
  88.     return $this->created;
  89.   }
  90.  
  91.   /**
  92.    * @param DateTime 
  93.    */
  94.   public function setCreated(DateTime $created)
  95.   {
  96.     $this->created = $created;
  97.   }
  98.  
  99.   /**
  100.    * Get this author's last modification date.
  101.    *
  102.    * By default, returns the date at the time this method was called for the
  103.    * first time. Call {@link OnpubAuthor::setModified()} to explicitly set
  104.    * this author's last modification date.
  105.    *
  106.    * @return DateTime 
  107.    */
  108.   public function getModified()
  109.   {
  110.     if ($this->modified === NULL) {
  111.       $this->modified = new DateTime();
  112.     }
  113.  
  114.     return $this->modified;
  115.   }
  116.  
  117.   /**
  118.    * @param DateTime 
  119.    */
  120.   public function setModified(DateTime $modified)
  121.   {
  122.     $this->modified = $modified;
  123.   }
  124. }
  125. ?>

Documentation generated on Sun, 20 May 2012 04:02:52 -0400 by phpDocumentor 1.4.4