Calendar_ScheduleController Class Reference

Inheritance diagram for Calendar_ScheduleController:

Public Member Functions
	before_filter (&$action, &$args)
	index_action ($days=false)
	new_entry_action ()
	addEntry_action ($id=null)
	entry_action ($id=null, $cycle_id=null)
	entryajax_action ($id, $cycle_id=null)
	groupedentry_action ($start, $end, $seminars, $day)
	delete_action ($id)
	editseminar_action ($seminar_id, $cycle_id)
	addvirtual_action ($seminar_id)
	adminbind_action ($seminar_id, $cycle_id, $visible, $ajax=null)
	unbind_action ($seminar_id, $cycle_id=null, $ajax=null)
	bind_action ($seminar_id, $cycle_id, $ajax=null)
	settings_action ()
	storesettings_action ($start_hour=false, $end_hour=false, $days=false, $semester_id=false)
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)

Additional Inherited Members
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)
Protected Attributes inherited from AuthenticatedController
	$with_session = true
	$allow_nobody = false
Protected Attributes inherited from StudipController
	$with_session = false
	$allow_nobody = true
	$_autobind = false

Member Function Documentation

addEntry_action()

addEntry_action

(

$id = null

)

this action is called whenever a new entry shall be modified or added to the schedule

Parameters

string

$id

optional, if id given, the entry with this id is updated

addvirtual_action()

addvirtual_action

(

$seminar_id

)

Adds the appointments of a course to your schedule.

Parameters

string

$seminar_id

the ID of the course

Returns

void

adminbind_action()

adminbind_action	(		$seminar_id,
			$cycle_id,
			$visible,
			$ajax = null
	)

Set the visibility of the course.

Parameters

string	$seminar_id	the ID of the course
string	$cycle_id	the ID of the cycle
string	$visible	visibility; either '1' or '0'
string	$ajax	if you give this optional param, it signals an Ajax request

Returns

void

before_filter()

before_filter	(	&	$action,
		&	$args
	)

Callback function being called before an action is executed. If this function does not return FALSE, the action will be called, otherwise an error will be generated and processing will be aborted. If this function already #rendered or #redirected, further processing of the action is withheld.

Parameters

string	Name of the action to perform.
array	An array of arguments to the action.

bind_action()

bind_action	(		$seminar_id,
			$cycle_id,
			$ajax = null
	)

Show the given appointment.

Parameters

string	$seminar_id	the ID of the course
string	$cycle_id	the ID of the cycle
string	$ajax	if you give this optional param, it signals an Ajax request

Returns

void

delete_action()

delete_action

(

$id

)

delete the entry of the submitted id (only entry belonging to the current use can be deleted)

Parameters

string

$id

the id of the entry to delete

Returns

void

editseminar_action()

editseminar_action	(		$seminar_id,
			$cycle_id
	)

store the color-settings for the seminar

Parameters

string	$seminar_id
string	$cycle_id

Returns

void

entry_action()

entry_action	(		$id = null,
			$cycle_id = null
	)

this action keeps the entry of the submitted_id and enables displaying of the entry-dialog. If no id is submitted, an empty entry_dialog is displayed.

Parameters

string	$id	the id of the entry to edit (if any), false otherwise.
string	$cycle_id	an optional cycle's ID

entryajax_action()

entryajax_action	(		$id,
			$cycle_id = null
	)

Return an HTML fragment containing a form to edit an entry

Parameters

string	the ID of a course
string	an optional cycle's ID

Returns

void

groupedentry_action()

groupedentry_action	(		$start,
			$end,
			$seminars,
			$day
	)

Returns an HTML fragment of a grouped entry in the schedule of an institute.

Parameters

string	$start	the start time of the group, e.g. "1000"
string	$end	the end time of the group, e.g. "1200"
string	$seminars	the IDs of the courses
string	$day	numeric day to show

Returns

void

index_action()

index_action

(

$days = false

)

this action is the main action of the schedule-controller, setting the environment for the timetable, accepting a comma-separated list of days.

Parameters

string

$days

a list of an arbitrary mix of the numbers 0-6, separated with a comma (e.g. 1,2,3,4,5 (for Monday to Friday, the default))

new_entry_action()

new_entry_action

(

)

settings_action()

settings_action

(

)

Show the settings' form.

Returns

void

storesettings_action()

storesettings_action	(		$start_hour = false,
			$end_hour = false,
			$days = false,
			$semester_id = false
	)

Store the settings

Parameters

string	the start time of the calendar to show, e.g. "1000"
string	the end time of the calendar to show, e.g. "1200"
string	the days to show
string	the ID of the semester

Returns

void

unbind_action()

unbind_action	(		$seminar_id,
			$cycle_id = null,
			$ajax = null
	)

Hide the give appointment.

Parameters

string	$seminar_id	the ID of the course
string	$cycle_id	the ID of the cycle
string	$ajax	if you give this optional param, it signals an Ajax request

Returns

void

---

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

• app/controllers/calendar/schedule.php