From 3ebb751cda5d47147a5c828b4cb32ecd4a9f8042 Mon Sep 17 00:00:00 2001 From: Jozef Selesi Date: Tue, 18 Nov 2008 08:28:32 +0000 Subject: First iteration of REST controller refactoring. RESTful controllers that refer to collections should now have plural names and there should be only one controller per resource. Updated existing classes that implement REST_Controller. The routing now works like this: GET /controller -> controller::_index() POST /controller -> controller::_create() GET /controller/id -> controller::_show() PUT /controller/id -> controller::_update() DELETE /controller/id -> controller::_delete() GET /form/edit/controller/resource_id -> controller::_form() GET /form/add/controller/data -> controller::_form() --- modules/comment/controllers/comment.php | 85 ------------------------------- modules/comment/controllers/comments.php | 87 ++++++++++++++++++++++---------- modules/comment/helpers/comment.php | 7 +-- 3 files changed, 65 insertions(+), 114 deletions(-) delete mode 100644 modules/comment/controllers/comment.php (limited to 'modules/comment') diff --git a/modules/comment/controllers/comment.php b/modules/comment/controllers/comment.php deleted file mode 100644 index 546f3d67..00000000 --- a/modules/comment/controllers/comment.php +++ /dev/null @@ -1,85 +0,0 @@ -as_array(), array("comment")); - break; - - case "json": - print json_encode($comment->as_array()); - break; - - default: - $v = new View("comment.$output_format"); - $v->comment = $comment; - print $v; - } - } - - - /** - * Update existing comment. - * @see Rest_Controller::_put($resource) - */ - public function _put($comment) { - $form = comment::get_edit_form($comment); - if ($form->validate()) { - $comment->author = $this->input->post('author'); - $comment->email = $this->input->post('email'); - $comment->text = $this->input->post('text'); - $comment->save(); - return; - } - print $form; - } - - /** - * Add a new comment - * @see Rest_Controller::_post($resource) - */ - public function _post($comment) { - throw new Exception("@todo Comment_Controller::_post NOT IMPLEMENTED"); - } - - /** - * Delete existing comment. - * @see Rest_Controller::_delete($resource) - */ - public function _delete($resource) { - throw new Exception("@todo Comment_Controller::_delete NOT IMPLEMENTED"); - } -} diff --git a/modules/comment/controllers/comments.php b/modules/comment/controllers/comments.php index ab3be76f..b51e7e4e 100644 --- a/modules/comment/controllers/comments.php +++ b/modules/comment/controllers/comments.php @@ -18,59 +18,94 @@ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */ class Comments_Controller extends REST_Controller { - protected $resource_type = "item"; + protected $resource_type = "comment"; /** - * Present a form for adding a new comment to this item - * @see Rest_Controller::form($resource) + * Display comments based on criteria. + * @see Rest_Controller::_delete($resource) */ - public function _form($item) { - $form = comment::get_add_form($item); - print $form; + public function _index($query) { + throw new Exception("@todo Comment_Controller::_index NOT IMPLEMENTED"); } /** - * Show the comment collection - * @see Rest_Controller::_get($resource, $format) + * Add a new comment to the collection. + * @see Rest_Controller::_create($resource) */ - public function _get($item, $output_format) { - print comment::get_comments($item, $output_format); + public function _create($comment) { + $form = comment::get_add_form($this->input->post('item_id')); + if ($form->validate()) { + $comment->author = $this->input->post('author'); + $comment->email = $this->input->post('email'); + $comment->text = $this->input->post('text'); + $comment->datetime = time(); + $comment->item_id = $this->input->post('item_id'); + $comment->save(); + + header("HTTP/1.1 201 Created"); + header("Location: " . url::site("comments/{$comment->id}")); + } + // @todo Return appropriate HTTP status code indicating error. + print $form; } /** - * Update existing comment collection. - * @see Rest_Controller::_put($resource) + * Display an existing comment. + * @see Rest_Controller::_show($resource, $format) */ - public function _put($item) { - throw new Exception("@todo Comment_Controller::_put NOT IMPLEMENTED"); + public function _show($comment, $output_format) { + switch ($output_format) { + case "xml": + print xml::to_xml($comment->as_array(), array("comment")); + break; + + case "json": + print json_encode($comment->as_array()); + break; + + default: + $v = new View("comment.$output_format"); + $v->comment = $comment; + print $v; + } } /** - * Add a new comment to the collection - * @see Rest_Controller::_post($resource) + * Change an existing comment. + * @see Rest_Controller::_update($resource) */ - public function _post($item) { - $form = comment::get_add_form($item); + public function _update($comment) { + $form = comment::get_edit_form($comment); 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}")); + return; } + // @todo Return appropriate HTTP status code indicating error. print $form; } /** - * Delete existing comment collection. + * Delete existing comment. * @see Rest_Controller::_delete($resource) */ - public function _delete($item) { + public function _delete($comment) { throw new Exception("@todo Comment_Controller::_delete NOT IMPLEMENTED"); } + + /** + * Present a form for adding a new comment to this item or editing an existing comment. + * @see Rest_Controller::form($resource) + */ + public function _form($resource, $form_type) { + // This code will be clearer if we split form() into two functions. + if ($form_type == "edit") { + $form = comment::get_edit_form($resource); + } else { + $form = comment::get_add_form($resource); + } + print $form; + } } diff --git a/modules/comment/helpers/comment.php b/modules/comment/helpers/comment.php index fd82d771..aaae7c17 100644 --- a/modules/comment/helpers/comment.php +++ b/modules/comment/helpers/comment.php @@ -54,12 +54,13 @@ class Comment_Core { return $comment->save(); } - static function get_add_form($item) { - $form = new Forge(url::site("comments/{$item->id}"), "", "post", array("id" => "gCommentForm")); + static function get_add_form($item_id) { + $form = new Forge(url::site("comments"), "", "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->hidden("item_id")->value($item_id); $group->submit(_("Add")); $form->add_rules_from(ORM::factory("comment")); return $form; @@ -67,7 +68,7 @@ class Comment_Core { static function get_edit_form($comment) { $form = new Forge( - url::site("comment/{$comment->id}?_method=put"), "", "post", array("id" => "gCommentForm")); + url::site("comments/{$comment->id}?_method=put"), "", "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); -- cgit v1.2.3