Resources Class Reference

Inheritance diagram for Resources:

Collaboration diagram for Resources:

Public Member Functions
	getResource ($resource_id=null)
	editResource ($resource_id=null)
	deleteResource ($resource_id=null)
	getResourceChildren ($resource_id=null)
	getResourceParent ($resource_id=null)
	getResourceProperties ($resource_id=null)
	getResourceBookingPlan ($resource_id=null)
	getResourceSemesterBookingPlan ($resource_id=null)
	getResourceRequests ($resource_id=null)
	getResourceBookings ($resource_id=null)
	createResourceBooking ($resource_id=null)
	createSimpleResourceRequest ($resource_id=null)
	toggleResourceBookingIntervalTakesPlaceField ($interval_id=null)
Public Member Functions inherited from RouteMap
	__construct ()
	init ($router, $route)
	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)
	getRoutes ($http_method=null)

Additional Inherited Members
Protected Member Functions inherited from RouteMap
	extractConditions ($docblock, $conditions=array())
Protected Attributes inherited from RouteMap
	$pagination = false
	$offset
	$limit

Detailed Description

This class provides API routes for the room and resource management.

Member Function Documentation

createResourceBooking()

createResourceBooking

(

$resource_id = null

)

Creates a booking/reservation/lock for a resource.

Parameters

begin	The begin timestamp for the booking.
end	The end timestamp for the booking.
preparation_time	The amount of seconds for preparation time before the begin timestamp.
internal_comment	A comment that is only visible for some parts of the staff.
booking_type	The booking type: 0 = normal booking 1 = reservation 2 = lock

Postcondition

/resources/resource/:resource_id/assign

createSimpleResourceRequest()

createSimpleResourceRequest

(

$resource_id = null

)

Creates a resource request.

Postcondition

/resources/resource/:resource_id/request_simple

deleteResource()

deleteResource

(

$resource_id = null

)

Deletes a resource object.

@delete /resources/resource/:resource_id

editResource()

editResource

(

$resource_id = null

)

Modifies a resource object.

@put /resources/resource/:resource_id

Here is the call graph for this function:

getResource()

getResource

(

$resource_id = null

)

Get a resource object.

Parameters

derived_class

If the URL parameter derived_class is set the resource object is converted to an instance of the class that does correct handling of the resource object.

@get /resources/resource/:resource_id

Here is the call graph for this function:

getResourceBookingPlan()

getResourceBookingPlan

(

$resource_id = null

)

Returns the booking plan of a resource for a selected week. If the 'begin' and 'end' parameter is not set the current week is selected.

Parameters

begin	The begin timestamp of the time range for the booking plan.
end	The end timestamp of the time range for the booking plan.

@allow_nobody

@get /resources/resource/:resource_id/booking_plan

getResourceBookings()

getResourceBookings

(

$resource_id = null

)

Parameters

begin	A timestamp specifying the begin of the time range.
end	A timestamp specifying the end of the time range.
user_id	This parameter limits the result set to bookings of the user specified by the user-ID provided in this parameter.
types	Limits the result to booking types specified in this parameter. The allowed types are comma separated like this: "1,2,3". The defined types are: 0 = normal booking, 1 = reservation, 2 = lock.

@get /resources/resource/:resource_id/bookings

getResourceChildren()

getResourceChildren

(

$resource_id = null

)

Returns the child resources of a resource object, if they exist.

@get /resources/resource/:resource_id/children

getResourceParent()

getResourceParent

(

$resource_id = null

)

Returns the parent resource of a resource object, if it exists.

getResourceProperties()

getResourceProperties

(

$resource_id = null

)

Get all property objects of a resource.

@get /resources/resource/:resource_id/properties

getResourceRequests()

getResourceRequests

(

$resource_id = null

)

Gets request of a resource. At your option the requests can be limited to a specific time range, specified by the parameters begin and end. Furthermore the requests can be filtered by user-ID.

Parameters

begin	A timestamp specifying the begin of the time range.
end	A timestamp specifying the end of the time range.
user_id	This parameter limits the result set to requests of the user specified by the user-ID provided in this parameter.

@get /resources/resource/:resource_id/requests

getResourceSemesterBookingPlan()

getResourceSemesterBookingPlan

(

$resource_id = null

)

Returns the booking plan of a resource for a selected semester.

Parameters

semester_id

The ID of the semester. Defaults to the current semester, if not set.

@get /resources/resource/:resource_id/semester_plan

toggleResourceBookingIntervalTakesPlaceField()

toggleResourceBookingIntervalTakesPlaceField

(

$interval_id = null

)

Change the status of a resource booking interval:

Postcondition

/resources/booking_interval/:interval_id/toggle_takes_place

---

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

• app/routes/Resources.php