ILIAS  release_8 Revision v8.19
•All Data Structures Namespaces Files Functions Variables Modules Pages
Public Member Functions | Static Public Attributes | Protected Attributes
ilUserQuestionResult Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Collaboration diagram for ilUserQuestionResult:

Public Member Functions

 __construct ($question, $active_id, $pass)
 
 addKeyValue ($key, $value)
 
 removeByKey ($key)
 
 getUserSolutionsByIdentifier ($identifier)
 
 getSolutions ()
 
 getSolutionForKey ($key)
 
 setReachedPercentage ($reached_percentage)
 
 getReachedPercentage ()
 
 hasSolutions ()
 

Static Public Attributes

static $USER_SOLUTION_IDENTIFIER_KEY = "key"
 
static $USER_SOLUTION_IDENTIFIER_VALUE = "value"
 

Protected Attributes

 $question
 
 $active_id
 
 $pass
 
 $reached_percentage
 
 $solutions = array()
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilUserQuestionResult

Date: 10.01.14 Time: 10:03

Author
Thomas Joußen tjous.nosp@m.sen@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 26 of file class.ilUserQuestionResult.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserQuestionResult::__construct (   $question,
  $active_id,
  $pass 
)

Definition at line 57 of file class.ilUserQuestionResult.php.

References $active_id, $pass, and $question.

58  {
59  $this->question = $question;
60  $this->active_id = $active_id;
61  $this->pass = $pass;
62  }

Member Function Documentation

◆ addKeyValue()

ilUserQuestionResult::addKeyValue (   $key,
  $value 
)
Parameters
mixed$key
mixed$value

Definition at line 68 of file class.ilUserQuestionResult.php.

References ILIAS\LTI\ToolProvider\$key.

68  : void
69  {
70  $this->solutions[] = array(
71  self::$USER_SOLUTION_IDENTIFIER_KEY => $key,
72  self::$USER_SOLUTION_IDENTIFIER_VALUE => $value
73  );
74  }
ILIAS\LTI\ToolProvider\$key
string $key
Consumer key/client ID value.
Definition: System.php:193

◆ getReachedPercentage()

ilUserQuestionResult::getReachedPercentage ( )
Returns
int

Definition at line 145 of file class.ilUserQuestionResult.php.

References $reached_percentage.

145  : int
146  {
147  return $this->reached_percentage;
148  }

◆ getSolutionForKey()

ilUserQuestionResult::getSolutionForKey (   $key)
Parameters
int$key
Returns
array

Definition at line 124 of file class.ilUserQuestionResult.php.

References ILIAS\LTI\ToolProvider\$key.

124  : ?array
125  {
126  foreach ($this->solutions as $solution) {
127  if ($solution[self::$USER_SOLUTION_IDENTIFIER_KEY] == $key) {
128  return $solution;
129  }
130  }
131  return null;
132  }
ILIAS\LTI\ToolProvider\$key
string $key
Consumer key/client ID value.
Definition: System.php:193

◆ getSolutions()

ilUserQuestionResult::getSolutions ( )
Returns
array

Definition at line 114 of file class.ilUserQuestionResult.php.

References $solutions.

114  : array
115  {
116  return $this->solutions;
117  }

◆ getUserSolutionsByIdentifier()

ilUserQuestionResult::getUserSolutionsByIdentifier (   $identifier)
Parameters
string$identifier
Returns
array
Exceptions
Exception

Definition at line 95 of file class.ilUserQuestionResult.php.

References $solutions.

95  : array
96  {
97  if (
98  $identifier != self::$USER_SOLUTION_IDENTIFIER_KEY &&
99  $identifier != self::$USER_SOLUTION_IDENTIFIER_VALUE
100  ) {
101  throw new Exception(sprintf("Unkown Identifier %s", $identifier));
102  }
103 
104  $solutions = array();
105  foreach ($this->solutions as $solution) {
106  $solutions[] = $solution[$identifier];
107  }
108  return $solutions;
109  }

◆ hasSolutions()

ilUserQuestionResult::hasSolutions ( )
Returns
boolean

Definition at line 153 of file class.ilUserQuestionResult.php.

153  : bool
154  {
155  return count($this->solutions) > 0;
156  }

◆ removeByKey()

ilUserQuestionResult::removeByKey (   $key)
Parameters
string$key

Definition at line 79 of file class.ilUserQuestionResult.php.

References ILIAS\LTI\ToolProvider\$key.

79  : void
80  {
81  foreach ($this->solutions as $array_key => $solution) {
82  if ($solution[self::$USER_SOLUTION_IDENTIFIER_KEY] == $key) {
83  unset($this->solutions[$array_key]);
84  break;
85  }
86  }
87  }
ILIAS\LTI\ToolProvider\$key
string $key
Consumer key/client ID value.
Definition: System.php:193

◆ setReachedPercentage()

ilUserQuestionResult::setReachedPercentage (   $reached_percentage)
Parameters
int$reached_percentage

Definition at line 137 of file class.ilUserQuestionResult.php.

References $reached_percentage.

137  : void
138  {
139  $this->reached_percentage = $reached_percentage;
140  }

Field Documentation

◆ $active_id

ilUserQuestionResult::$active_id
protected

Definition at line 40 of file class.ilUserQuestionResult.php.

Referenced by __construct().

◆ $pass

ilUserQuestionResult::$pass
protected

Definition at line 45 of file class.ilUserQuestionResult.php.

Referenced by __construct().

◆ $question

ilUserQuestionResult::$question
protected

Definition at line 35 of file class.ilUserQuestionResult.php.

Referenced by __construct().

◆ $reached_percentage

ilUserQuestionResult::$reached_percentage
protected

Definition at line 50 of file class.ilUserQuestionResult.php.

Referenced by getReachedPercentage(), and setReachedPercentage().

◆ $solutions

ilUserQuestionResult::$solutions = array()
protected

Definition at line 55 of file class.ilUserQuestionResult.php.

Referenced by getSolutions(), and getUserSolutionsByIdentifier().

◆ $USER_SOLUTION_IDENTIFIER_KEY

ilUserQuestionResult::$USER_SOLUTION_IDENTIFIER_KEY = "key"
static

Definition at line 28 of file class.ilUserQuestionResult.php.

◆ $USER_SOLUTION_IDENTIFIER_VALUE

ilUserQuestionResult::$USER_SOLUTION_IDENTIFIER_VALUE = "value"
static

Definition at line 29 of file class.ilUserQuestionResult.php.

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