Public Member Functions | |
| indexOfMessages ($user_id, $box) | |
| getMessages ($user_id, $box) | |
| showMessage ($message_id) | |
| getTopFolder ($message_id) | |
| createMessage () | |
| updateMessage ($message_id) | |
| destroyMessage ($message_id) | |
 Public Member Functions inherited from RouteMap | |
| __construct () | |
| init ($router, $route) | |
| paginated ($data, $total, $uri_params=[], $query_params=[]) | |
| paginate ($uri_format, $total, $offset=null, $limit=null) | |
| collect ($data) | |
| status ($status) | |
| headers ($headers=[]) | |
| body ($body) | |
| contentType ($mime_type, $params=[]) | |
| error ($status, $body=null) | |
| etag ($value, $strong_etag=true, $new_resource=null) | |
| expires ($amount, $cache_control=[]) | |
| cacheControl ($values) | |
| halt () | |
| lastModified ($time) | |
| notFound ($body=null) | |
| redirect ($url, $args=null) | |
| sendFile ($_path, $opts=[]) | |
| url ($addr, $url_params=null) | |
| urlf ($addr_f, $format_params, $url_params=null) | |
| getRoutes ($http_method=null) | |
| getResponse () | |
Additional Inherited Members | |
| Protected Member Functions inherited from RouteMap | |
| extractConditions ($docblock, $conditions=[]) | |
| Protected Attributes inherited from RouteMap | |
| $router | |
| $route | |
| $data = null | |
| $response | |
| $pagination = false | |
| $offset | |
| $limit | |
Detailed Description
message_id ^[a-f0-9]{1,32}$ user_id ^[a-f0-9]{1,32}$ box ^(inbox|outbox)$
Member Function Documentation
◆ createMessage()
| createMessage | ( | ) |
Schreibt eine neue Nachricht.
- Postcondition
- /messages
◆ destroyMessage()
| destroyMessage | ( | $message_id | ) |
Löscht eine Nachricht.
/message/:message_id
◆ getMessages()
| getMessages | ( | $user_id, | |
| $box | |||
| ) |
Liefert die vorhandenen Nachrichten des autorisierten Nutzers zurück.
/user/:user_id/:box
◆ getTopFolder()
| getTopFolder | ( | $message_id | ) |
Get the root file folder of a message. The root file folder contains all files that were appended to the message.
/message/:message_id/file_folder
◆ indexOfMessages()
| indexOfMessages | ( | $user_id, | |
| $box | |||
| ) |
Liefert die Anzahl der vorhandenen Nachrichten des autorisierten Nutzers zurück. Der Parameter bestimmt je nach Wert, auf welchen Bereich (Posteingang bzw. Postausgang) zugegriffen werden soll. Die Rückgabe beinhaltet jeweils die Anzahl aller Nachrichten sowie die Anzahl der ungelesenen Nachrichten.
/user/:user_id/:box
◆ showMessage()
| showMessage | ( | $message_id | ) |
Liefert die Daten der angegebenen Nachricht zurück.
/message/:message_id
◆ updateMessage()
| updateMessage | ( | $message_id | ) |
Eine Nachricht als (un)gelesen markieren.
/message/:message_id
The documentation for this class was generated from the following file:
- app/routes/Messages.php
