summaryrefslogtreecommitdiff
path: root/lib/atom10entry.php
diff options
context:
space:
mode:
authorZach Copley <zach@status.net>2010-02-10 21:21:42 -0800
committerZach Copley <zach@status.net>2010-02-11 13:56:05 -0800
commitc8d5c8442fe6ce54f7f65d1d0eb4203b06c09583 (patch)
tree952b5e5d96035ce5834ba81e46b1a85ed5df94e6 /lib/atom10entry.php
parente2c0f59414dd7e9a33ffbae7307b81a85c2c168b (diff)
Added some boilerplate class comments, etc.
Diffstat (limited to 'lib/atom10entry.php')
-rw-r--r--lib/atom10entry.php48
1 files changed, 48 insertions, 0 deletions
diff --git a/lib/atom10entry.php b/lib/atom10entry.php
index 1b79ce7ad..5710c80fc 100644
--- a/lib/atom10entry.php
+++ b/lib/atom10entry.php
@@ -1,9 +1,51 @@
<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Class for building / manipulating an Atom entry in memory
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category Feed
+ * @package StatusNet
+ * @author Zach Copley <zach@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://status.net/
+ */
+
+if (!defined('STATUSNET')
+{
+ exit(1);
+}
class Atom10EntryException extends Exception
{
}
+/**
+ * Class for manipulating an Atom entry in memory. Get the entry as an XML
+ * string with Atom10Entry::getString().
+ *
+ * @category Feed
+ * @package StatusNet
+ * @author Zach Copley <zach@status.net>
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://status.net/
+ */
class Atom10Entry extends XMLStringer
{
private $namespaces;
@@ -39,6 +81,12 @@ class Atom10Entry extends XMLStringer
}
+ /**
+ * Check that all required elements have been set, etc.
+ * Throws an Atom10EntryException if something's missing.
+ *
+ * @return void
+ */
function validate
{