first brain dump for ContentHandler interface

diff --git a/includes/ContentHandler.php b/includes/ContentHandler.php
new file mode 100644 (file)
index 0000000..7b076de
--- /dev/null
+++ b/includes/ContentHandler.php
@@ -0,0 +1,123 @@
+<?php
+
+/**
+ * A content handler knows how do deal with a specific type of content on a wiki page.
+ * Content is stored in the database in a serialized form (using a serialization format aka mime type)
+ * and is be unserialized into it's native PHP represenation (the content model).
+ * 
+ * Some content types have a flat model, that is, their native represenation is the
+ * same as their serialized form. Examples would be JavaScript and CSS code. As of now,
+ * this also applies to wikitext (mediawiki's default content type), but wikitext
+ * content may be represented by a DOM or AST structure in the future.
+ *  
+ */
+abstract class ContentHandler {
+    
+    public function __construct( $modelName, $formats ) {
+        $this->mModelName = $modelName;
+        $this->mSupportedFormats = $formats;
+    }
+
+    public function getModelName() {
+        # for wikitext: wikitext; in the future: wikiast, wikidom?
+        # for wikidata: wikidata
+        return $this->mModelName;
+    }
+
+
+    public function getSupportedFormats() {
+        # for wikitext: "text/x-mediawiki-1", "text/x-mediawiki-2", etc
+        # for wikidata: "application/json", "application/x-php", etc
+        return $this->mSupportedFormats;
+    }
+
+    public function getDefaultFormat() {
+        return $this->mSupportedFormats[0];
+    }
+
+    public abstract function serialize( $obj, $format = null );
+            # for wikitext, do nothing (in the future: serialise ast/dom)
+            # for wikidata: serialize arrays to json
+
+    public abstract function unserialize( $blob, $format = null );
+            # for wikitext, do nothing (in the future: parse into ast/dom)
+            # for wikidata: serialize arrays to json
+
+
+    public function getSearchText( $obj ) {
+            # for wikitext, return wikitext
+            # for wikidata, return pseudo-wikitext composed of property values (or some such)
+        $text = $this->serialize( $obj ); 
+        return $text; # return the default serialization.
+    }
+
+    public function getWikitextForTransclusion( $obj ) {
+        # for wikitext, return text
+        # for wikidata, return false, or some generated wikitext
+        $text = $this->serialize( $obj ); 
+        return '<pre>' . $text . '</pre>'; # return a pre-formatted block containing the default serialization.
+    }
+
+    public abstract function render( $obj, Title $title, ParserOptions $options, $revid = null );
+            # returns a ParserOutput instance!
+            # are parser options, generic?!
+
+    public function doPreSaveTransform( $title, $obj );
+
+    # TODO: getPreloadText()
+    # TODO: preprocess()
+
+    /** 
+     * Return an Article object suitable for viewing the given object
+     * 
+     * @param type $title
+     * @param type $obj
+     * @return \Article 
+     * @todo Article is being refactored into an action class, keep track of that
+     */
+    public function createArticle( $title, $obj ) {
+        $article = new Article($title);
+        return $article;
+    }
+
+    /**
+     * Return an EditPage object suitable for editing the given object
+     * 
+     * @param type $title
+     * @param type $obj
+     * @param type $article
+     * @return \EditPage 
+     */
+    public function createEditPage( $title, $obj, $article ) {
+        $editPage = new EditPage($article);
+        return $editPage;
+    }
+
+    /**
+    public function updatePage( $title, $obj ) {
+    }
+    **/
+    
+    public function getDiffEngine( $article ) {
+        $de = new DifferenceEngine( $article->getContext() );
+        return $de;
+    }
+
+    public function getIndexUpdateJobs( $title, $parserOutput, $recursive = true ) {
+            # for wikitext, create a LinksUpdate object
+            # for wikidata: serialize arrays to json
+        $update = new LinksUpdate( $title, $parserOutput, $recursive );
+        return $update;
+    }
+
+    #XXX: is the native model for wikitext a string or the parser output? parse early or parse late?
+}
+
+abstract class WikitextContentHandler extends ContentHandler {
+}
+
+abstract class JavaScriptContentHandler extends WikitextHandler {
+}
+
+abstract class CssContentHandler extends WikitextHandler {
+}