TourController Class Reference

Inheritance diagram for TourController:

Public Member Functions
	before_filter (&$action, &$args)
	get_data_action ($tour_id, $step_nr=1)
	set_status_action ($tour_id, $step_nr, $status)
	admin_overview_action ()
	import_action ()
	export_action ($tour_id)
	delete_step_action ($tour_id, $step_nr)
	edit_step_action ($tour_id, $step_nr, $mode= 'edit')
	admin_conflicts_action ()
	resolve_conflict_action ($id, $mode)
	admin_details_action ($tour_id= '')
	save_action ($tour_id= '')
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)
	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')

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

admin_conflicts_action

(

)

Administration page for tour conflicts

Exceptions

AccessDeniedException

admin_details_action

(

$tour_id = ''

)

Administration page for single tour

Parameters

String

$tour_id

tour id

Exceptions

AccessDeniedException

admin_overview_action

(

)

Administration page for tours

Exceptions

AccessDeniedException

before_filter	(	&	$action,
		&	$args
	)

Callback function being called before an action is executed.

delete_step_action	(		$tour_id,
			$step_nr
	)

delete tour step (ajax call)

Parameters

String	$tour_id	tour id
String	$step_nr	number of step

edit_step_action	(		$tour_id,
			$step_nr,
			$mode = 'edit'
	)

edit tour step

Parameters

String	$tour_id	tour id
String	$step_nr	number of step
String	$mode	indicates edit mode (new, edit or save*)

Exceptions

AccessDeniedException

export_action

(

$tour_id

)

export help tour

Parameters

String

$id

id of help tour

get_data_action	(		$tour_id,
			$step_nr = 1
	)

sends tour object as json data

Parameters

string	$tour_id	id of tour object
String	$step_nr	number of step to start with

import_action

(

)

import help tour

resolve_conflict_action	(		$id,
			$mode
	)

resolves tour conflict

Parameters

String

$id

tour id

Exceptions

AccessDeniedException

save_action

(

$tour_id = ''

)

save tour data

Parameters

String

$tour_id

tour id

Exceptions

AccessDeniedException

set_status_action	(		$tour_id,
			$step_nr,
			$status
	)

sets session data for active tour

Parameters

String	$tour_id	tour id
String	$step_nr	number of current step
String	$status	status of tour ('off' to end tour)

---

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

• app/controllers/tour.php