Messages Class Reference

Inheritance diagram for Messages:

Collaboration diagram for Messages:

Public Member Functions
	indexOfFolders ($user_id, $box)
	showFolder ($user_id, $box, $folder_id)
	showMessage ($message_id)
	createMessage ()
	updateMessage ($message_id)
	destroyMessage ($message_id)
Public Member Functions inherited from RouteMap
	__construct ()
	init ($router, $route, $request_body=null)
	paginated ($data, $total, $uri_params=array(), $query_params=array())
	paginate ($uri_format, $total, $offset=null, $limit=null)
	collect ($data)
	status ($status)
	headers ($headers=array())
	body ($body)
	contentType ($mime_type, $params=array())
	error ($status, $body=null)
	etag ($value, $strong_etag=true, $new_resource=null)
	expires ($amount, $cache_control=array())
	cacheControl ($values)
	halt ()
	lastModified ($time)
	notFound ($body=null)
	redirect ($url, $args=null)
	sendFile ($_path, $opts=array())
	url ($addr, $url_params=null)
	urlf ($addr_f, $format_params, $url_params=null)

Additional Inherited Members
Protected Attributes inherited from RouteMap
	$pagination = false
	$offset
	$limit

Detailed Description

Author

mlunz.nosp@m.ena@.nosp@m.uos.d.nosp@m.e @license GPL 2 or later

@condition message_id ^[a-f0-9]{32}$ @condition user_id ^[a-f0-9]{32}$ @condition box ^(inbox|outbox)$ @condition folder_id ^[0-9]+$

Member Function Documentation

createMessage()

createMessage

(

)

Schreibt eine neue Nachricht.

Postcondition

/messages

Here is the call graph for this function:

destroyMessage()

destroyMessage

(

$message_id

)

Löscht eine Nachricht.

@delete /message/:message_id

Here is the call graph for this function:

indexOfFolders()

indexOfFolders	(		$user_id,
			$box
	)

Liefert die vorhandenen Nachrichtenordner des autorisierten Nutzers zurück. Der Parameter bestimmt je nach Wert, auf welchen Bereich zugegriffen werden soll. Die Rückgabe beinhaltet pro Ordner den Namen, die Anzahl aller Nachrichten sowie die Anzahl der ungelesenen Nachrichten.

@get /user/:user_id/:box

Here is the call graph for this function:

showFolder()

showFolder	(		$user_id,
			$box,
			$folder_id
	)

Liefert die vorhandenen Nachrichten eines Ordners des autorisierten Nutzers zurück.

@get /user/:user_id/:box/:folder_id

Here is the call graph for this function:

showMessage()

showMessage

(

$message_id

)

Liefert die Daten der angegebenen Nachricht zurück.

@get /message/:message_id

Here is the call graph for this function:

updateMessage()

updateMessage

(

$message_id

)

Eine Nachricht als (un)gelesen markieren oder in einen anderen Ordner verschieben (Ordner werden dabei als Array und vollständig angegeben, [/user/:user_id/:box/:folder]).

@put /message/:message_id

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• app/routes/Messages.php