ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilADTText Class Reference
+ Inheritance diagram for ilADTText:
+ Collaboration diagram for ilADTText:

Public Member Functions

 reset ()
 Init property defaults. More...
 
 setText ($a_value=null)
 
 getText ()
 
 getLength ()
 
 equals (ilADT $a_adt)
 Check if given ADT equals self. More...
 
 isLarger (ilADT $a_adt)
 Check if given ADT is larger than self. More...
 
 isSmaller (ilADT $a_adt)
 Check if given ADT is smaller than self. More...
 
 isNull ()
 Is currently null. More...
 
 isValid ()
 Is currently valid. More...
 
 getCheckSum ()
 Get unique checksum. More...
 
- Public Member Functions inherited from ilADT
 __construct (ilADTDefinition $a_def)
 Constructor. More...
 
 getType ()
 Get type (from class/instance) 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)
 Check if given ADT is larger or equal than self. More...
 
 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 ()
 Is currently valid. More...
 
 getValidationErrors ()
 Get all validation error codes. More...
 
 translateErrorCode ($a_code)
 Translate error-code to human-readable message. More...
 
 getCheckSum ()
 Get unique checksum. More...
 

Protected Member Functions

 isValidDefinition (ilADTDefinition $a_def)
 Check if definition is valid for ADT. More...
 
- Protected Member Functions inherited from ilADT
 reset ()
 Init property defaults. More...
 
 isValidDefinition (ilADTDefinition $a_def)
 Check if definition is valid for ADT. More...
 
 setDefinition (ilADTDefinition $a_def)
 Set definition. More...
 
 getDefinition ()
 Get definition. More...
 
 addValidationError ($a_error_code)
 Add validation error code. More...
 

Protected Attributes

 $value
 
- Protected Attributes inherited from ilADT
 $definition
 
 $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"
 

Detailed Description

Definition at line 3 of file class.ilADTText.php.

Member Function Documentation

◆ equals()

ilADTText::equals ( ilADT  $a_adt)

Check if given ADT equals self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

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

58 {
59 if($this->getDefinition()->isComparableTo($a_adt))
60 {
61 return !strcmp($this->getText(), $a_adt->getText());
62 }
63 }
getDefinition()
Get definition.
Definition: class.ilADT.php:99

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

+ Here is the call graph for this function:

◆ getCheckSum()

ilADTText::getCheckSum ( )

Get unique checksum.

Returns
string

Reimplemented from ilADT.

Definition at line 106 of file class.ilADTText.php.

107 {
108 if(!$this->isNull())
109 {
110 return md5($this->getText());
111 }
112 }
isNull()
Is currently null.

References getText(), and isNull().

+ Here is the call graph for this function:

◆ getLength()

ilADTText::getLength ( )

Definition at line 39 of file class.ilADTText.php.

40 {
41 // see ilStr::strLen();
42 // not using ilStr to reduce dependencies in this low-level code
43
44 if(function_exists("mb_strlen"))
45 {
46 return mb_strlen($this->getText(), "UTF-8");
47 }
48 else
49 {
50 return strlen($this->getText());
51 }
52 }

References getText().

Referenced by isNull(), and isValid().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getText()

ilADTText::getText ( )

Definition at line 34 of file class.ilADTText.php.

35 {
36 return $this->value;
37 }

References $value.

Referenced by equals(), getCheckSum(), and getLength().

+ Here is the caller graph for this function:

◆ isLarger()

ilADTText::isLarger ( ilADT  $a_adt)

Check if given ADT is larger than self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 65 of file class.ilADTText.php.

66 {
67 // return null?
68 }

◆ isNull()

ilADTText::isNull ( )

Is currently null.

Returns
bool

Reimplemented from ilADT.

Definition at line 78 of file class.ilADTText.php.

79 {
80 return !(bool)$this->getLength();
81 }

References getLength().

Referenced by getCheckSum(), and isValid().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isSmaller()

ilADTText::isSmaller ( ilADT  $a_adt)

Check if given ADT is smaller than self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 70 of file class.ilADTText.php.

71 {
72 // return null?
73 }

◆ isValid()

ilADTText::isValid ( )

Is currently valid.

Returns
boolean

Reimplemented from ilADT.

Definition at line 86 of file class.ilADTText.php.

87 {
88 $valid = parent::isValid();
89
90 if(!$this->isNull())
91 {
92 $max = $this->getDefinition()->getMaxLength();
93 if($max && $max < $this->getLength())
94 {
95 $valid = false;
96 $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX_LENGTH);
97 }
98 }
99
100 return $valid;
101 }
addValidationError($a_error_code)
Add validation error code.
$valid

References $valid, ilADT\addValidationError(), ilADT\getDefinition(), getLength(), and isNull().

+ Here is the call graph for this function:

◆ isValidDefinition()

ilADTText::isValidDefinition ( ilADTDefinition  $a_def)
protected

Check if definition is valid for ADT.

Returns
bool;

Reimplemented from ilADT.

Definition at line 10 of file class.ilADTText.php.

11 {
12 return ($a_def instanceof ilADTTextDefinition);
13 }

◆ reset()

ilADTText::reset ( )

Init property defaults.

Reimplemented from ilADT.

Definition at line 15 of file class.ilADTText.php.

16 {
17 parent::reset();
18
19 $this->value = null;
20 }

◆ setText()

ilADTText::setText (   $a_value = null)

Definition at line 25 of file class.ilADTText.php.

26 {
27 if($a_value !== null)
28 {
29 $a_value = trim($a_value);
30 }
31 $this->value = $a_value;
32 }

Field Documentation

◆ $value

ilADTText::$value
protected

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

Referenced by getText().


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