summaryrefslogtreecommitdiff
path: root/modules/atom
diff options
context:
space:
mode:
Diffstat (limited to 'modules/atom')
-rw-r--r--modules/atom/libraries/Atom_Author.php35
-rw-r--r--modules/atom/libraries/Atom_Base.php74
-rw-r--r--modules/atom/libraries/Atom_Entry.php50
-rw-r--r--modules/atom/libraries/Atom_Feed.php49
-rw-r--r--modules/atom/libraries/Atom_Link.php40
-rw-r--r--modules/atom/tests/Atom_Test.php97
6 files changed, 345 insertions, 0 deletions
diff --git a/modules/atom/libraries/Atom_Author.php b/modules/atom/libraries/Atom_Author.php
new file mode 100644
index 00000000..ec3c61aa
--- /dev/null
+++ b/modules/atom/libraries/Atom_Author.php
@@ -0,0 +1,35 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+class Atom_Author_Core extends Atom_Base {
+ public function name($name) {
+ $this->element->appendChild($this->dom->createElement("name", $name));
+ return $this;
+ }
+
+ public function email($email) {
+ $this->element->appendChild($this->dom->createElement("email", $email));
+ return $this;
+ }
+
+ public function uri($uri) {
+ $this->element->appendChild($this->dom->createElement("uri", $uri));
+ return $this;
+ }
+}
diff --git a/modules/atom/libraries/Atom_Base.php b/modules/atom/libraries/Atom_Base.php
new file mode 100644
index 00000000..62fdfea1
--- /dev/null
+++ b/modules/atom/libraries/Atom_Base.php
@@ -0,0 +1,74 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+class Atom_Base_Core {
+ protected $dom;
+ protected $element;
+ protected $children = array();
+ protected $element_name;
+
+ function __construct($element_name, $dom=null) {
+ if ($dom) {
+ $this->dom = $dom;
+ $this->element = $dom->createElement($element_name);
+ } else {
+ $this->dom = new DOMDocument('1.0', 'utf-8');
+ $this->element = $this->dom->createElementNS("http://www.w3.org/2005/Atom", $element_name);
+ }
+ $this->dom->appendChild($this->element);
+ $this->element_name = $element_name;
+ return $this;
+ }
+
+ public function get_element() {
+ $this->add_children_to_base_element();
+ return $this->element;
+ }
+
+ public function as_xml() {
+ $this->add_children_to_base_element();
+ return $this->dom->saveXML();
+ }
+
+ public function as_json() {
+ $this->add_children_to_base_element();
+ /* Both Google and Yahoo generate their JSON from XML. We could do that, too. */
+ return null;
+ }
+
+ public function load_xml($xml) {
+ /* Load XML into our DOM. We can also validate against the RELAX NG schema from the Atom RFC. */
+ }
+
+ protected function add_child($element_type, $element_name) {
+ // @todo check if element_type is of Atom_Base; this can also be done with no magic
+ $element = new $element_type($element_name, $this->dom);
+ $this->children[$element_name][] = $element;
+ return end($this->children[$element_name]);
+ }
+
+ protected function add_children_to_base_element() {
+ foreach ($this->children as $element_type => $elements) {
+ $base_element = $this->dom->getElementsByTagName($this->element_name)->item(0);
+ foreach ($elements as $id => $element) {
+ $base_element->appendChild($element->get_element());
+ }
+ }
+ }
+} \ No newline at end of file
diff --git a/modules/atom/libraries/Atom_Entry.php b/modules/atom/libraries/Atom_Entry.php
new file mode 100644
index 00000000..d566f49b
--- /dev/null
+++ b/modules/atom/libraries/Atom_Entry.php
@@ -0,0 +1,50 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+class Atom_Entry_Core extends Atom_Base {
+ public function id($id) {
+ $this->element->appendChild($this->dom->createElement("id", $id));
+ return $this;
+ }
+
+ public function updated($updated) {
+ $this->element->appendChild($this->dom->createElement("updated", $updated));
+ return $this;
+ }
+
+ public function title($title) {
+ $this->element->appendChild($this->dom->createElement("title", $title));
+ return $this;
+ }
+
+ public function content($text, $type="html") {
+ $content = $this->dom->createElement("content", $text);
+ $content->setAttribute("type", $type);
+ $this->element->appendChild($content);
+ return $this;
+ }
+
+ public function author() {
+ return $this->add_child("Atom_Author", "author");
+ }
+
+ public function link() {
+ return $this->add_child("Atom_Link", "link");
+ }
+}
diff --git a/modules/atom/libraries/Atom_Feed.php b/modules/atom/libraries/Atom_Feed.php
new file mode 100644
index 00000000..0b667e88
--- /dev/null
+++ b/modules/atom/libraries/Atom_Feed.php
@@ -0,0 +1,49 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+class Atom_Feed_Core extends Atom_Base {
+ public function id($id) {
+ $this->element->appendChild($this->dom->createElement("id", $id));
+ return $this;
+ }
+
+ public function title($title) {
+ $this->element->appendChild($this->dom->createElement("title", $title));
+ return $this;
+ }
+
+ public function updated($updated) {
+ $this->element->appendChild($this->dom->createElement("updated", $updated));
+ return $this;
+ }
+
+ public function link() {
+ return $this->add_child("Atom_Link", "link");
+ }
+
+ public function entry() {
+ /* Create new empty entry. */
+ return $this->add_child("Atom_Entry", "entry");
+ }
+
+ public function append_entry($atom_entry) {
+ /* Append an exising entry. */
+ $this->element->appendChild($atom_entry->get_element());
+ }
+}
diff --git a/modules/atom/libraries/Atom_Link.php b/modules/atom/libraries/Atom_Link.php
new file mode 100644
index 00000000..5fff30f2
--- /dev/null
+++ b/modules/atom/libraries/Atom_Link.php
@@ -0,0 +1,40 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+class Atom_Link_Core extends Atom_Base {
+ public function rel($rel) {
+ $this->element->setAttribute("rel", $rel);
+ return $this;
+ }
+
+ public function type($type) {
+ $this->element->setAttribute("type", $type);
+ return $this;
+ }
+
+ public function title($title) {
+ $this->element->setAttribute("title", $title);
+ return $this;
+ }
+
+ public function href($href) {
+ $this->element->setAttribute("href", $href);
+ return $this;
+ }
+}
diff --git a/modules/atom/tests/Atom_Test.php b/modules/atom/tests/Atom_Test.php
new file mode 100644
index 00000000..28192419
--- /dev/null
+++ b/modules/atom/tests/Atom_Test.php
@@ -0,0 +1,97 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+class Atom_Test extends Unit_Test_Case {
+/*
+ * These aren't real tests. They just demonstrate how the Atom libraries are used.
+ * Their output is almost identical to the examples at:
+ * http://codex.gallery2.org/Gallery3:Atom_resource_representations
+ *
+ * Uncomment one or both lines at the end of the tests to see the output.
+ * (You'll have to use your editor to reformat it because there aren't any newlines.)
+ */
+ public function atom_feed_test() {
+ $feed = new Atom_Feed("feed");
+ $feed->id("http://gallery.example.com/comments")
+ ->title("Comments on Ocean Beach Sunset", "text")
+ ->updated("2008-11-15T12:00:00Z");
+
+ $feed->link()
+ ->rel("self")
+ ->href("http://gallery.example.com/comments");
+ $feed->link()
+ ->rel("related")
+ ->type("application/atom+xml")
+ ->title("Get photo meta data")
+ ->href("http://gallery.example.com/photos/23");
+ $feed->link()
+ ->rel("related")
+ ->type("image/jpeg")
+ ->title("Download photo")
+ ->href("http://gallery.example.com/photos/SanFran/sunset.jpg");
+
+ $feed->entry()
+ ->id("http://gallery.example.com/comments/32")
+ ->updated("2008-11-15T12:00:00Z")
+ ->title("")
+ ->content("Wow, that's &lt;b>beautiful&lt;b>!", "html")
+ ->author()
+ ->name("Jonathan Doe")
+ ->email("jdoe@example.com")
+ ->uri("http://gallery.example.com");
+
+ $xml = $feed->as_xml();
+// file_put_contents("atom-feed.xml", $xml);
+// Kohana::log("debug", "{$xml}");
+ }
+
+ public function atom_entry_test() {
+ $entry = new Atom_Entry("entry");
+ $entry->id("http://gallery.example.com/comments/32")
+ ->title("Comment on Ocean Beach Sunset", "text")
+ ->updated("2008-11-15T12:00:00Z")
+ ->content("Wow, that's &lt;b>beautiful&lt;b>!", "html")
+ ->author()
+ ->name("Jonathan Doe")
+ ->email("jdoe@example.com")
+ ->uri("http://gallery.example.com");
+ $entry->link()
+ ->rel("self")
+ ->href("http://gallery.example.com/comments/32");
+ $entry->link()
+ ->rel("related")
+ ->type("application/atom+xml")
+ ->title("Get photo meta data")
+ ->href("http://gallery.example.com/photos/23");
+ $entry->link()
+ ->rel("related")
+ ->type("text/html")
+ ->title("View photo in Gallery")
+ ->href("http://gallery.example.com/photos/23");
+ $entry->link()
+ ->rel("related")
+ ->type("image/jpeg")
+ ->title("Download photo")
+ ->href("http://gallery.example.com/photos/SanFran/sunset.jpg");
+
+ $xml = $entry->as_xml();
+// file_put_contents("atom-entry.xml", $xml);
+// Kohana::log("debug", "{$xml}");
+ }
+}
generated by cgit v1.2.3 (git 2.46.0) at 2025-10-14 05:58:41 +0000