StudyAreasWizardStep Class Reference

Inheritance diagram for StudyAreasWizardStep:

Collaboration diagram for StudyAreasWizardStep:

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

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

$values

currently set values for the wizard.

Returns

bool

Implements CourseWizardStep.

Here is the call graph for this function:

copy()

copy	(		$course,
			$values
	)

Copy values for study areas wizard step from given course.

Parameters

Course	$course
Array	$values

Implements CourseWizardStep.

getAncestorTree()

getAncestorTree

(

$id

)

Here is the call graph for this function:

getSemTreeLevel()

getSemTreeLevel

(

$parentId

)

Here is the call graph for this function:

getStepTemplate()

getStepTemplate	(		$values,
			$stepnumber,
			$temp_id
	)

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

Parameters

Array	$values	Pre-set values
int	$stepnumber	which number has the current step in the wizard?
String	$temp_id	temporary ID for wizard workflow

Returns

String a Flexi template for getting needed data.

Implements CourseWizardStep.

Here is the call graph for this function:

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

$values

values specified from previous steps

Returns

bool Is the current step required for a new course?

Implements CourseWizardStep.

Here is the call graph for this function:

searchSemTree()

searchSemTree	(		$searchterm,
			$utf = true,
			$id_only = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

storeValues()

storeValues	(		$course,
			$values
	)

Stores the given values to the given course.

Parameters

Course	$course	the course to store values for
Array	$values	values to set

Returns

Course The course object with updated values.

Implements CourseWizardStep.

Here is the call graph for this function:

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

$values

Array of stored values

Returns

bool Everything ok?

Implements CourseWizardStep.

Here is the call graph for this function:

---

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

• lib/classes/coursewizardsteps/StudyAreasWizardStep.php