From f383a5ed212380cfda1c4b6dfd4075caf864951f Mon Sep 17 00:00:00 2001 From: Marcin Kurczewski Date: Sat, 3 May 2014 11:43:29 +0200 Subject: [PATCH] Moved JobArgs to Jobs Reason: trying to make unique string for every possible argument in global fashion is difficult. For example it would make sense for EditPostRelationsJob to accept argument named "post-ids", but it wouldn't make much sense for AddPostJob to accept "post-ids" since it doesn't tell much. Thus, common arguments are going to be defined in top-level AbstractJob for ease of control, while more job-specific arguments are going to be specified in respective job implementations. --- src/Controllers/CommentController.php | 14 +++++++------- src/Controllers/LogController.php | 6 +++--- src/Controllers/PostController.php | 10 +++++----- src/Jobs/Abstraction/AbstractJob.php | 9 +++++++++ src/Jobs/Abstraction/AbstractPostEditJob.php | 2 +- src/Jobs/Abstraction/JobArgs.php | 12 ------------ src/Jobs/AddCommentJob.php | 4 ++-- src/Jobs/DeleteCommentJob.php | 2 +- src/Jobs/EditCommentJob.php | 4 ++-- src/Jobs/GetLogJob.php | 6 +++--- src/Jobs/ListCommentsJob.php | 2 +- src/Jobs/ListPostsJob.php | 4 ++-- src/Jobs/PreviewCommentJob.php | 2 +- src/Jobs/TogglePostTagJob.php | 4 ++-- 14 files changed, 39 insertions(+), 42 deletions(-) delete mode 100644 src/Jobs/Abstraction/JobArgs.php diff --git a/src/Controllers/CommentController.php b/src/Controllers/CommentController.php index aeac8357..3218d40b 100644 --- a/src/Controllers/CommentController.php +++ b/src/Controllers/CommentController.php @@ -6,7 +6,7 @@ class CommentController $ret = Api::run( new ListCommentsJob(), [ - JobArgs::PAGE_NUMBER => $page, + ListCommentsJob::PAGE_NUMBER => $page, ]); $context = getContext(); @@ -23,7 +23,7 @@ class CommentController $comment = Api::run( new PreviewCommentJob(), [ - JobArgs::TEXT => InputHelper::get('text') + PreviewCommentJob::TEXT => InputHelper::get('text') ]); getContext()->transport->textPreview = $comment->getText(); @@ -37,8 +37,8 @@ class CommentController Api::run( new AddCommentJob(), [ - JobArgs::POST_ID => InputHelper::get('post-id'), - JobArgs::TEXT => InputHelper::get('text') + AddCommentJob::POST_ID => InputHelper::get('post-id'), + AddCommentJob::TEXT => InputHelper::get('text') ]); } @@ -55,8 +55,8 @@ class CommentController Api::run( new EditCommentJob(), [ - JobArgs::COMMENT_ID => $id, - JobArgs::TEXT => InputHelper::get('text') + EditCommentJob::COMMENT_ID => $id, + EditCommentJob::TEXT => InputHelper::get('text') ]); } @@ -65,7 +65,7 @@ class CommentController $comment = Api::run( new DeleteCommentJob(), [ - JobArgs::COMMENT_ID => $id, + DeleteCommentJob::COMMENT_ID => $id, ]); } } diff --git a/src/Controllers/LogController.php b/src/Controllers/LogController.php index 9466e57b..36d0e0a2 100644 --- a/src/Controllers/LogController.php +++ b/src/Controllers/LogController.php @@ -30,9 +30,9 @@ class LogController $ret = Api::run( new GetLogJob(), [ - JobArgs::PAGE_NUMBER => $page, - JobArgs::LOG_ID => $name, - JobArgs::QUERY => $filter, + GetLogJob::PAGE_NUMBER => $page, + GetLogJob::LOG_ID => $name, + GetLogJob::QUERY => $filter, ]); //stylize important lines diff --git a/src/Controllers/PostController.php b/src/Controllers/PostController.php index 3e23aed2..52f61aa0 100644 --- a/src/Controllers/PostController.php +++ b/src/Controllers/PostController.php @@ -42,8 +42,8 @@ class PostController $ret = Api::run( new ListPostsJob(), [ - JobArgs::PAGE_NUMBER => $page, - JobArgs::QUERY => $query + ListPostsJob::PAGE_NUMBER => $page, + ListPostsJob::QUERY => $query ]); $context->transport->posts = $ret->posts; @@ -78,9 +78,9 @@ class PostController Api::run( new TogglePostTagJob(), [ - JobArgs::POST_ID => $id, - JobArgs::TAG_NAME => $tag, - JobArgs::STATE => $enable, + TogglePostTagJob::POST_ID => $id, + TogglePostTagJob::TAG_NAME => $tag, + TogglePostTagJob::STATE => $enable, ]); } diff --git a/src/Jobs/Abstraction/AbstractJob.php b/src/Jobs/Abstraction/AbstractJob.php index 1fb156dc..64f099b9 100644 --- a/src/Jobs/Abstraction/AbstractJob.php +++ b/src/Jobs/Abstraction/AbstractJob.php @@ -1,6 +1,15 @@ getArgument(JobArgs::POST_ID); + $postId = $this->getArgument(self::POST_ID); $this->post = PostModel::findByIdOrName($postId); } } diff --git a/src/Jobs/Abstraction/JobArgs.php b/src/Jobs/Abstraction/JobArgs.php deleted file mode 100644 index 0810036b..00000000 --- a/src/Jobs/Abstraction/JobArgs.php +++ /dev/null @@ -1,12 +0,0 @@ -getArgument(JobArgs::POST_ID)); - $text = CommentModel::validateText($this->getArgument(JobArgs::TEXT)); + $post = PostModel::findById($this->getArgument(self::POST_ID)); + $text = CommentModel::validateText($this->getArgument(self::TEXT)); $comment = CommentModel::spawn(); $comment->setCommenter($user); diff --git a/src/Jobs/DeleteCommentJob.php b/src/Jobs/DeleteCommentJob.php index b7f6e7ae..45bb83c1 100644 --- a/src/Jobs/DeleteCommentJob.php +++ b/src/Jobs/DeleteCommentJob.php @@ -5,7 +5,7 @@ class DeleteCommentJob extends AbstractJob public function prepare() { - $this->comment = CommentModel::findById($this->getArgument(JobArgs::COMMENT_ID)); + $this->comment = CommentModel::findById($this->getArgument(self::COMMENT_ID)); } public function execute() diff --git a/src/Jobs/EditCommentJob.php b/src/Jobs/EditCommentJob.php index b2c70ff6..6d5d097a 100644 --- a/src/Jobs/EditCommentJob.php +++ b/src/Jobs/EditCommentJob.php @@ -5,7 +5,7 @@ class EditCommentJob extends AbstractJob public function prepare() { - $this->comment = CommentModel::findById($this->getArgument(JobArgs::COMMENT_ID)); + $this->comment = CommentModel::findById($this->getArgument(self::COMMENT_ID)); } public function execute() @@ -13,7 +13,7 @@ class EditCommentJob extends AbstractJob $comment = $this->comment; $comment->commentDate = time(); - $comment->text = CommentModel::validateText($this->getArgument(JobArgs::TEXT)); + $comment->text = CommentModel::validateText($this->getArgument(self::TEXT)); CommentModel::save($comment); LogHelper::log('{user} edited comment in {post}', [ diff --git a/src/Jobs/GetLogJob.php b/src/Jobs/GetLogJob.php index 912ddfb0..a886a6e5 100644 --- a/src/Jobs/GetLogJob.php +++ b/src/Jobs/GetLogJob.php @@ -3,9 +3,9 @@ class GetLogJob extends AbstractJob { public function execute() { - $page = $this->getArgument(JobArgs::PAGE_NUMBER); - $name = $this->getArgument(JobArgs::LOG_ID); - $query = $this->getArgument(JobArgs::QUERY); + $page = $this->getArgument(self::PAGE_NUMBER); + $name = $this->getArgument(self::LOG_ID); + $query = $this->getArgument(self::QUERY); //parse input $page = max(1, intval($page)); diff --git a/src/Jobs/ListCommentsJob.php b/src/Jobs/ListCommentsJob.php index cda2bfb9..463dc806 100644 --- a/src/Jobs/ListCommentsJob.php +++ b/src/Jobs/ListCommentsJob.php @@ -3,7 +3,7 @@ class ListCommentsJob extends AbstractJob { public function execute() { - $page = $this->getArgument(JobArgs::PAGE_NUMBER); + $page = $this->getArgument(self::PAGE_NUMBER); $page = max(1, intval($page)); $commentsPerPage = intval(getConfig()->comments->commentsPerPage); diff --git a/src/Jobs/ListPostsJob.php b/src/Jobs/ListPostsJob.php index 34928d39..524493ba 100644 --- a/src/Jobs/ListPostsJob.php +++ b/src/Jobs/ListPostsJob.php @@ -3,8 +3,8 @@ class ListPostsJob extends AbstractJob { public function execute() { - $page = $this->getArgument(JobArgs::PAGE_NUMBER); - $query = $this->getArgument(JobArgs::QUERY); + $page = $this->getArgument(self::PAGE_NUMBER); + $query = $this->getArgument(self::QUERY); $page = max(1, intval($page)); $postsPerPage = intval(getConfig()->browsing->postsPerPage); diff --git a/src/Jobs/PreviewCommentJob.php b/src/Jobs/PreviewCommentJob.php index 04f235bd..7e9e501a 100644 --- a/src/Jobs/PreviewCommentJob.php +++ b/src/Jobs/PreviewCommentJob.php @@ -4,7 +4,7 @@ class PreviewCommentJob extends AbstractJob public function execute() { $user = Auth::getCurrentUser(); - $text = CommentModel::validateText($this->getArgument(JobArgs::TEXT)); + $text = CommentModel::validateText($this->getArgument(self::TEXT)); $comment = CommentModel::spawn(); $comment->setCommenter($user); diff --git a/src/Jobs/TogglePostTagJob.php b/src/Jobs/TogglePostTagJob.php index 642fe14e..fbffc8c8 100644 --- a/src/Jobs/TogglePostTagJob.php +++ b/src/Jobs/TogglePostTagJob.php @@ -3,8 +3,8 @@ class TogglePostTagJob extends AbstractPostEditJob { public function execute() { - $tagName = $this->getArgument(JobArgs::TAG_NAME); - $enable = boolval($this->getArgument(JobArgs::STATE)); + $tagName = $this->getArgument(self::TAG_NAME); + $enable = boolval($this->getArgument(self::STATE)); $post = $this->post; $tags = $post->getTags();