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

Public Member Functions

 addClipboard ()
 
 editCliboard ($clipboard_id=null)
 
 deleteClipboard ($clipboard_id=null)
 
 addClipboardItem ($clipboard_id=null)
 
 removeClipboardItem ($clipboard_id=null, $range_id=null)
 
- 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

This file contains the REST class for the clipboard system.

Author
Moritz Strohm stroh.nosp@m.m@da.nosp@m.ta-qu.nosp@m.est..nosp@m.de
Since
4.5

Member Function Documentation

addClipboard ( )

Adds a new clipboard.

Postcondition
/clipboard/add
addClipboardItem (   $clipboard_id = null)

Adds an item to a clipboard.

Postcondition
/clipboard/:clipboard_id/item
deleteClipboard (   $clipboard_id = null)

Deletes a clipboard.

/clipboard/:clipboard_id

editCliboard (   $clipboard_id = null)

Edits a clipboard.

/clipboard/:clipboard_id

removeClipboardItem (   $clipboard_id = null,
  $range_id = null 
)

Removes an item (selected by its range-ID) from a clipboard.

/clipboard/:clipboard_id/item/:range_id


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