From 140736a1e49d47376ebc893aa2da250ba3d836a3 Mon Sep 17 00:00:00 2001 From: Bharat Mediratta Date: Sun, 16 Nov 2008 07:14:12 +0000 Subject: Several large changes: 1) Changed the way that we get forms. Now, if you want to get a form for a REST resource you prefix /form to the resource id. So: /form/photo/1 : returns a form for editing photo id 1 /form/comments/1 : returns a form for adding a comment to photo id 1 /form/comment/1 : returns a form for editing comment id 1 2) Changed the comment module to have two controllers: comment: deals with a single comment resource comments: deal with collections of comments attached to an item Related stuff: - Moved the comments js into the theme - Reworked Comment_Helper for clarity - Moved form generation code down into Comment_Helper - Cleaned up routes (eliminating new comment ones added in recent rev) - Added form() function to all REST controllers - Changed comment module to use a block instead of an arbitrary helper call from the theme - Comment controller only returns HTML currently, but returns a 201 Created status code when a new comment is added, which the Ajax code can catch and act upon. - Got rid of a lot of extra views in comment module --- core/config/routes.php | 6 +- core/controllers/album.php | 10 ++++ core/controllers/item.php | 7 +++ core/controllers/photo.php | 10 ++++ core/controllers/rest.php | 24 ++++++++ modules/comment/controllers/comment.php | 88 +++++++--------------------- modules/comment/controllers/comments.php | 76 ++++++++++++++++++++++++ modules/comment/helpers/comment.php | 74 ++++++++++++++++++----- modules/comment/views/comment.html.php | 11 ++++ modules/comment/views/comment_form.html.php | 35 ----------- modules/comment/views/comment_list.html.php | 13 ---- modules/comment/views/show_comments.html.php | 11 ---- themes/default/js/comment.js | 20 +++++++ themes/default/views/page.html.php | 1 + themes/default/views/photo.html.php | 2 +- 15 files changed, 239 insertions(+), 149 deletions(-) create mode 100644 modules/comment/controllers/comments.php create mode 100644 modules/comment/views/comment.html.php delete mode 100644 modules/comment/views/comment_form.html.php delete mode 100644 modules/comment/views/comment_list.html.php delete mode 100644 modules/comment/views/show_comments.html.php create mode 100644 themes/default/js/comment.js diff --git a/core/config/routes.php b/core/config/routes.php index de66b8fb..465fb885 100644 --- a/core/config/routes.php +++ b/core/config/routes.php @@ -24,11 +24,7 @@ $config['^rest'] = null; $config['^rest/.*'] = null; $config['^(\w+)/(\d+)$'] = '$1/dispatch/$2'; +$config['^form/(\w+)/(.*)$'] = '$1/form/$2'; // For now our default page is the scaffolding. $config['_default'] = 'welcome'; - -// Special routes for the comment module. -// @todo Dynamically load this. -$config['photo/(\d+)/comments/add$'] = 'comment/add/$1'; -$config['photo/(\d+)/comments$'] = 'comment/get_item_comments/$1'; diff --git a/core/controllers/album.php b/core/controllers/album.php index 63290853..87e27ac5 100644 --- a/core/controllers/album.php +++ b/core/controllers/album.php @@ -19,6 +19,16 @@ */ class Album_Controller extends Item_Controller { + /** + * @see Rest_Controller::_form($resource) + */ + public function _form($comment) { + throw new Exception("@todo Comment_Controller::_get NOT IMPLEMENTED"); + } + + /** + * @see Rest_Controller::_get($resource) + */ public function _get($item) { // @todo: these need to be pulled from the database $theme_name = "default"; diff --git a/core/controllers/item.php b/core/controllers/item.php index e9ff03e6..027dcada 100644 --- a/core/controllers/item.php +++ b/core/controllers/item.php @@ -20,6 +20,13 @@ class Item_Controller extends REST_Controller { protected $resource_type = "item"; + /** + * @see Rest_Controller::_form($resource) + */ + public function _form($comment) { + throw new Exception("@todo Comment_Controller::_get NOT IMPLEMENTED"); + } + public function _get($item) { // Redirect to the more specific resource type, since it will render // differently. We could also just delegate here, but it feels more appropriate diff --git a/core/controllers/photo.php b/core/controllers/photo.php index 78287afa..4c3154bd 100644 --- a/core/controllers/photo.php +++ b/core/controllers/photo.php @@ -19,6 +19,16 @@ */ class Photo_Controller extends Item_Controller { + /** + * @see Rest_Controller::_form($resource) + */ + public function _form($comment) { + throw new Exception("@todo Comment_Controller::_get NOT IMPLEMENTED"); + } + + /** + * @see Rest_Controller::_get($resource) + */ public function _get($item) { $template = new View("page.html"); diff --git a/core/controllers/rest.php b/core/controllers/rest.php index 09c85653..4a6c4eb4 100644 --- a/core/controllers/rest.php +++ b/core/controllers/rest.php @@ -39,6 +39,10 @@ * public function _delete(ORM $comment) { * // Handle DELETE request * } + * + * public function form(ORM $comment) { + * // Show a form for creating a new comment + * } * } * * A request to http://example.com/gallery3/comment/3 will result in a call to @@ -85,6 +89,20 @@ abstract class REST_Controller extends Controller { } } + public function form($id) { + if ($this->resource_type == null) { + throw new Exception("@todo ERROR_MISSING_RESOURCE_TYPE"); + } + + // @todo this needs security checks + $resource = ORM::factory($this->resource_type, $id); + if (!$resource->loaded) { + return Kohana::show_404(); + } + + return $this->_form($resource); + } + /** * Perform a GET request on this resource * @param ORM $resource the instance of this resource type @@ -108,4 +126,10 @@ abstract class REST_Controller extends Controller { * @param ORM $resource the instance of this resource type */ abstract public function _delete($resource); + + /** + * Present a form for adding a new resource + * @param ORM $resource the resource container for instances of this resource type + */ + abstract public function _form($resource); } diff --git a/modules/comment/controllers/comment.php b/modules/comment/controllers/comment.php index d2135cf9..a8f52443 100644 --- a/modules/comment/controllers/comment.php +++ b/modules/comment/controllers/comment.php @@ -21,50 +21,29 @@ class Comment_Controller extends REST_Controller { protected $resource_type = "comment"; /** - * Return the form for adding comments. + * Present a form for editing a comment + * @see Rest_Controller::form($resource) */ - public function _get_form($comment) { - $form = new Forge(url::current(true), "", "post", array("id" => "gComment")); - $group = $form->group(_("Add Comment")); - $group->input("author") - ->label(_("Author")) - ->id("gAuthor") - ->class(null) - ->value($comment->author); - $group->input("email") - ->label(_("Email")) - ->id("gEmail") - ->class(null) - ->value($comment->email); - $group->textarea("text") - ->label(_("Text")) - ->id("gText") - ->class(null) - ->value($comment->text); - $group->hidden("item_id") - ->value($comment->item_id); - $group->submit(_("Add")); - - $this->_add_validation_rules(ORM::factory("comment")->validation_rules, $form); - - return $form; + public function _form($comment) { + $form = comment::get_edit_form($comment); + print $form->render("form.html"); } /** - * @todo Refactor this into a more generic location + * Get an existing comment. + * @see Rest_Controller::_get($resource) */ - private function _add_validation_rules($rules, $form) { - foreach ($form->inputs as $name => $input) { - if (isset($input->inputs)) { - $this->_add_validation_rules($rules, $input); - } - if (isset($rules[$name])) { - $input->rules($rules[$name]); - } - } + public function _get($comment) { + $v = new View("comment.html"); + $v->comment = $comment; + print $v; } - public function add($item_id) { + /** + * Update existing comment. + * @see Rest_Controller::_put($resource) + */ + public function _put($comment) { $comment = ORM::factory('comment'); $comment->item_id = $item_id; @@ -77,43 +56,16 @@ class Comment_Controller extends REST_Controller { $comment->datetime = time(); $comment->item_id = $this->input->post('item_id'); $comment->save(); - - $data = array('valid' => true, 'html' => sprintf(comment::show_comment_list($item_id))); - } else { - $data = array('valid' => false, 'html' => sprintf($form->render())); + return; } - - if (request::method() == "get") { - print $data['html']; - } else if (request::method() == "post") { - print json_encode($data); - } - } - - public function get_item_comments($item_id) { - print comment::show_comment_list($item_id); - } - - /** - * Get an existing comment. - * @see Rest_Controller::_get($resource) - */ - public function _get($user) { - throw new Exception("@todo Comment_Controller::_get NOT IMPLEMENTED"); - } - - /** - * Update existing comment. - * @see Rest_Controller::_put($resource) - */ - public function _put($resource) { - throw new Exception("@todo Comment_Controller::_put NOT IMPLEMENTED"); + print $form->render(); } /** + * Add a new comment * @see Rest_Controller::_post($resource) */ - public function _post($user) { + public function _post($comment) { throw new Exception("@todo Comment_Controller::_post NOT IMPLEMENTED"); } diff --git a/modules/comment/controllers/comments.php b/modules/comment/controllers/comments.php new file mode 100644 index 00000000..a0233a0b --- /dev/null +++ b/modules/comment/controllers/comments.php @@ -0,0 +1,76 @@ +render("form.html"); + } + + /** + * Show the comment collection + * @see Rest_Controller::_get($resource) + */ + public function _get($item) { + print comment::get_comments($item); + } + + /** + * Update existing comment collection. + * @see Rest_Controller::_put($resource) + */ + public function _put($item) { + throw new Exception("@todo Comment_Controller::_put NOT IMPLEMENTED"); + } + + /** + * Add a new comment to the collection + * @see Rest_Controller::_post($resource) + */ + public function _post($item) { + $form = comment::get_add_form($item); + if ($form->validate()) { + $comment = ORM::factory('comment'); + $comment->author = $this->input->post('author'); + $comment->email = $this->input->post('email'); + $comment->text = $this->input->post('text'); + $comment->datetime = time(); + $comment->item_id = $item->id; + $comment->save(); + + header("HTTP/1.1 201 Created"); + header("Location: " . url::site("comment/{$comment->id}")); + } + print $form->render("form.html"); + } + + /** + * Delete existing comment collection. + * @see Rest_Controller::_delete($resource) + */ + public function _delete($item) { + throw new Exception("@todo Comment_Controller::_delete NOT IMPLEMENTED"); + } +} diff --git a/modules/comment/helpers/comment.php b/modules/comment/helpers/comment.php index 9eed8451..1c876f10 100644 --- a/modules/comment/helpers/comment.php +++ b/modules/comment/helpers/comment.php @@ -54,26 +54,68 @@ class Comment_Core { return $comment->save(); } - static function show_comments($item_id) { - $v = new View('show_comments.html'); - $v->comment_list = Comment::show_comment_list($item_id); - $v->comment_form = Comment::show_comment_form($item_id); - $v->render(true); + static function get_add_form($item) { + $form = new Forge(url::site("comments/{$item->id}"), "", "post", array("id" => "gCommentForm")); + $group = $form->group(_("Add Comment")); + $group->input("author") ->label(_("Author")) ->id("gAuthor"); + $group->input("email") ->label(_("Email")) ->id("gEmail"); + $group->textarea("text")->label(_("Text")) ->id("gText"); + $group->submit(_("Add")); + + comment::_add_validation_rules("comment", $form); + return $form; + } + + static function get_edit_form($comment) { + $form = new Forge(url::site("comment/{$comment->id}"), "", "post", array("id" => "gCommentForm")); + $group = $form->group(_("Edit Comment")); + $group->input("author") ->label(_("Author")) ->id("gAuthor") ->value($comment->author); + $group->input("email") ->label(_("Email")) ->id("gEmail") ->value($comment->email); + $group->textarea("text")->label(_("Text")) ->id("gText") ->value($comment->text); + $group->submit(_("Edit")); + + comment::_add_validation_rules("comment", $form); + return $form; + } + + /** + * @todo Refactor this into a more generic location + */ + private static function _add_validation_rules($model_name, $form) { + $rules = ORM::factory($model_name)->validation_rules; + foreach ($form->inputs as $name => $input) { + if (isset($input->inputs)) { + comment::_add_validation_rules($model_name, $input); + } + if (isset($rules[$name])) { + $input->rules($rules[$name]); + } + } } - static function show_comment_list($item_id) { - $v = new View('comment_list.html'); - $v->item_id = $item_id; - $v->comments = ORM::factory('comment')->where('item_id', $item_id) - ->orderby('datetime', 'desc') - ->find_all()->as_array(); - return $v; + static function block($theme, $show_add_form=true) { + $block = new Block; + $block->id = "gComment"; + $block->title = _("Comments"); + $block->content = comment::get_comments($theme->item()); + + if ($show_add_form) { + $block->content .= comment::get_add_form($theme->item())->render("form.html"); + } + return $block; } - static function show_comment_form($item_id) { - $v = new View('comment_form.html'); - $v->item_id = $item_id; - return $v; + static function get_comments($item) { + $comments = array(""; + return implode("\n", $comments); } /** diff --git a/modules/comment/views/comment.html.php b/modules/comment/views/comment.html.php new file mode 100644 index 00000000..2b306404 --- /dev/null +++ b/modules/comment/views/comment.html.php @@ -0,0 +1,11 @@ + +
  • +

    + author ?> + datetime) ?>, + datetime) ?> +

    +
    + text ?> +
    +
    • diff --git a/modules/comment/views/comment_form.html.php b/modules/comment/views/comment_form.html.php deleted file mode 100644 index 86c76dba..00000000 --- a/modules/comment/views/comment_form.html.php +++ /dev/null @@ -1,35 +0,0 @@ - - - - ')"> - - - -
    - diff --git a/modules/comment/views/comment_list.html.php b/modules/comment/views/comment_list.html.php deleted file mode 100644 index 16371541..00000000 --- a/modules/comment/views/comment_list.html.php +++ /dev/null @@ -1,13 +0,0 @@ - - $comment): ?> -
  • "> -

    - author ?> - datetime) ?>, - datetime) ?> -

    -
    - text ?> -
    -
    • - diff --git a/modules/comment/views/show_comments.html.php b/modules/comment/views/show_comments.html.php deleted file mode 100644 index 35b2c67a..00000000 --- a/modules/comment/views/show_comments.html.php +++ /dev/null @@ -1,11 +0,0 @@ - -
    - -

    - - - - -
    diff --git a/themes/default/js/comment.js b/themes/default/js/comment.js new file mode 100644 index 00000000..5d2ed599 --- /dev/null +++ b/themes/default/js/comment.js @@ -0,0 +1,20 @@ +$("document").ready(function() { + ajaxify_comment_form(); +}); + +function ajaxify_comment_form() { + $("#gCommentForm").ajaxForm({ + target: "#gCommentForm", + complete: function(xhr, statusText) { + ajaxify_comment_form(); + if (xhr.status == 201) { + $.get(xhr.getResponseHeader("Location"), function(data, textStatus) { + $("#gComment div.gBlockContent ul:first").append(data); + $("#gComment div.gBlockContent ul:first li:last").hide().slideDown(); + } + ); + $("#gCommentForm").clearForm(); + } + } + }); +} diff --git a/themes/default/views/page.html.php b/themes/default/views/page.html.php index ac2a326b..75c9a1a9 100644 --- a/themes/default/views/page.html.php +++ b/themes/default/views/page.html.php @@ -14,6 +14,7 @@ + diff --git a/themes/default/views/photo.html.php b/themes/default/views/photo.html.php index 1d54fe7d..8b8f44d4 100644 --- a/themes/default/views/photo.html.php +++ b/themes/default/views/photo.html.php @@ -9,5 +9,5 @@

    title_edit ?>

    description_edit ?>
    - id); ?> + -- cgit v1.2.3