Resources_BookingController Class Reference

Inheritance diagram for Resources_BookingController:

Public Member Functions
	before_filter (&$action, &$args)
	index_action ($booking_id=null)
	add_from_request_action ($resource_id=null, $request_id=null)
	addEditHandler ($mode='edit')
	add_action ($resource_id=null, $booking_type=null)
	edit_action ($booking_id=null)
	duplicate_action ($booking_id=null)
	copy_action ($booking_id=null)
	move_action ($booking_id=null)
	copy_to_semester_action ($booking_id=null)
	delete_action ($booking_id=null)
	transform_action ($booking_id=null)
Public Member Functions inherited from AuthenticatedController
	before_filter (&$action, &$args)
Public Member Functions inherited from StudipController
	__construct (\Trails\Dispatcher $dispatcher)
	before_filter (&$action, &$args)
	injectResponse (Psr\Http\Message\ResponseInterface $response)
	perform ($unconsumed_path)
	after_filter ($action, $args)
	validate_args (&$args, $types=null)
	url_for ($to='')
	link_for ($to='')
	redirect ($to)
	relocate ($to)
	rescue ($exception)
	render_json ($data)
	render_csv ($data, $filename=null, $delimiter=';', $enclosure='"')
	render_file (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
	render_temporary_file (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
	render_form (\Studip\Forms\Form $form)
	render_vue_app (\Studip\VueApp $app)
	relay ($to_uri)
	relayWithRedirect (... $args)
	perform_relayed ($unconsumed)
	render_template ($template_name, $layout=null)
	render_template_as_string ($template, $layout=null)
	__call ($method, $arguments)
	has_action ($action)
	action_url ($action)
	action_link ($action)
	validate_datetime ($datetime, $format='H:i')
	render_spreadsheet (array $header, array $data, string $format, string $filename, ?string $filepath=null)
Public Member Functions inherited from Controller
	__construct (Dispatcher $dispatcher)
	erase_response ()
	get_response ()
	perform ($unconsumed)
	extract_action_and_args ($string)
	default_action_and_args ()
	map_action ($action)
	before_filter (&$action, &$args)
	after_filter ($action, $args)
	does_not_understand ($action, $args)
	redirect ($to)
	render_text ($text=' ')
	render_nothing ()
	render_action ($action)
	get_default_template ($action)
	render_template ($template_name, $layout=null)
	get_template_factory ()
	get_assigned_variables ()
	set_layout ($layout)
	url_for ($to)
	set_status ($status, $reason_phrase=null)
	set_content_type ($type)
	rescue ($exception)
	respond_to ($ext)

Protected Member Functions
	sendLockBookingMail (ResourceBooking $booking)
	assignResourceAndCollectResults ( $booking, Resource $resource, User $user, DateTime $begin, DateTime $end, DateTime $repetition_end, $preparation_time=0, $description='', $comment='', $booking_type=ResourceBooking::TYPE_NORMAL, $assigned_user=null, $repetition_interval=null, $notification_enabled=false, $included_room_parts=[], $overwrite_bookings=false, $weekdays='')
	displayAssignResultMessages ( $booking_type=ResourceBooking::TYPE_NORMAL, $booking_count=0, $errors=[], $room_part_errors=[])
Protected Member Functions inherited from AuthenticatedController
	keepRequest ()
Protected Member Functions inherited from StudipController
	render_pdf (TCPDF $pdf, $filename, $inline=false)
	controller_path ()
	getBodyElementIdForControllerAndAction ($unconsumed_path)

Additional Inherited Members
Protected Attributes inherited from AuthenticatedController
	$with_session = true
	$allow_nobody = false
Protected Attributes inherited from StudipController
	$with_session = false
	$allow_nobody = true
	$_autobind = false
Protected Attributes inherited from Controller
Dispatcher	$dispatcher
Response	$response
bool	$performed = false
Template string null	$layout = null

Detailed Description

Resources_BookingController contains functionality for resource bookings.

Member Function Documentation

add_action()

add_action	(		$resource_id = null,
			$booking_type = null
	)

add_from_request_action()

add_from_request_action	(		$resource_id = null,
			$request_id = null
	)

This action handles the creation of an booking by specifying a resource and a resource request.

addEditHandler()

addEditHandler

(

$mode = 'edit'

)

This action handles assigning, reserving and locking a resource without having to create a resource request before (direct booking).

assignResourceAndCollectResults()

assignResourceAndCollectResults (   $booking, Resource  $resource, User  $user, DateTime  $begin, DateTime  $end, DateTime  $repetition_end,   $preparation_time = 0,   $description = '',   $comment = '',   $booking_type = ResourceBooking::TYPE_NORMAL,   $assigned_user = null,   $repetition_interval = null,   $notification_enabled = false,   $included_room_parts = [],   $overwrite_bookings = false,   $weekdays = ''  )

protected

An internal helper method for assigning resources and collecting the results.

Parameters

ResourceBooking | null

$booking

Either a ResourceBooking object or null. If a ResourceBooking object is specified its content will be updated. Otherwise a new object will be created.

Returns

array An associative array with the following structure: [ 'errors' => Error messages related to booking the resource. 'room_part_errors' => Error messages related to the booking of other resource parts. 'bookings' => The created bookings. ]

before_filter()

before_filter	(	&	$action,
		&	$args
	)

copy_action()

copy_action

(

$booking_id = null

)

This action can copy a booking to another resource of the same resource class.

copy_to_semester_action()

copy_to_semester_action

(

$booking_id = null

)

This action can copy an booking in another semester.

delete_action()

delete_action

(

$booking_id = null

)

This action is responsible for deleting a resource booking.

displayAssignResultMessages()

displayAssignResultMessages (   $booking_type = ResourceBooking::TYPE_NORMAL,   $booking_count = 0,   $errors = [],   $room_part_errors = []  )

protected

duplicate_action()

duplicate_action

(

$booking_id = null

)

edit_action()

edit_action

(

$booking_id = null

)

index_action()

index_action

(

$booking_id = null

)

move_action()

move_action

(

$booking_id = null

)

This action can move a booking to another resource of the same resource class.

sendLockBookingMail()

sendLockBookingMail ( ResourceBooking  $booking )

protected

transform_action()

transform_action

(

$booking_id = null

)

Transforms a reservation to a booking and vice versa.

---

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

• app/controllers/resources/booking.php