Inheritance diagram for LVGroupsWizardStep:

Public Member Functions
	getStepTemplate ($values, $stepnumber, $temp_id)

	get_selection ($course_id)

	getLVGroupTreeLevel ($parentId, $parentClass)

	searchLVGroupTree ($searchterm)

	getLVGroupDetails ($id)

	getAncestorTree ($id)

	alterValues ($values)

	validate ($values)

	storeValues ($course, $values)

	isRequired ($values)

	is_locked ($values)

	copy ($course, $values)

Static Public Member Functions
static	isCourseId ($id)

Member Function Documentation

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.

copy	(	$course,
		$values
	)

Copy values for study areas wizard step from given course.

Parameters

Course	$course
Array	$values

Implements CourseWizardStep.

get_selection ( $course_id )

Returns a LvGruppen-Selection object for a given course ID.

Parameters

string either the MD5ish ID of a course or something falsy to indicate a course that is currently being created

Returns: mixed LvGruppen-Selection object representing the selection form

getAncestorTree ( $id )

getLVGroupDetails ( $id )

getLVGroupTreeLevel	(	$parentId,
		$parentClass
	)

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.

is_locked ( $values )

static isCourseId ( $id )

static

Every (non-empty) string is a valid course ID except the string '-'

Parameters

mixed the value to check

Returns: bool TRUE if it is courseID-ish, FALSE otherwise

isRequired ( $values )

Checks if the current step needs to be executed according to already given values.

Parameters

Array $values values specified from previous steps

Returns: bool Is the current step required for a new course?

Implements CourseWizardStep.

searchLVGroupTree ( $searchterm )

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.

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.

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

lib/classes/coursewizardsteps/LVGroupsWizardStep.php

Public Member Functions

Static Public Member Functions

Member Function Documentation