Stud.IP  6.0
Admin_ExternController Class Reference
Inheritance diagram for Admin_ExternController:
AuthenticatedController StudipController Controller Institute_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)
 
 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

 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
 
- Protected Attributes inherited from Controller
Dispatcher $dispatcher
 
Response $response
 
bool $performed = false
 
Template string null $layout = null
 

Member Function Documentation

◆ before_filter()

before_filter ( $action,
$args 
)

◆ checkPerm()

checkPerm ( )
protected

Checks for sufficient rights.

Exceptions
AccessDeniedException

◆ delete_action()

delete_action ( string  $config_id)

Deletes a configuration.

Parameters
string$config_idThe 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_idThe type of the configuration.
string$config_idThe id of the configuration.
Exceptions
AccessDeniedException
InvalidSecurityTokenException
MethodNotAllowedException

◆ fetchPlugins()

fetchPlugins ( bool  $is_system)
protected

Retrofits navigation with plugins.

Parameters
bool$is_systemTrue 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_idThe type of the external page.
string$config_idThe 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_termThe 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_idThe type of the external page.
string$config_idThe 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: