ilADTDate Class Reference

Inheritance diagram for ilADTDate:

Collaboration diagram for ilADTDate:

Public Member Functions
	reset ()
	setDate (?ilDateTime $a_value=null)
	getDate ()
	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)
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
ilDateTime	$value
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.ilADTDate.php.

Member Function Documentation

equals()

ilADTDate::equals

(

ilADT

$a_adt

)

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

References getDate(), ilADT\getDefinition(), IL_CAL_UNIX, isNull(), and ilADT\isNull().

                                        : ?bool
    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            if (!$this->isNull() && !$a_adt->isNull()) {
                // could use checksum...
                $value = $this->getDate()->get(IL_CAL_UNIX);
                $other = $a_adt->getDate()->get(IL_CAL_UNIX);
                return ($value == $other);
            }
        }
        return null;
    }

Here is the call graph for this function:

exportStdClass()

ilADTDate::exportStdClass

(

)

Definition at line 92 of file class.ilADTDate.php.

References getDate(), IL_CAL_UNIX, and isNull().

                                    : ?stdClass
    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->value = $this->getDate()->get(IL_CAL_UNIX);
            return $obj;
        }
        return null;
    }

Here is the call graph for this function:

getCheckSum()

ilADTDate::getCheckSum

(

)

Definition at line 82 of file class.ilADTDate.php.

References getDate(), IL_CAL_UNIX, and isNull().

                                 : ?string
    {
        if (!$this->isNull()) {
            return (string) $this->getDate()->get(IL_CAL_UNIX);
        }
        return null;
    }

Here is the call graph for this function:

getDate()

ilADTDate::getDate

(

)

Definition at line 31 of file class.ilADTDate.php.

References $value.

Referenced by equals(), exportStdClass(), getCheckSum(), isLarger(), and isSmaller().

                             : ?ilDateTime
    {
        return $this->value;
    }

Here is the caller graph for this function:

importStdClass()

ilADTDate::importStdClass

(

?stdClass

$a_std

)

Definition at line 102 of file class.ilADTDate.php.

References IL_CAL_UNIX, and setDate().

                                                    : void
    {
        if (is_object($a_std)) {
            $this->setDate(new ilDate($a_std->value, IL_CAL_UNIX));
        }
    }

Here is the call graph for this function:

isLarger()

ilADTDate::isLarger

(

ilADT

$a_adt

)

Definition at line 51 of file class.ilADTDate.php.

References getDate(), ilADT\getDefinition(), IL_CAL_UNIX, isNull(), and ilADT\isNull().

                                          : ?bool
    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            if (!$this->isNull() && !$a_adt->isNull()) {
                $value = $this->getDate()->get(IL_CAL_UNIX);
                $other = $a_adt->getDate()->get(IL_CAL_UNIX);
                return ($value > $other);
            }
        }
        return null;
    }

Here is the call graph for this function:

isNull()

ilADTDate::isNull

(

)

Definition at line 77 of file class.ilADTDate.php.

Referenced by equals(), exportStdClass(), getCheckSum(), isLarger(), and isSmaller().

                            : bool
    {
        return !$this->value instanceof ilDate || $this->value->isNull();
    }

Here is the caller graph for this function:

isSmaller()

ilADTDate::isSmaller

(

ilADT

$a_adt

)

Definition at line 63 of file class.ilADTDate.php.

References getDate(), ilADT\getDefinition(), IL_CAL_UNIX, isNull(), and ilADT\isNull().

                                           : ?bool
    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            if (!$this->isNull() && !$a_adt->isNull()) {
                $value = $this->getDate()->get(IL_CAL_UNIX);
                $other = $a_adt->getDate()->get(IL_CAL_UNIX);
                return ($value < $other);
            }
        }
        return null;
    }

Here is the call graph for this function:

isValidDefinition()

ilADTDate::isValidDefinition ( ilADTDefinition  $a_def )

protected

Definition at line 11 of file class.ilADTDate.php.

                                                                : bool
    {
        return ($a_def instanceof ilADTDateDefinition);
    }

reset()

ilADTDate::reset

(

)

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

                           : void
    {
        parent::reset();

        $this->value = null;
    }

setDate()

ilADTDate::setDate

(

?ilDateTime

$a_value = null

)

Definition at line 23 of file class.ilADTDate.php.

Referenced by importStdClass().

                                                        : void
    {
        if ($a_value && $a_value->isNull()) {
            $a_value = null;
        }
        $this->value = $a_value;
    }

Here is the caller graph for this function:

Field Documentation

$value

ilDateTime ilADTDate::$value

protected

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

Referenced by getDate().

---

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

• Services/ADT/classes/Types/Date/class.ilADTDate.php