Admin_ExternController Class Reference

Inheritance diagram for Admin_ExternController:

Public Member Functions
	before_filter (&$action, &$args)
	index_action ()
	new_action ()
	edit_action (string $type_id, string $config_id='')
	store_action (string $type_id, string $config_id='')
	delete_action (string $config_id)
	info_action (string $config_id)
	download_action (string $config_id)
	upload_action ()
	import_action ()
	search_studyareas_action (string $search_term='')
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
	init ()
	load (string $type_id, string $config_id='')
	checkPerm ()
	setSidebar ()
	fetchPlugins (bool $is_system)
	getSystemWideConfigTypes ()
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
	$range
	$template_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

before_filter()

before_filter	(	&	$action,
		&	$args
	)

See also

PluginController::before_filter()

checkPerm()

checkPerm ( )

protected

Checks for sufficient rights.

Exceptions

AccessDeniedException

delete_action()

delete_action

(

string

$config_id

)

Deletes a configuration.

Parameters

string

$config_id

The id of the configuration to delete.

Exceptions

AccessDeniedException
InvalidSecurityTokenException
MethodNotAllowedException

download_action()

download_action

(

string

$config_id

)

Action to download given configuration.

Parameters

$config_id

edit_action()

edit_action	(	string	$type_id,
		string	$config_id = ''
	)

Create a new configuration or edit an existing one.

Parameters

string	$type_id	The type of the configuration.
string	$config_id	The id of the configuration.

Exceptions

AccessDeniedException
InvalidSecurityTokenException
MethodNotAllowedException

fetchPlugins()

fetchPlugins ( bool  $is_system )

protected

Retrofits navigation with plugins.

Parameters

bool

$is_system

True to fetch system-wide external page plugins.

Returns

void

getSystemWideConfigTypes()

getSystemWideConfigTypes ( )

protected

Sets data for system-wide external pages.

Returns

void

import_action()

import_action

(

)

Action to import a configuration as json file.

Returns

void

Exceptions

InvalidSecurityTokenException
MethodNotAllowedException

index_action()

index_action

(

)

Action to show index page.

info_action()

info_action

(

string

$config_id

)

Show dialog with information about the given configuration.

Parameters

$config_id

init()

init ( )

protected

Initialize the controller.

load()

load ( string  $type_id, string  $config_id = ''  )

protected

Loads the configuration to edit or store.

Parameters

string	$type_id	The type of the external page.
string	$config_id	The id of the external page.

Exceptions

AccessDeniedException

new_action()

new_action

(

)

Shows dialog to select a new page configuration

search_studyareas_action()

search_studyareas_action

(

string

$search_term = ''

)

Action to get study areas by search term.

Parameters

string

$search_term

The search term.

Returns

void

setSidebar()

setSidebar ( )

protected

Creates the sidebar menu.

store_action()

store_action	(	string	$type_id,
		string	$config_id = ''
	)

Action to store an external page with configuration.

Parameters

string	$type_id	The type of the external page.
string	$config_id	The id of the configuration.

Exceptions

AccessDeniedException
InvalidSecurityTokenException
MethodNotAllowedException

upload_action()

upload_action

(

)

Action to create a new configuration from uploaded file.

Field Documentation

$range

$range

protected

$template_path

$template_path

protected

---

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

• app/controllers/admin/extern.php