Docs For Class Question

static void display_type_menu(
)

Displays the menu of question types

[ Top ]

static an getInstance(
integer
$type)

Returns an instance of the class corresponding to the type

Tags:

return:

instance of a Question subclass (or of Questionc class by default)

Parameters:

integer

$type

the type of the question

[ Top ]

static - read(
-
$id)

reads question informations from the data base

Tags:

return:	boolean - true if question exists, otherwise false
author:	- Olivier Brouckaert

Parameters:

-

$id

integer $id - question ID

[ Top ]

Question Question(
)

constructor of the class

Tags:

author:

- Olivier Brouckaert

[ Top ]

void addToList(
-
$exerciseId)

adds an exercise into the exercise list

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$exerciseId

integer $exerciseId - exercise ID

[ Top ]

void createAnswersForm(
the
$form)

abstract function which creates the form to create / edit the answers of the question

Tags:

abstract:

Overridden in child classes as:

Matching::createAnswersForm(): function which redifines Question::createAnswersForm

FreeAnswer::createAnswersForm(): function which redifines Question::createAnswersForm

UniqueAnswer::createAnswersForm(): function which redifines Question::createAnswersForm

HotSpot::createAnswersForm()

FillBlanks::createAnswersForm(): function which redifines Question::createAnswersForm

MultipleAnswer::createAnswersForm(): function which redifines Question::createAnswersForm

Parameters:

the

$form

formvalidator instance

[ Top ]

void createForm(

&$form, FormValidator
$form)

Creates the form to create / edit a question A subclass can redifine this function to add fields...

Overridden in child classes as:

HotSpot::createForm()

Parameters:

FormValidator	$form	the formvalidator instance (by reference)
	&$form

[ Top ]

void delete(
[-
$deleteFromEx = 0])

deletes a question from the database the parameter tells if the question is removed from all exercises (value = 0), or just from one exercise (value = exercise ID)

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$deleteFromEx

integer $deleteFromEx - exercise ID if the question is only removed from one exercise

[ Top ]

- duplicate(
)

duplicates the question

Tags:

return:	integer - ID of the new question
author:	- Olivier Brouckaert

[ Top ]

- exportPicture(
-
$questionId)

exports a picture to another question

Tags:

return:	boolean - true if copied, otherwise false
author:	- Olivier Brouckaert

Parameters:

-

$questionId

integer $questionId - ID of the target question

[ Top ]

- getTmpPicture(
)

moves the temporary question "tmp" to "quiz-$questionId" Temporary pictures are used when we don't want to save a picture right after a form submission.

For example, if we first show a confirmation box.

Tags:

return:	boolean - true if moved, otherwise false
author:	- Olivier Brouckaert

[ Top ]

void processAnswersCreation(
the
$form)

abstract function which process the creation of answers

Tags:

abstract:

Overridden in child classes as:

Matching::processAnswersCreation(): abstract function which creates the form to create / edit the answers of the question

FreeAnswer::processAnswersCreation(): abstract function which creates the form to create / edit the answers of the question

UniqueAnswer::processAnswersCreation(): abstract function which creates the form to create / edit the answers of the question

HotSpot::processAnswersCreation()

FillBlanks::processAnswersCreation(): abstract function which creates the form to create / edit the answers of the question

MultipleAnswer::processAnswersCreation(): abstract function which creates the form to create / edit the answers of the question

Parameters:

the

$form

formvalidator instance

[ Top ]

void processCreation(
FormValidator
$form, Exercise
$objExercise)

function which process the creation of questions

Overridden in child classes as:

HotSpot::processCreation()

Parameters:

FormValidator	$form	the formvalidator instance
Exercise	$objExercise	the Exercise instance

[ Top ]

- removeFromList(
-
$exerciseId)

removes an exercise from the exercise list

Tags:

return:	boolean - true if removed, otherwise false
author:	- Olivier Brouckaert

Parameters:

-

$exerciseId

integer $exerciseId - exercise ID

[ Top ]

- removePicture(
)

deletes the picture

Tags:

return:	boolean - true if removed, otherwise false
author:	- Olivier Brouckaert

[ Top ]

- resizePicture(
-
$Dimension, -
$Max)

Resizes a picture || Warning!: can only be called after uploadPicture, or if picture is already available in object.

Tags:

return:	boolean - true if success, false if failed
author:	- Toon Keppens

Parameters:

-	$Dimension	string $Dimension - Resizing happens proportional according to given dimension: height\|width\|any
-	$Max	integer $Max - Maximum size

