Stud.IP  5.4
Settings_CategoriesController Class Reference
Inheritance diagram for Settings_CategoriesController:
Settings_SettingsController AuthenticatedController StudipController

Public Member Functions

 before_filter (&$action, &$args)
 
 index_action ($verify_action=null, $verify_id=null)
 
 create_action ()
 
 delete_action ($id, $verified=false)
 
 store_action ()
 
 swap_action ($id0, $id1)
 
 verify_action ($action, $id=null)
 
- Public Member Functions inherited from Settings_SettingsController
 before_filter (&$action, &$args)
 
 url_for ($to='')
 
 get_default_template ($action)
 
 render_nothing ($text='')
 
 shallChange ($field, $attribute=null, $value=null)
 
 after_filter ($action, $args)
 
- 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 Settings_SettingsController
 check_ticket ()
 
 postPrivateMessage ($message)
 
- 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 Settings_SettingsController
 $private_messages = []
 
- 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 
)

Set up this controller. Rewrites $action on verification.

Parameters
String$actionName of the action to be invoked
Array$argsArguments to be passed to the action method

◆ create_action()

create_action ( )

Creates a new category

◆ delete_action()

delete_action (   $id,
  $verified = false 
)

Deletes a given category.

Parameters
String$idId of the category to be deleted
bool$verifiedIndicates whether the delete action has been verfified

◆ index_action()

index_action (   $verify_action = null,
  $verify_id = null 
)

Display the categories of a user.

Parameters
mixed$verify_actionOptional name of an action to be verified
mixed$verify_idOptional id that belongs to the action to be verified

◆ store_action()

store_action ( )

Stores all categories

◆ swap_action()

swap_action (   $id0,
  $id1 
)

Swaps the position of two categories

Parameters
String$id0Id of the category to be swapped
String$id1Id of the other category to be swapped

◆ verify_action()

verify_action (   $action,
  $id = null 
)

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