Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Blubber Class Reference
Inheritance diagram for Blubber:
RouteMap

Public Member Functions

 getThreadData ($thread_id)
 
 getMyThreads ()
 
 postComment ($thread_id)
 
 editComment ($thread_id, $comment_id)
 
 getComments ($thread_id)
 
 threadIsFollowed ($thread_id)
 
 followThread ($thread_id)
 
 unfollowThread ($thread_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

GPL 2 or later

course_id ^[a-f0-9]{1,32}$ stream_id ^(global|[a-f0-9]{1,32})$ user_id ^[a-f0-9]{1,32}$ blubber_id ^[a-f0-9]{1,32}$

Member Function Documentation

editComment (   $thread_id,
  $comment_id 
)

Write a comment to a thread

/blubber/threads/:thread_id/comments/:comment_id

Parameters
string$thread_idid of the blubber thread
string$commentid of the comment
Returns
Array the comment as array
followThread (   $thread_id)

User follows a thread.

Postcondition
/blubber/threads/:thread_id/follow
Parameters
string$thread_idid of the blubber thread
getComments (   $thread_id)

Write a comment to a thread

/blubber/threads/:thread_id/comments

Parameters
string$thread_idid of the blubber thread
Returns
Array the comments as array
getMyThreads ( )

Get threads

/blubber/threads

Returns
Array the stream as array
getThreadData (   $thread_id)

Get content and some comments for a blubber-thread or for the "global" thread all "public" threads.

/blubber/threads/:thread_id

Parameters
string$thread_idid of the blubber thread or "global" if you want public threads (not comments). Remind the global thread is a virtual thread with a special behaviour.
Returns
Array the blubber as array
postComment (   $thread_id)

Write a comment to a thread

Postcondition
/blubber/threads/:thread_id/comments
Parameters
string$thread_idid of the blubber thread
Returns
Array the comment as array
threadIsFollowed (   $thread_id)

Does the current user follow the thread?

/blubber/threads/:thread_id/follow

unfollowThread (   $thread_id)

User unfollows a thread.

/blubber/threads/:thread_id/follow

Parameters
string$thread_idid of the blubber thread

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