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 | |
| $router | |
| $route | |
| $data = null | |
| $response | |
| $pagination = false | |
| $offset | |
| $limit | |
Detailed Description
This file contains API routes related to ResourceCategory objects.
- Copyright
- 2017-2019 http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
- Since
- 4.5
Member Function Documentation
◆ addResourceCategory()
| addResourceCategory | ( | ) |
Creates a resource category object.
- Postcondition
- /resources/new_category
◆ before()
| before | ( | ) |
Validate access to each route.
◆ createResource()
| createResource | ( | $category_id | ) |
Creates a resource.
- Postcondition
- /resources/category/:category_id/create_resource
◆ deleteResourceCategory()
| deleteResourceCategory | ( | $category_id | ) |
Deletes a resource category.
/resources/category/:category_id
◆ editResourceCategory()
| editResourceCategory | ( | $category_id | ) |
Modifies a resource category.
/resources/category/:category_id
◆ getAllResourceCategories()
| getAllResourceCategories | ( | ) |
Returns all defined resource categories.
/resources/categories
◆ getResourceCategory()
| getResourceCategory | ( | $category_id | ) |
Get a resource category object.
/resources/category/:category_id
◆ getResourceCategoryProperties()
| getResourceCategoryProperties | ( | $category_id | ) |
Get all resource category property objects for a resource category.
/resources/category/:category_id/properties
◆ 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.
/resources/category/:category_id/resources
The documentation for this class was generated from the following file:
- app/routes/ResourceCategories.php
