Stud.IP  6.0
Course_WizardController Class Reference
Inheritance diagram for Course_WizardController:
AuthenticatedController StudipController Controller

Public Member Functions

 before_filter (&$action, &$args)
 
 index_action ()
 
 step_action ($number=0, $temp_id='')
 
 process_action ($step_number, $temp_id)
 
 summary_action ($stepnumber, $temp_id)
 
 ajax_action ()
 
 forward_action ($step_number, $temp_id)
 
 copy_action ($id)
 
- Public Member Functions inherited from AuthenticatedController
 before_filter (&$action, &$args)
 
- Public Member Functions inherited from StudipController
 __construct (\Trails\Dispatcher $dispatcher)
 
 before_filter (&$action, &$args)
 
 injectResponse (Psr\Http\Message\ResponseInterface $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 (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
 
 render_temporary_file (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
 
 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)
 

Data Fields

array $steps = []
 

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

Member Function Documentation

◆ ajax_action()

ajax_action ( )

Wrapper for ajax calls to step classes. Three things must be given via Request:

  • step number
  • method to call in target step
  • parameters for the target method (will be passed in given order)

◆ before_filter()

before_filter ( $action,
$args 
)

◆ copy_action()

copy_action (   $id)

Copy an existing course.

◆ forward_action()

forward_action (   $step_number,
  $temp_id 
)

◆ index_action()

index_action ( )

Just some sort of placeholder for initial calling without a step number.

◆ process_action()

process_action (   $step_number,
  $temp_id 
)

Processes a finished wizard step by saving the gathered values to session.

Parameters
int$step_numberthe step we are at.
String$temp_idtemporary ID for the course to create

◆ step_action()

step_action (   $number = 0,
  $temp_id = '' 
)

Fetches the wizard step with the given number and gets the corresponding template.

Parameters
int$numberstep number to show
String$temp_idtemporary ID for the course to create

◆ summary_action()

summary_action (   $stepnumber,
  $temp_id 
)

We are after last step: all set and ready to create a new course.

Field Documentation

◆ $steps

array $steps = []

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