diff options
| author | Luke Shumaker <LukeShu@sbcglobal.net> | 2014-02-10 21:00:19 -0500 |
|---|---|---|
| committer | Luke Shumaker <LukeShu@sbcglobal.net> | 2014-02-10 21:00:19 -0500 |
| commit | cebc7115d133801d438836d622600e2f472bc831 (patch) | |
| tree | 2dc0b773e9c94d0b484032b0f23d6cc93ae26675 /docs | |
| parent | 8596b22b91d59f4591634efb9cb4334076ddc30a (diff) | |
Document the MessagesController.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/DesignDocument.md | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md index 65603c4..e896202 100644 --- a/docs/DesignDocument.md +++ b/docs/DesignDocument.md @@ -153,7 +153,9 @@ layouts/application.html (abstract) logout button that causes a POST to `LoginController#logout()`. It may contain an alert box of recent alerts submitted by a tournament host. It contains a searc form that is POSTed to - `SearchController#show_results`. + `SearchController#show_results`. If the user is authorized to + publish alerts, it also contains a button that causes the browser + to GET `MessagesController#new_alert()`. common/permission_denied.html : A generic page for when a user attempts to do something for which @@ -309,12 +311,21 @@ SearchController view. MessagesController - : TODO + : This controller handles inter-user messages. It has a couple + methods that respond to GET requests: + + - `new_alert()` Renders the `messages/new_alert` template, + assuming the user has permission. + - `show_private()` Renders the `messages/private template, + assuming the user has permission. + + It also has methods that respond to POST requests: - - `new_alert()` TODO: GET - - `post_alert()` TODO: POST - - `show_private()` TODO: GET - - `post_private()` TODO: POST + - `post_alert()` Publishes a new system-wide alert, assuming the + user has permission. It then redirects the browser to whichever + page it would otherwise be on. + - `post_private()` Sends a new private message, assuming the user + has permission. TournamentsController : This controller will have methods: |