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...
	exportStdClass ()
	Export value as stdClass. More...
	importStdClass ($a_std)
	Import value from stdClass. 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...
	exportStdClass ()
	Export value as stdClass. More...
	importStdClass ($a_std)
	Import value from stdClass. 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"
const	ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

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 53 of file class.ilADTText.php.

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return !strcmp($this->getText(), $a_adt->getText());
        }
    }

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

Here is the call graph for this function:

exportStdClass()

ilADTText::exportStdClass

(

)

Export value as stdClass.

Returns

stdClass

Reimplemented from ilADT.

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

    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->value = $this->getText();
            return $obj;
        }
    }

References getText(), and isNull().

Here is the call graph for this function:

getCheckSum()

ilADTText::getCheckSum

(

)

Get unique checksum.

Returns

string

Reimplemented from ilADT.

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

    {
        if (!$this->isNull()) {
            return md5($this->getText());
        }
    }

References getText(), and isNull().

Here is the call graph for this function:

getLength()

ilADTText::getLength

(

)

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

    {
        // see ilStr::strLen();
        // not using ilStr to reduce dependencies in this low-level code
        
        if (function_exists("mb_strlen")) {
            return mb_strlen($this->getText(), "UTF-8");
        } else {
            return strlen($this->getText());
        }
    }

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 33 of file class.ilADTText.php.

    {
        return $this->value;
    }

References $value.

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

Here is the caller graph for this function:

importStdClass()

ilADTText::importStdClass

(

$a_std

)

Import value from stdClass.

Parameters

stdClass

$a_std

Reimplemented from ilADT.

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

    {
        if (is_object($a_std)) {
            $this->setText($a_std->value);
        }
    }

References setText().

Here is the call 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 60 of file class.ilADTText.php.

    {
        // return null?
    }

isNull()

ilADTText::isNull

(

)

Is currently null.

Returns

bool

Reimplemented from ilADT.

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

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

References getLength().

Referenced by exportStdClass(), 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 65 of file class.ilADTText.php.

    {
        // return null?
    }

isValid()

ilADTText::isValid

(

)

Is currently valid.

Returns

boolean

Reimplemented from ilADT.

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

    {
        $valid = parent::isValid();
        
        if (!$this->isNull()) {
            $max = $this->getDefinition()->getMaxLength();
            if ($max && $max < $this->getLength()) {
                $valid = false;
                $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX_LENGTH);
            }
        }
            
        return $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.

    {
        return ($a_def instanceof ilADTTextDefinition);
    }

reset()

ilADTText::reset

(

)

Init property defaults.

Reimplemented from ilADT.

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

    {
        parent::reset();
        
        $this->value = null;
    }

setText()

ilADTText::setText

(

$a_value = null

)

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

    {
        if ($a_value !== null) {
            $a_value = trim($a_value);
        }
        $this->value = $a_value;
    }

Referenced by importStdClass().

Here is the caller graph for this function:

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:

• Services/ADT/classes/Types/Text/class.ilADTText.php