ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ilADTMultiEnum Class Reference
+ Inheritance diagram for ilADTMultiEnum:
+ Collaboration diagram for ilADTMultiEnum:

Public Member Functions

 getType ()
 
 reset ()
 
 addSelection (int $value_index)
 
 setSelections (array $a_values=null)
 
 getSelections ()
 
 isValidOption ($a_value)
 
 equals (ilADT $a_adt)
 
 isLarger (ilADT $a_adt)
 
 isSmaller (ilADT $a_adt)
 
 isNull ()
 
 getCheckSum ()
 
 exportStdClass ()
 
 importStdClass (?stdClass $a_std)
 
- Public Member Functions inherited from ilADT
 __construct (ilADTDefinition $a_def)
 
 getType ()
 Get type (from class/instance) More...
 
 reset ()
 Init property defaults. More...
 
 getCopyOfDefinition ()
 Get copy of definition. More...
 
 equals (ilADT $a_adt)
 Check if given ADT equals self. More...
 
 isLarger (ilADT $a_adt)
 Check if given ADT is larger than self. More...
 
 isLargerOrEqual (ilADT $a_adt)
 
 isSmaller (ilADT $a_adt)
 Check if given ADT is smaller than self. More...
 
 isSmallerOrEqual (ilADT $a_adt)
 Check if given ADT is smaller or equal than self. More...
 
 isInbetween (ilADT $a_adt_from, ilADT $a_adt_to)
 Check if self is inbetween given ADTs (exclusive) More...
 
 isInbetweenOrEqual (ilADT $a_adt_from, ilADT $a_adt_to)
 Check if self is inbetween given ADTs (inclusive) More...
 
 isNull ()
 Is currently null. More...
 
 isValid ()
 
 getValidationErrors ()
 Get all validation error codes. More...
 
 translateErrorCode (string $a_code)
 Translate error-code to human-readable message. More...
 
 getCheckSum ()
 Get unique checksum. More...
 
 exportStdClass ()
 Export value as stdClass. More...
 
 importStdClass (?stdClass $a_std)
 Import value from stdClass. More...
 

Protected Member Functions

 isValidDefinition (ilADTDefinition $a_def)
 
 handleSelectionValue ($a_value)
 
- Protected Member Functions inherited from ilADT
 isValidDefinition (ilADTDefinition $a_def)
 Check if definition is valid for ADT. More...
 
 setDefinition (ilADTDefinition $a_def)
 Set definition. More...
 
 getDefinition ()
 Get definition. More...
 
 addValidationError (string $a_error_code)
 

Protected Attributes

array $values
 
- Protected Attributes inherited from ilADT
ilADTDefinition $definition
 
ilLanguage $lng
 
array $validation_errors = []
 

Additional Inherited Members

- Data Fields inherited from ilADT
const ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED = "adt1"
 
const ADT_VALIDATION_ERROR_MAX_LENGTH = "adt2"
 
const ADT_VALIDATION_ERROR_MAX_SIZE = "adt3"
 
const ADT_VALIDATION_ERROR_MIN = "adt4"
 
const ADT_VALIDATION_ERROR_MAX = "adt5"
 
const ADT_VALIDATION_DATE = "adt6"
 
const ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'
 

Detailed Description

Definition at line 5 of file class.ilADTMultiEnum.php.

Member Function Documentation

◆ addSelection()

ilADTMultiEnum::addSelection ( int  $value_index)

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

References isValidOption().

35  : void
36  {
37  if (!$this->isValidOption($value_index)) {
38  return;
39  }
40  $this->values[] = $value_index;
41  }
+ Here is the call graph for this function:

◆ equals()

ilADTMultiEnum::equals ( ilADT  $a_adt)

Definition at line 75 of file class.ilADTMultiEnum.php.

References getCheckSum(), ilADT\getCheckSum(), and ilADT\getDefinition().

75  : ?bool
76  {
77  if ($this->getDefinition()->isComparableTo($a_adt)) {
78  return ($this->getCheckSum() === $a_adt->getCheckSum());
79  }
80  return null;
81  }
getCheckSum()
Get unique checksum.
getDefinition()
Get definition.
Definition: class.ilADT.php:92
+ Here is the call graph for this function:

◆ exportStdClass()

ilADTMultiEnum::exportStdClass ( )

Definition at line 112 of file class.ilADTMultiEnum.php.

References getSelections(), and isNull().

