[dev.icinga.com #8886] Require mandatory parameters in controller actions and CLI commands

[icinga-migration]

This issue has been migrated from Redmine: https://dev.icinga.com/issues/8886

Created by elippmann on 2015-03-27 13:50:01 +00:00

Assignee: elippmann
Status: Resolved (closed on 2015-04-07 11:10:05 +00:00)
Target Version: 2.0.0-rc1
Last Update: 2015-04-07 11:10:05 +00:00 (in Redmine)

---

Controller actions and CLI commands may require mandatory parameters. Instead of writing custom code for each of them, we should introduce requiring mandatory parameters in our framework:

Action:

$host = $this->params->req('host');

Param:

public function req($name)
{
    if ($this->has($name) && strlen(($value = $this->get($name))) > 0) {
        return $value;
    }
    throw new MissingParameterException(...);
}

Web should respond with 400 (https://tools.ietf.org/html/rfc7231#section-6.5.1) and may include X-Status-Reason: Missing parameter $name.

Changesets

2015-04-07 08:48:37 +00:00 by elippmann 4d79549

Fix MissingParameterException's PHPDoc

refs #8886

2015-04-07 10:15:15 +00:00 by elippmann 0fc5801

lib: Add MissingParameterException::getParameter and ::setParameter ...

... for getting/setting the name of the missing parameter which caused the exception.

refs #8886

2015-04-07 10:17:59 +00:00 by elippmann 93b1a35

lib: Add UrlParams::req()

UrlParams::req() should be used for requiring a mandatory URL parameter.

refs #8886

2015-04-07 10:20:37 +00:00 by elippmann 002e793

lib: Add Params::req()

Params::req() should be used for requiring a mandatory CLI parameter.

refs #8886

2015-04-07 10:27:19 +00:00 by elippmann 25736cf

Return HTTP 400 on MissingParameterException

refs #8886

2015-04-07 11:06:43 +00:00 by elippmann 6b63f3d

Merge branch 'feature/require-mandatory-params-8886'

resolves #8886

---

Relations:

• blocks #7488
• blocks #7490

[icinga-migration]

Updated by elippmann on 2015-03-27 14:31:16 +00:00

• Blocks set to 7488

[icinga-migration]

Updated by elippmann on 2015-03-27 14:31:29 +00:00

• Blocks set to 7490

[icinga-migration]

Updated by elippmann on 2015-03-27 14:34:22 +00:00

• Description updated

[icinga-migration]

Updated by elippmann on 2015-04-07 08:46:59 +00:00

• Status changed from New to Assigned
• Assigned to set to elippmann

[icinga-migration]

Updated by elippmann on 2015-04-07 08:52:46 +00:00

• Description updated

[icinga-migration]

Updated by elippmann on 2015-04-07 11:10:05 +00:00

• Status changed from Assigned to Resolved
• Done % changed from 0 to 100

Applied in changeset 6b63f3d.