From e8364947ab652ce3be59c00ace3451b652a5855d Mon Sep 17 00:00:00 2001 From: vargenau Date: Fri, 16 Dec 2011 13:26:15 +0000 Subject: [PATCH] Consistent messages for missing required arguments git-svn-id: svn://svn.code.sf.net/p/phpwiki/code/trunk@8212 96ab9672-09ca-45d6-a79d-3d69d39ca109 --- lib/plugin/AddComment.php | 5 +++-- lib/plugin/Chart.php | 4 ++-- lib/plugin/CreateBib.php | 2 +- lib/plugin/CreateToc.php | 2 +- lib/plugin/FileInfo.php | 10 ++++++---- lib/plugin/GoogleMaps.php | 4 ++-- lib/plugin/IncludePage.php | 2 +- lib/plugin/ModeratedPage.php | 5 +++-- lib/plugin/PageGroup.php | 6 +----- lib/plugin/SyntaxHighlighter.php | 4 +++- lib/plugin/Template.php | 2 +- lib/plugin/WikiForum.php | 5 +++-- lib/plugin/WikiPoll.php | 5 +++-- 13 files changed, 30 insertions(+), 26 deletions(-) diff --git a/lib/plugin/AddComment.php b/lib/plugin/AddComment.php index f895a53cc..de9c4a203 100644 --- a/lib/plugin/AddComment.php +++ b/lib/plugin/AddComment.php @@ -69,8 +69,9 @@ extends WikiPlugin_WikiBlog function run($dbi, $argstr, &$request, $basepage) { $args = $this->getArgs($argstr, $request); - if (!$args['pagename']) - return $this->error(_("No pagename specified")); + if (!$args['pagename']) { + return $this->error(sprintf(_("A required argument '%s' is missing."), 'pagename')); + } // Get our form args. $comment = $request->getArg("comment"); diff --git a/lib/plugin/Chart.php b/lib/plugin/Chart.php index 2e6617345..3de646d02 100644 --- a/lib/plugin/Chart.php +++ b/lib/plugin/Chart.php @@ -62,7 +62,7 @@ extends WikiPlugin // 'ylabel' => 'y', // TODO 'color' => 'green', // 'legend' => false, // TODO - 'data' => false // mandatory + 'data' => false // required ); } function handle_plugin_args_cruft(&$argstr, &$args) { @@ -74,7 +74,7 @@ extends WikiPlugin global $WikiTheme; $args = $this->getArgs($argstr, $request); if (!$args['data']) { - return $this->error(sprintf(_("No mandatory '%s' argument provided."), 'data')); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'data')); } extract($args); diff --git a/lib/plugin/CreateBib.php b/lib/plugin/CreateBib.php index fd2e4baa1..41d67ab6c 100644 --- a/lib/plugin/CreateBib.php +++ b/lib/plugin/CreateBib.php @@ -108,7 +108,7 @@ extends WikiPlugin $pagename = $page->name; } if (!$pagename) { - return $this->error(_("no page specified")); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'pagename')); } // Get the links page contents diff --git a/lib/plugin/CreateToc.php b/lib/plugin/CreateToc.php index 76aba5b64..22832aa5b 100644 --- a/lib/plugin/CreateToc.php +++ b/lib/plugin/CreateToc.php @@ -375,7 +375,7 @@ extends WikiPlugin $pagename = $page->name; } if (!$pagename) { - return $this->error(_("No page specified.")); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'pagename')); } if (isBrowserIE() and browserDetect("Mac")) { $jshide = 0; diff --git a/lib/plugin/FileInfo.php b/lib/plugin/FileInfo.php index 0f80fde58..340c37be4 100644 --- a/lib/plugin/FileInfo.php +++ b/lib/plugin/FileInfo.php @@ -50,17 +50,19 @@ extends WikiPlugin 'display' => false, // version,phonysize,size,date,mtime,owner,name,path,dirname,link. (required) 'format' => false, // printf format string with %s only, all display modes 'quiet' => false // print no error if file not found - // from above vars return strings (optional) + // from above vars return strings (optional) ); } function run($dbi, $argstr, &$request, $basepage) { - $args = $this->getArgs($argstr, $request); + $args = $this->getArgs($argstr, $request); extract($args); - if (!$file) + if (!$file) { return $this->error(sprintf(_("A required argument '%s' is missing."), 'file')); - if (!$display) + } + if (!$display) { return $this->error(sprintf(_("A required argument '%s' is missing."), 'display')); + } if (string_starts_with($file, "Upload:")) { $file = preg_replace("/^Upload:(.*)$/", getUploadFilePath()."\\1", $file); $is_Upload = 1; diff --git a/lib/plugin/GoogleMaps.php b/lib/plugin/GoogleMaps.php index debc8911f..7d13e1688 100644 --- a/lib/plugin/GoogleMaps.php +++ b/lib/plugin/GoogleMaps.php @@ -88,10 +88,10 @@ extends WikiPlugin extract($args); if ($Longitude === '') { - return $this->error(fmt("%s parameter missing", "'Longitude'")); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'Longitude')); } if ($Latitude === '') { - return $this->error(fmt("%s parameter missing", "'Latitude'")); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'Latitude')); } $maps = JavaScript('',array('src'=>"http://maps.google.com/maps?file=api&v=1&key=" . GOOGLE_LICENSE_KEY)); diff --git a/lib/plugin/IncludePage.php b/lib/plugin/IncludePage.php index b6560ee35..55f850e3d 100644 --- a/lib/plugin/IncludePage.php +++ b/lib/plugin/IncludePage.php @@ -75,7 +75,7 @@ extends WikiPlugin $page = $page->name; } if (!$page) { - return $this->error(_("no page specified")); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'page')); } // A page can include itself once (this is needed, e.g., when editing diff --git a/lib/plugin/ModeratedPage.php b/lib/plugin/ModeratedPage.php index f861a2e25..cba958181 100644 --- a/lib/plugin/ModeratedPage.php +++ b/lib/plugin/ModeratedPage.php @@ -59,8 +59,9 @@ extends WikiPlugin // Handle moderation request from urls sent by email if (!empty($args['id']) and !empty($args['pass'])) { - if (!$args['page']) - return $this->error("No page specified"); + if (!$args['page']) { + return $this->error(sprintf(_("A required argument '%s' is missing."), 'page')); + } $page = $dbi->getPage($args['page']); if ($moderated = $page->get("moderated")) { if (array_key_exists($args['id'], $moderated['data'])) { diff --git a/lib/plugin/PageGroup.php b/lib/plugin/PageGroup.php index 18203c16e..458564262 100644 --- a/lib/plugin/PageGroup.php +++ b/lib/plugin/PageGroup.php @@ -92,11 +92,7 @@ extends WikiPlugin $args = $this->getArgs($argstr, $request); extract($args); if (empty($parent)) { - // FIXME: WikiPlugin has no way to report when - // required args are missing? - $error_text = sprintf("%s: ", "WikiPlugin_" .$this->getName()); - $error_text .= sprintf(_("A required argument '%s' is missing."), 'parent'); - return HTML::div(array('class' => "error"), $error_text); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'parent')); } $directions = array ('next' => _("Next"), 'previous' => _("Previous"), diff --git a/lib/plugin/SyntaxHighlighter.php b/lib/plugin/SyntaxHighlighter.php index a48a5ed2d..6b56d1f76 100644 --- a/lib/plugin/SyntaxHighlighter.php +++ b/lib/plugin/SyntaxHighlighter.php @@ -122,7 +122,9 @@ extends WikiPlugin function run($dbi, $argstr, &$request, $basepage) { extract($this->getArgs($argstr, $request)); $source =& $this->source; - if (empty($syntax)) return $this->error(_("Syntax language not specified.")); + if (empty($syntax)) { + return $this->error(sprintf(_("A required argument '%s' is missing."), 'syntax')); + } if (!empty($source)) { $args = ""; if (defined('HIGHLIGHT_DATA_DIR')) diff --git a/lib/plugin/Template.php b/lib/plugin/Template.php index 7b212e650..f46b60f30 100644 --- a/lib/plugin/Template.php +++ b/lib/plugin/Template.php @@ -105,7 +105,7 @@ extends WikiPlugin $page = $page->name; } if (!$page) { - return $this->error(_("No page specified.")); + return $this->error(sprintf(_("A required argument '%s' is missing."), 'page')); } // If "Template:$page" exists, use it diff --git a/lib/plugin/WikiForum.php b/lib/plugin/WikiForum.php index 72f511181..44201bf29 100644 --- a/lib/plugin/WikiForum.php +++ b/lib/plugin/WikiForum.php @@ -67,8 +67,9 @@ extends WikiPlugin_WikiBlog function run($dbi, $argstr, &$request, $basepage) { $args = $this->getArgs($argstr, $request); - if (!$args['pagename']) - return $this->error(_("No pagename specified")); + if (!$args['pagename']) { + return $this->error(sprintf(_("A required argument '%s' is missing."), 'pagename')); + } // Get our form args. $forum = $request->getArg('forum'); diff --git a/lib/plugin/WikiPoll.php b/lib/plugin/WikiPoll.php index fb7a7e4ff..a741cac27 100644 --- a/lib/plugin/WikiPoll.php +++ b/lib/plugin/WikiPoll.php @@ -139,8 +139,9 @@ extends WikiPlugin $_SERVER =& $GLOBALS['HTTP_SERVER_VARS']; $request->setArg('nocache','purge'); $args = $this->getArgs($argstr, $request); - if (!$args['page']) - return $this->error("No page specified"); + if (!$args['page']) { + return $this->error(sprintf(_("A required argument '%s' is missing."), 'page')); + } if (!empty($args['admin']) and $request->_user->isAdmin()) { // reset statistics return $this->doPollAdmin($dbi, $request, $page); -- 2.45.0