Source for file OnpubSection.php

Documentation is available at OnpubSection.php

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

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