Source for file OnpubWebsite.php

Documentation is available at OnpubWebsite.php

  1. <?php
  2.  
  3. /**
  4.  * A website.
  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 OnpubWebsite
  14. {
  15.   /**
  16.    * Website 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.    * Website name. Default is an empty string.
  29.    *
  30.    * @var string 
  31.    */
  32.   public $name;
  33.   /**
  34.    * Website URL. Default is an empty string.
  35.    *
  36.    * @var string 
  37.    */
  38.   public $url;
  39.   /**
  40.    * Images URL. Default is an empty string.
  41.    *
  42.    * @var string 
  43.    */
  44.   public $imagesURL;
  45.   /**
  46.    * Images directory. Default is an empty string.
  47.    *
  48.    * @var string 
  49.    */
  50.   public $imagesDirectory;
  51.   private $created;
  52.   private $modified;
  53.   /**
  54.    * Website sections. Default is an empty array.
  55.    *
  56.    * @var array 
  57.    */
  58.   public $sections;
  59.   /**
  60.    * Website articles. Default is an empty array.
  61.    *
  62.    * @var array 
  63.    */
  64.   public $articles;
  65.   /**
  66.    * Website image. Default is NULL.
  67.    *
  68.    * @var OnpubImage 
  69.    */
  70.   public $image;
  71.  
  72.   function __construct()
  73.   {
  74.     $this->ID = NULL;
  75.     $this->imageID = NULL;
  76.     $this->name = "";
  77.     $this->url = "";
  78.     $this->imagesURL = "";
  79.     $this->imagesDirectory = "";
  80.     $this->created = NULL;
  81.     $this->modified = NULL;
  82.     $this->sections = array();
  83.     $this->articles = array();
  84.     $this->image = NULL;
  85.   }
  86.  
  87.   /**
  88.    * Get this website's creation date.
  89.    *
  90.    * By default, returns the date at the time this method was called for the
  91.    * first time. Call {@link OnpubWebsite::setCreated()} to explicitly set
  92.    * this website's creation date.
  93.    *
  94.    * @return DateTime 
  95.    */
  96.   public function getCreated()
  97.   {
  98.     if ($this->created === NULL) {
  99.       $this->created = new DateTime();
  100.     }
  101.  
  102.     return $this->created;
  103.   }
  104.  
  105.   /**
  106.    * @param DateTime 
  107.    */
  108.   public function setCreated(DateTime $created)
  109.   {
  110.     $this->created = $created;
  111.   }
  112.  
  113.   /**
  114.    * Get this website's last modification date.
  115.    *
  116.    * By default, returns the date at the time this method was called for the
  117.    * first time. Call {@link OnpubWebsite::setModified()} to explicitly set
  118.    * this website's last modification date.
  119.    *
  120.    * @return DateTime 
  121.    */
  122.   public function getModified()
  123.   {
  124.     if ($this->modified === NULL) {
  125.       $this->modified = new DateTime();
  126.     }
  127.  
  128.     return $this->modified;
  129.   }
  130.  
  131.   /**
  132.    * @param DateTime 
  133.    */
  134.   public function setModified(DateTime $modified)
  135.   {
  136.     $this->modified = $modified;
  137.   }
  138. }
  139. ?>

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