Source for file OnpubArticle.php

Documentation is available at OnpubArticle.php

  1. <?php
  2.  
  3. /**
  4.  * An article.
  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 OnpubArticle
  14. {
  15.   /**
  16.    * Article 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.    * Article title. Default is an empty string.
  29.    *
  30.    * @var string 
  31.    */
  32.   public $title;
  33.   /**
  34.    * Article content. Default is an empty string.
  35.    *
  36.    * @var string 
  37.    */
  38.   public $content;
  39.   /**
  40.    * Article URL. Default is an empty string.
  41.    *
  42.    * @var string 
  43.    */
  44.   public $url;
  45.   private $created;
  46.   private $modified;
  47.   /**
  48.    * Article authors. Default is an empty array.
  49.    *
  50.    * @var array 
  51.    */
  52.   public $authors;
  53.   /**
  54.    * Article image. Default is NULL.
  55.    *
  56.    * @var OnpubImage 
  57.    */
  58.   public $image;
  59.   /**
  60.    * Article section IDs. Default is an empty array.
  61.    *
  62.    * @var array 
  63.    */
  64.   public $sectionIDs;
  65.  
  66.   /**
  67.    * Construct a new article.
  68.    */
  69.   function __construct()
  70.   {
  71.     $this->ID = NULL;
  72.     $this->imageID = NULL;
  73.     $this->title = "";
  74.     $this->content = "";
  75.     $this->url = "";
  76.     $this->created = NULL;
  77.     $this->modified = NULL;
  78.     $this->authors = array();
  79.     $this->image = NULL;
  80.     $this->sectionIDs = array();
  81.   }
  82.  
  83.   /**
  84.    * Get this article's creation date.
  85.    *
  86.    * By default, returns the date at the time this method was called for the
  87.    * first time. Call {@link OnpubArticle::setCreated()} to explicitly set
  88.    * this article's creation date.
  89.    *
  90.    * @return DateTime 
  91.    */
  92.   public function getCreated()
  93.   {
  94.     if ($this->created === NULL) {
  95.       $this->created = new DateTime();
  96.     }
  97.  
  98.     return $this->created;
  99.   }
  100.  
  101.   /**
  102.    * Set this article's creation date.
  103.    *
  104.    * @param DateTime 
  105.    */
  106.   public function setCreated(DateTime $created)
  107.   {
  108.     $this->created = $created;
  109.   }
  110.  
  111.   /**
  112.    * Get this article's last modification date.
  113.    *
  114.    * By default, returns the date at the time this method was called for the
  115.    * first time. Call {@link OnpubArticle::setModified()} to explicitly set
  116.    * this article's last modification date.
  117.    *
  118.    * @return DateTime 
  119.    */
  120.   public function getModified()
  121.   {
  122.     if ($this->modified === NULL) {
  123.       $this->modified = new DateTime();
  124.     }
  125.  
  126.     return $this->modified;
  127.   }
  128.  
  129.   /**
  130.    * Set this article's last modification date.
  131.    *
  132.    * @param DateTime 
  133.    */
  134.   public function setModified(DateTime $modified)
  135.   {
  136.     $this->modified = $modified;
  137.   }
  138.  
  139.   /**
  140.    * Get a summary of this article's content.
  141.    *
  142.    * By default a 30 word summary is generated.
  143.    *
  144.    * @param int $limit The maximum number of words to include in the summary.
  145.    * @return string 
  146.    */
  147.   public function getSummary($limit = 30)
  148.   {
  149.     // Replace all new line charcaters and non-breaking spaces.
  150.     $content = preg_replace('/[\n\r]|(&nbsp;)/i', '', $this->content);
  151.     // Strip all HTML tags.
  152.     $content = strip_tags($content);
  153.     // Trim whitespace.
  154.     $content = trim($content);
  155.     // Split string in to words.
  156.     $words = preg_split("/\s+/", $content, $limit + 1);
  157.     
  158.     if (sizeof($words) > $limit) {
  159.       array_pop($words);
  160.     }
  161.  
  162.     return implode(' ', $words);
  163.   }
  164. }
  165. ?>

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