lib/atom10entry.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for building / manipulating an Atom entry in memory
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Feed
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 class Atom10EntryException extends Exception
  35 {
  36 }
  37
  38 /**
  39  * Class for manipulating an Atom entry in memory. Get the entry as an XML
  40  * string with Atom10Entry::getString().
  41  *
  42  * @category Feed
  43  * @package  StatusNet
  44  * @author   Zach Copley <zach@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  */
  48 class Atom10Entry extends XMLStringer
  49 {
  50     private $namespaces;
  51     private $categories;
  52     private $content;
  53     private $contributors;
  54     private $id;
  55     private $links;
  56     private $published;
  57     private $rights;
  58     private $source;
  59     private $summary;
  60     private $title;
  61
  62     function __construct($indent = true) {
  63         parent::__construct($indent);
  64         $this->namespaces = array();
  65     }
  66
  67     function addNamespace($namespace, $uri)
  68     {
  69         $ns = array($namespace => $uri);
  70         $this->namespaces = array_merge($this->namespaces, $ns);
  71     }
  72
  73     function initEntry()
  74     {
  75
  76     }
  77
  78     function endEntry()
  79     {
  80
  81     }
  82
  83     /**
  84      * Check that all required elements have been set, etc.
  85      * Throws an Atom10EntryException if something's missing.
  86      *
  87      * @return void
  88      */
  89     function validate()
  90     {
  91
  92     }
  93
  94     function getString()
  95     {
  96         $this->validate();
  97
  98         $this->initEntry();
  99         $this->renderEntries();
 100         $this->endEntry();
 101
 102         return $this->xw->outputMemory();
 103     }
 104
 105 }