Inheritance diagram for ilADTBoolean:

Collaboration diagram for ilADTBoolean:

Public Member Functions
	reset ()

	setStatus (bool $a_value=null)

	getStatus ()

	equals (ilADT $a_adt)

	isLarger (ilADT $a_adt)

	isSmaller (ilADT $a_adt)

	isNull ()

	isValid ()

	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
bool	$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.ilADTBoolean.php.

Member Function Documentation

◆ equals()

ilADTBoolean::equals ( ilADT $a_adt )

Definition at line 36 of file class.ilADTBoolean.php.

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

                                         : ?bool
     {
         if ($this->getDefinition()->isComparableTo($a_adt)) {
             return ($this->getStatus() === $a_adt->getStatus());
         }
         return null;
     }

Here is the call graph for this function:

◆ exportStdClass()

ilADTBoolean::exportStdClass ( )

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

References getStatus(), and isNull().

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

Here is the call graph for this function:

◆ getCheckSum()

ilADTBoolean::getCheckSum ( )

Definition at line 68 of file class.ilADTBoolean.php.

References getStatus(), and isNull().

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

Here is the call graph for this function:

◆ getStatus()

ilADTBoolean::getStatus ( )

Definition at line 29 of file class.ilADTBoolean.php.

References $value.

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

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

Here is the caller graph for this function:

◆ importStdClass()

ilADTBoolean::importStdClass ( ?stdClass $a_std )

Definition at line 88 of file class.ilADTBoolean.php.

References setStatus().

                                                     : void
     {
         if (is_object($a_std)) {
             $this->setStatus((bool) $a_std->value);
         }
     }

Here is the call graph for this function:

◆ isLarger()

ilADTBoolean::isLarger ( ilADT $a_adt )

Definition at line 44 of file class.ilADTBoolean.php.

                                           : ?bool
     {
         return null;
     }

◆ isNull()

ilADTBoolean::isNull ( )

Definition at line 56 of file class.ilADTBoolean.php.

References getStatus().

Referenced by exportStdClass(), and getCheckSum().

                             : bool
     {
         return $this->getStatus() === null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTBoolean::isSmaller ( ilADT $a_adt )

Definition at line 49 of file class.ilADTBoolean.php.

                                            : ?bool
     {
         return null;
     }

◆ isValid()

ilADTBoolean::isValid ( )

Definition at line 61 of file class.ilADTBoolean.php.

                              : bool
     {
         return true;
     }

◆ isValidDefinition()

ilADTBoolean::isValidDefinition ( ilADTDefinition $a_def )

protected

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

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

◆ reset()

ilADTBoolean::reset ( )

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

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

◆ setStatus()

ilADTBoolean::setStatus ( bool $a_value = null )

Definition at line 24 of file class.ilADTBoolean.php.

Referenced by importStdClass().

                                                    : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

Field Documentation

◆ $value

bool ilADTBoolean::$value

protected

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

Referenced by getStatus().

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

Services/ADT/classes/Types/Boolean/class.ilADTBoolean.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getStatus()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setStatus()

Field Documentation

◆ $value