112  : ?stdClass
113  {
114  if (!$this->isNull()) {
115  $obj = new stdClass();
116  $obj->value = (array) $this->getSelections();
117  return $obj;
118  }
119  return null;
120  }
+ Here is the call graph for this function:

◆ getCheckSum()

ilADTMultiEnum::getCheckSum ( )

Definition at line 100 of file class.ilADTMultiEnum.php.

References getSelections(), and isNull().

Referenced by equals().

100  : ?string
101  {
102  if (!$this->isNull()) {
103  $current = $this->getSelections();
104  sort($current);
105  return md5(implode(",", $current));
106  }
107  return null;
108  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelections()

ilADTMultiEnum::getSelections ( )

Definition at line 58 of file class.ilADTMultiEnum.php.

References $values.

Referenced by exportStdClass(), getCheckSum(), and isNull().

58  : ?array
59  {
60  return $this->values;
61  }
+ Here is the caller graph for this function:

◆ getType()

ilADTMultiEnum::getType ( )

Definition at line 9 of file class.ilADTMultiEnum.php.

9  : string
10  {
11  return "MultiEnum";
12  }

◆ handleSelectionValue()

ilADTMultiEnum::handleSelectionValue (   $a_value)
abstractprotected
Parameters
string | int$a_value
Returns
string|int

Referenced by isValidOption(), reset(), and setSelections().

+ Here is the caller graph for this function:

◆ importStdClass()

ilADTMultiEnum::importStdClass ( ?stdClass  $a_std)

Definition at line 122 of file class.ilADTMultiEnum.php.

References setSelections().

122  : void
123  {
124  if (is_object($a_std)) {
125  $this->setSelections($a_std->value);
126  }
127  }
setSelections(array $a_values=null)
+ Here is the call graph for this function:

◆ isLarger()

ilADTMultiEnum::isLarger ( ilADT  $a_adt)

Definition at line 83 of file class.ilADTMultiEnum.php.

83  : ?bool
84  {
85  return null;
86  }

◆ isNull()

ilADTMultiEnum::isNull ( )

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

References getSelections().

Referenced by exportStdClass(), and getCheckSum().

95  : bool
96  {
97  return $this->getSelections() === null;
98  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isSmaller()

ilADTMultiEnum::isSmaller ( ilADT  $a_adt)

Definition at line 88 of file class.ilADTMultiEnum.php.

88  : ?bool
89  {
90  return null;
91  }

◆ isValidDefinition()

ilADTMultiEnum::isValidDefinition ( ilADTDefinition  $a_def)
protected

Definition at line 16 of file class.ilADTMultiEnum.php.

16  : bool
17  {
18  return $a_def instanceof ilADTMultiEnumDefinition;
19  }

◆ isValidOption()

ilADTMultiEnum::isValidOption (   $a_value)
Parameters
string | int$a_value
Returns
bool

Definition at line 67 of file class.ilADTMultiEnum.php.

References ilADT\getDefinition(), and handleSelectionValue().

Referenced by addSelection(), and setSelections().

67  : bool
68  {
69  $a_value = $this->handleSelectionValue($a_value);
70  return array_key_exists($a_value, $this->getDefinition()->getOptions());
71  }
handleSelectionValue($a_value)
getDefinition()
Get definition.
Definition: class.ilADT.php:92
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ reset()

ilADTMultiEnum::reset ( )

Definition at line 21 of file class.ilADTMultiEnum.php.

References handleSelectionValue().

21  : void
22  {
23  parent::reset();
24  $this->values = null;
25  }
+ Here is the call graph for this function:

◆ setSelections()

ilADTMultiEnum::setSelections ( array  $a_values = null)

Definition at line 43 of file class.ilADTMultiEnum.php.

References handleSelectionValue(), ILIAS\Repository\int(), and isValidOption().

Referenced by importStdClass().

43  : void
44  {
45  if ($a_values === null) {
46  return;
47  }
48  $checked_values = [];
49  foreach ($a_values as $value_index) {
50  $clean_value = $this->handleSelectionValue($value_index);
51  if ($this->isValidOption($clean_value)) {
52  $checked_values[] = (int) $clean_value;
53  }
54  }
55  $this->values = count($checked_values) ? $checked_values : null;
56  }
handleSelectionValue($a_value)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $values

array ilADTMultiEnum::$values
protected

Definition at line 7 of file class.ilADTMultiEnum.php.

Referenced by getSelections().


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