Inheritance diagram for ilADTDateTime:

Collaboration diagram for ilADTDateTime:

Public Member Functions
	reset ()
	Init property defaults. More...

	setDate (ilDateTime $a_value=null)

	getDate ()

	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.ilADTDateTime.php.

Member Function Documentation

◆ equals()

ilADTDateTime::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 41 of file class.ilADTDateTime.php.

    {
        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);
            }
        }
        // null?
    }

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

Here is the call graph for this function:

◆ exportStdClass()

ilADTDateTime::exportStdClass ( )

Export value as stdClass.

Returns: stdClass

Reimplemented from ilADT.

Definition at line 119 of file class.ilADTDateTime.php.

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

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

Here is the call graph for this function:

◆ getCheckSum()

ilADTDateTime::getCheckSum ( )

Get unique checksum.

Returns: string

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

◆ getDate()

ilADTDateTime::getDate ( )

Definition at line 33 of file class.ilADTDateTime.php.

    {
        return $this->value;
    }

References $value.

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

Here is the caller graph for this function:

◆ importStdClass()

ilADTDateTime::importStdClass ( $a_std )

Import value from stdClass.

Parameters

stdClass $a_std

Reimplemented from ilADT.

Definition at line 128 of file class.ilADTDateTime.php.

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

References IL_CAL_UNIX, and setDate().

Here is the call graph for this function:

◆ isLarger()

ilADTDateTime::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 54 of file class.ilADTDateTime.php.

    {
        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);
            }
        }
    }

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

Here is the call graph for this function:

◆ isNull()

ilADTDateTime::isNull ( )

Is currently null.

Returns: bool

Reimplemented from ilADT.

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

    {
        return (!($this->value instanceof ilDateTime) || $this->value->isNull());
    }

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

Here is the caller graph for this function:

◆ isSmaller()

ilADTDateTime::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.ilADTDateTime.php.

    {
        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);
            }
        }
    }

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

Here is the call graph for this function:

◆ isValid()

ilADTDateTime::isValid ( )

Is currently valid.

Returns: boolean

Reimplemented from ilADT.

Definition at line 87 of file class.ilADTDateTime.php.

    {
        $valid = parent::isValid();
        
        /* timestamp is "always" valid
        if(!$this->isNull())
        {
            $value = getdate($this->getDate()->get(IL_CAL_UNIX));
            if(!checkdate($value["mon"], $value["mday"], $value["year"]))
            {
                $valid = false;
                $this->addValidationError(self::ADT_VALIDATION_DATE);
            }
        }
        */
            
        return $valid;
    }

References $valid.

◆ isValidDefinition()

ilADTDateTime::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented from ilADT.

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

    {
        return ($a_def instanceof ilADTDateTimeDefinition);
    }

◆ reset()

ilADTDateTime::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

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

◆ setDate()

ilADTDateTime::setDate ( ilDateTime $a_value = null )

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

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

Referenced by importStdClass().

Here is the caller graph for this function:

Field Documentation

◆ $value

ilADTDateTime::$value

protected

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

Referenced by equals(), getDate(), isLarger(), and isSmaller().

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

Services/ADT/classes/Types/DateTime/class.ilADTDateTime.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getDate()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setDate()

Field Documentation

◆ $value