Stud.IP  5.4
StudyAreasWizardStep Class Reference
Inheritance diagram for StudyAreasWizardStep:
CourseWizardStep StudyAreasLVGroupsCombinedWizardStep

Public Member Functions

 getStepTemplate ($values, $stepnumber, $temp_id)
 
 alterValues ($values)
 
 validate ($values)
 
 storeValues ($course, $values)
 
 isRequired ($values)
 
 copy ($course, $values)
 
 getSemTreeLevel ($parentId)
 
 searchSemTree ($searchterm, $id_only=false)
 
 getAncestorTree ($id)
 

Protected Member Functions

 buildPartialSemTree ($node, $id_only=false)
 

Member Function Documentation

◆ alterValues()

alterValues (   $values)

Catch form submits other than "previous" and "next" and handle the given values. This is only important for no-JS situations.

Parameters
Array$valuescurrently set values for the wizard.
Returns
bool

Implements CourseWizardStep.

◆ buildPartialSemTree()

buildPartialSemTree (   $node,
  $id_only = false 
)
protected

◆ copy()

copy (   $course,
  $values 
)

Copy values for study areas wizard step from given course.

Parameters
Course$course
Array$values

Implements CourseWizardStep.

◆ getAncestorTree()

getAncestorTree (   $id)

◆ getSemTreeLevel()

getSemTreeLevel (   $parentId)

◆ getStepTemplate()

getStepTemplate (   $values,
  $stepnumber,
  $temp_id 
)

Returns the Flexi template for entering the necessary values for this step.

Parameters
Array$valuesPre-set values
int$stepnumberwhich number has the current step in the wizard?
String$temp_idtemporary ID for wizard workflow
Returns
String a Flexi template for getting needed data.

Implements CourseWizardStep.

◆ isRequired()

isRequired (   $values)

Checks if the current step needs to be executed according to already given values. A good example are study areas which are only needed for certain sem_classes.

Parameters
Array$valuesvalues specified from previous steps
Returns
bool Is the current step required for a new course?

Implements CourseWizardStep.

◆ searchSemTree()

searchSemTree (   $searchterm,
  $id_only = false 
)

◆ storeValues()

storeValues (   $course,
  $values 
)

Stores the given values to the given course.

Parameters
Course$coursethe course to store values for
Array$valuesvalues to set
Returns
Course The course object with updated values.

Implements CourseWizardStep.

◆ validate()

validate (   $values)

Validates if given values are sufficient for completing the current course wizard step and switch to another one. If not, all errors are collected and shown via PageLayout::postMessage.

Parameters
mixed$valuesArray of stored values
Returns
bool Everything ok?

Implements CourseWizardStep.


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