Course_TimesroomsController Class Reference

Inheritance diagram for Course_TimesroomsController:

Public Member Functions
	before_filter (&$action, &$args)
	index_action ()
	editSemester_action ()
	editDate_action ($termin_id)
	saveDate_action ($termin_id)
	createSingleDate_action ()
	saveSingleDate_action ()
	undeleteSingle_action ($termin_id, $from_dates=false)
	stack_action ($cycle_id='')
	saveStack_action ($cycle_id='')
	saveRequestStack ()
	createCycle_action ($cycle_id=null)
	saveCycle_action ()
	editCycle_action ($cycle_id)
	deleteCycle_action ($cycle_id)
	cancel_action ($termin_id)
	saveComment_action ($termin_id)
	getNewEndOffset ($cycle, $old_start_weeks, $new_start_weeks)
	redirect ($to)
	relocate ($to)
Public Member Functions inherited from AuthenticatedController
	before_filter (&$action, &$args)
Public Member Functions inherited from StudipController
	before_filter (&$action, &$args)
	erase_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 ( $file, $filename=null, $content_type=null, $content_disposition='attachment', Closure $callback=null, $chunk_size=262144)
	render_temporary_file ( $file, $filename=null, $content_type=null, $content_disposition='attachment', Closure $callback=null, $chunk_size=262144)
	render_form (\Studip\Forms\Form $form)
	relay ($to_uri)
	relayWithRedirect (... $args)
	perform_relayed ($unconsumed)
	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)

Protected Member Functions
	bookingTooShort (int $start_time, int $end_time)
	getSameFieldValue (array $dates, Closure $callback)
	requestStack ($cycle_id)
	setAvailableRooms ($dates, $date_booking_ids=[], $only_bookable_rooms=false)
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

Detailed Description

Author

David Siegfried david.nosp@m..sie.nosp@m.gfrie.nosp@m.d@un.nosp@m.i-vec.nosp@m.hta..nosp@m.de GPL2 or any later version

Since

3.4

Member Function Documentation

before_filter()

before_filter	(	&	$action,
		&	$args
	)

Common actions before any other action

Parameters

String	$action	Action to be executed
Array	$args	Arguments passed to the action

Exceptions

Trails_Exception

when either no course was found or the user may not access this area

bookingTooShort()

bookingTooShort ( int  $start_time, int  $end_time  )

protected

cancel_action()

cancel_action

(

$termin_id

)

Add information to canceled / holiday date

Parameters

String

$termin_id

Id of the date

createCycle_action()

createCycle_action

(

$cycle_id = null

)

Creates a cycle.

Parameters

String

$cycle_id

Id of the cycle to be created (optional)

createSingleDate_action()

createSingleDate_action

(

)

Create Single Date

deleteCycle_action()

deleteCycle_action

(

$cycle_id

)

Deletes a cycle

Parameters

String

$cycle_id

Id of the cycle to be deleted

editCycle_action()

editCycle_action

(

$cycle_id

)

Edits a cycle

Parameters

String

$cycle_id

Id of the cycle to be edited

editDate_action()

editDate_action

(

$termin_id

)

Primary function to edit date-informations

Parameters

string

$termin_id

editSemester_action()

editSemester_action

(

)

Edit the start-semester of a course

Exceptions

Trails_DoubleRenderError

getNewEndOffset()

getNewEndOffset	(		$cycle,
			$old_start_weeks,
			$new_start_weeks
	)

Calculates new end_offset value for given SeminarCycleDate Object

Parameters

object	of SeminarCycleDate
array
array

Returns

int

getSameFieldValue()

getSameFieldValue ( array  $dates, Closure  $callback  )

protected

Checks a specific field value of the specified course dates for equality. A closure defines which field of the course dates to check.

Parameters

	CourseDate[]	$dates The dates from which to extract values.
Closure	$callback	The closure that extracts values from a CourseDate object that is passed to it.

Returns

mixed The identical value that has been retrieved from all course dates or a value that is equal to false in case the value differs. The returned result might be a string or an array or it may be empty.

index_action()

index_action

(

)

Displays the times and rooms of a course

Parameters

mixed

$course_id

Id of the course (optional, defaults to globally selected)

redirect()

redirect

(

$to

)

Redirects to another location.

Parameters

String

$to

New location

relocate()

relocate

(

$to

)

Relocates to another location if not from dialog

Parameters

String

$to

New location

requestStack()

requestStack (   $cycle_id )

protected

Creates a new room request for the selected dates.

saveComment_action()

saveComment_action

(

$termin_id

)

Saves a comment for a given date.

Parameters

String

$termin_id

Id of the date

saveCycle_action()

saveCycle_action

(

)

Saves a cycle

saveDate_action()

saveDate_action

(

$termin_id

)

Save date-information

Parameters

$termin_id

Exceptions

Trails_DoubleRenderError

saveRequestStack()

saveRequestStack

(

)

The data saving part of the action to create one request for multiple appointments.

saveSingleDate_action()

saveSingleDate_action

(

)

Save Single Date

Exceptions

Trails_DoubleRenderError

saveStack_action()

saveStack_action

(

$cycle_id = ''

)

Saves a stack/cycle.

Parameters

String

$cycle_id

Id of the cycle to be saved.

setAvailableRooms()

setAvailableRooms (   $dates,   $date_booking_ids = [],   $only_bookable_rooms = false  )

protected

stack_action()

stack_action

(

$cycle_id = ''

)

Performs a stack action defined by url parameter method.

Parameters

String

$cycle_id

Id of the cycle the action should be performed upon

undeleteSingle_action()

undeleteSingle_action	(		$termin_id,
			$from_dates = false
	)

Restores a previously removed date.

Parameters

String

$termin_id

Id of the previously removed date

---

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

• app/controllers/course/timesrooms.php