Stud.IP  5.4
ResourceCategories Class Reference
Inheritance diagram for ResourceCategories:

Public Member Functions

 before ()
 getAllResourceCategories ()
 getResourceCategory ($category_id)
 addResourceCategory ()
 editResourceCategory ($category_id)
 deleteResourceCategory ($category_id)
 getResourceCategoryProperties ($category_id)
 getResourceCategoryResources ($category_id)
 createResource ($category_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
 $data = null
 $pagination = false

Detailed Description

This file contains API routes related to ResourceCategory objects.

Moritz Strohm

Member Function Documentation

◆ addResourceCategory()

addResourceCategory ( )

Creates a resource category object.


◆ before()

before ( )

Validate access to each route.

◆ createResource()

createResource (   $category_id)

Creates a resource.


◆ deleteResourceCategory()

deleteResourceCategory (   $category_id)

Deletes a resource category.


◆ editResourceCategory()

editResourceCategory (   $category_id)

Modifies a resource category.


◆ getAllResourceCategories()

getAllResourceCategories ( )

Returns all defined resource categories.


◆ getResourceCategory()

getResourceCategory (   $category_id)

Get a resource category object.


◆ getResourceCategoryProperties()

getResourceCategoryProperties (   $category_id)

Get all resource category property objects for a resource category.


◆ getResourceCategoryResources()

getResourceCategoryResources (   $category_id)

Returns all resources which belong to the specified category. The result set can be limited by the parameters 'offset' and 'limit'. If the parameter 'with_full_name' is set to 1, the resources full name as provided by its responsible class, is added to the result set.


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