[ Top ]

void save(
[-
$exerciseId = 0])

updates the question in the data base if an exercise ID is provided, we add that exercise ID into the exercise list

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$exerciseId

integer $exerciseId - exercise ID if saving in an exercise

[ Top ]

- selectDescription(
)

returns the question description

Tags:

return:	string - question description
author:	- Olivier Brouckaert

[ Top ]

- selectExerciseList(
)

returns the array with the exercise ID list

Tags:

return:	array - list of exercise ID which the question is in
author:	- Olivier Brouckaert

[ Top ]

- selectId(
)

returns the question ID

Tags:

return:	integer - question ID
author:	- Olivier Brouckaert

[ Top ]

- selectNbrExercises(
)

returns the number of exercises which this question is in

Tags:

return:	integer - number of exercises
author:	- Olivier Brouckaert

[ Top ]

- selectPicture(
)

returns the picture name

Tags:

return:	string - picture name
author:	- Olivier Brouckaert

[ Top ]

- selectPosition(
)

returns the question position

Tags:

return:	integer - question position
author:	- Olivier Brouckaert

[ Top ]

- selectTitle(
)

returns the question title

Tags:

return:	string - question title
author:	- Olivier Brouckaert

[ Top ]

- selectType(
)

returns the answer type

Tags:

return:	integer - answer type
author:	- Olivier Brouckaert

[ Top ]

- selectWeighting(
)

returns the question weighting

Tags:

return:	integer - question weighting
author:	- Olivier Brouckaert

[ Top ]

void setTmpPicture(
-
$Picture, -
$PictureName)

saves the picture coming from POST into a temporary file Temporary pictures are used when we don't want to save a picture right after a form submission.

For example, if we first show a confirmation box.

Tags:

author:

- Olivier Brouckaert

Parameters:

-	$Picture	string $Picture - temporary path of the picture to move
-	$PictureName	string $PictureName - Name of the picture

[ Top ]

void updateDescription(
-
$description)

changes the question description

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$description

string $description - question description

[ Top ]

void updatePosition(
-
$position)

changes the question position

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$position

integer $position - question position

[ Top ]

void updateTitle(
-
$title)

changes the question title

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$title

string $title - question title

[ Top ]

void updateType(
-
$type)

changes the answer type. If the user changes the type from "unique answer" to "multiple answers" (or conversely) answers are not deleted, otherwise yes

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$type

integer $type - answer type

[ Top ]

void updateWeighting(
-
$weighting)

changes the question weighting

Tags:

author:

- Olivier Brouckaert

Parameters:

-

$weighting

integer $weighting - question weighting

[ Top ]

- uploadPicture(
-
$Picture, -
$PictureName)

adds a picture to the question

Tags:

return:	boolean - true if uploaded, otherwise false
author:	- Olivier Brouckaert

Parameters:

-	$Picture	string $Picture - temporary path of the picture to upload
-	$PictureName	string $PictureName - Name of the picture

[ Top ]

Class: Question

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

static $explanationLangVar = ''

static $typePicture = 'new_question.png'

$description =

$exerciseList =

$id =

$picture =

$position =

$question =

$type =

$weighting =

Class Methods

static method display_type_menu [line 808]

static method getInstance [line 709]

Tags:

Parameters:

static method read [line 99]

Tags:

Parameters:

constructor Question [line 80]

Tags:

method addToList [line 589]

Tags:

Parameters:

method createAnswersForm [line 796]

Tags:

Parameters:

method createForm [line 733]

Parameters:

method delete [line 647]

Tags:

Parameters:

method duplicate [line 683]

Tags:

method exportPicture [line 451]

Tags:

Parameters:

method getTmpPicture [line 499]

Tags:

method processAnswersCreation [line 802]

Tags:

Parameters:

method processCreation [line 780]

Parameters:

method removeFromList [line 613]

Tags:

Parameters:

method removePicture [line 428]

Tags:

method resizePicture [line 342]

Tags:

Parameters:

method save [line 534]

Tags:

Parameters:

method selectDescription [line 167]

Tags:

method selectExerciseList [line 223]

Tags:

method selectId [line 144]

Tags:

method selectNbrExercises [line 234]

Tags:

method selectPicture [line 212]

Tags:

method selectPosition [line 190]

Tags:

method selectTitle [line 155]

Tags:

method selectType [line 201]

Tags:

method selectWeighting [line 179]