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 ()
	isValid ()
	getCheckSum ()
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)
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.ilADTDate.php.

Member Function Documentation

equals()

ilADTDate::equals

(

ilADT

$a_adt

)

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

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

    {
        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?
    }

Here is the call graph for this function:

getCheckSum()

ilADTDate::getCheckSum

(

)

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

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

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

Here is the call graph for this function:

getDate()

ilADTDate::getDate

(

)

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

References $value.

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

    {
        return $this->value;
    }

Here is the caller graph for this function:

isLarger()

ilADTDate::isLarger

(

ilADT

$a_adt

)

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

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

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

Here is the call graph for this function:

isNull()

ilADTDate::isNull

(

)

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

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

    {
        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 65 of file class.ilADTDate.php.

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

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

Here is the call graph for this function:

isValid()

ilADTDate::isValid

(

)

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

References $valid.

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

isValidDefinition()

ilADTDate::isValidDefinition ( ilADTDefinition  $a_def )

protected

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

    {
        return ($a_def instanceof ilADTDateDefinition);
    }

reset()

ilADTDate::reset

(

)

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

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

setDate()

ilADTDate::setDate

(

ilDateTime

$a_value = null

)

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

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

Field Documentation

$value

ilADTDate::$value

protected

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

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

---

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

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