ILIAS\components\Dashboard\Block\BlockDTO Class Reference

Collaboration diagram for ILIAS\components\Dashboard\Block\BlockDTO:

Public Member Functions
	__construct (private string $type, private readonly int $ref_id, private readonly int $obj_id, private string $title, private string $description, private ?ilDateTime $start_date=null, private ?ilDateTime $end_date=null, private array $additional_data=[])
	getType ()
	setType (string $type)
	getRefId ()
	getObjId ()
	getTitle ()
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getStartDate ()
	setStartDate (?ilDateTime $start_date)
	getEndDate ()
	setEndDate (?ilDateTime $end_date)
	hasNotStarted ()
	hasEnded ()
	isRunning ()
	isDated ()
	getAdditionalData ()
	setAdditionalData (array $additional_data)
	toArray ()

Detailed Description

Definition at line 25 of file BlockDTO.php.

Constructor & Destructor Documentation

__construct()

ILIAS\components\Dashboard\Block\BlockDTO::__construct	(	private string	$type,
		private readonly int	$ref_id,
		private readonly int	$obj_id,
		private string	$title,
		private string	$description,
		private ?ilDateTime	$start_date = null,
		private ?ilDateTime	$end_date = null,
		private array	$additional_data = []
	)

Definition at line 27 of file BlockDTO.php.

      {
    }

Member Function Documentation

getAdditionalData()

ILIAS\components\Dashboard\Block\BlockDTO::getAdditionalData ( )

final

Definition at line 119 of file BlockDTO.php.

                                             : array
    {
        return $this->additional_data;
    }

getDescription()

ILIAS\components\Dashboard\Block\BlockDTO::getDescription ( )

final

Definition at line 69 of file BlockDTO.php.

                                          : string
    {
        return $this->description;
    }

getEndDate()

ILIAS\components\Dashboard\Block\BlockDTO::getEndDate ( )

final

Definition at line 89 of file BlockDTO.php.

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

getObjId()

ILIAS\components\Dashboard\Block\BlockDTO::getObjId ( )

final

Definition at line 54 of file BlockDTO.php.

                                    : int
    {
        return $this->obj_id;
    }

getRefId()

ILIAS\components\Dashboard\Block\BlockDTO::getRefId ( )

final

Definition at line 49 of file BlockDTO.php.

                                    : int
    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by ilDashboardBlockGUI\sortManually().

Here is the caller graph for this function:

getStartDate()

ILIAS\components\Dashboard\Block\BlockDTO::getStartDate ( )

final

Definition at line 79 of file BlockDTO.php.

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

Referenced by ilDashboardBlockGUI\sortByDate().

Here is the caller graph for this function:

getTitle()

ILIAS\components\Dashboard\Block\BlockDTO::getTitle ( )

final

Definition at line 59 of file BlockDTO.php.

                                    : string
    {
        return $this->title;
    }

Referenced by ilDashboardBlockGUI\sortByTitle().

Here is the caller graph for this function:

getType()

ILIAS\components\Dashboard\Block\BlockDTO::getType ( )

final

Definition at line 39 of file BlockDTO.php.

                                   : string
    {
        return $this->type;
    }

Referenced by ilDashboardBlockGUI\getCardForData(), and ilDashboardBlockGUI\getListItemForDataDTO().

Here is the caller graph for this function:

hasEnded()

ILIAS\components\Dashboard\Block\BlockDTO::hasEnded ( )

final

Definition at line 104 of file BlockDTO.php.

                                    : bool
    {
        return $this->end_date && $this->end_date->get(IL_CAL_UNIX) < time();
    }

References IL_CAL_UNIX.

Referenced by ILIAS\components\Dashboard\Block\BlockDTO\isRunning().

Here is the caller graph for this function:

hasNotStarted()

ILIAS\components\Dashboard\Block\BlockDTO::hasNotStarted ( )

final

Definition at line 99 of file BlockDTO.php.

                                         : bool
    {
        return $this->start_date && $this->start_date->get(IL_CAL_UNIX) > time();
    }

References IL_CAL_UNIX.

Referenced by ILIAS\components\Dashboard\Block\BlockDTO\isRunning().

Here is the caller graph for this function:

isDated()

ILIAS\components\Dashboard\Block\BlockDTO::isDated ( )

final

Definition at line 114 of file BlockDTO.php.

                                   : bool
    {
        return $this->start_date || $this->end_date;
    }

isRunning()

ILIAS\components\Dashboard\Block\BlockDTO::isRunning ( )

final

Definition at line 109 of file BlockDTO.php.

                                     : bool
    {
        return !$this->hasNotStarted() && !$this->hasEnded();
    }

References ILIAS\components\Dashboard\Block\BlockDTO\hasEnded(), and ILIAS\components\Dashboard\Block\BlockDTO\hasNotStarted().

Here is the call graph for this function:

setAdditionalData()

ILIAS\components\Dashboard\Block\BlockDTO::setAdditionalData ( array  $additional_data )

final

Definition at line 124 of file BlockDTO.php.

                                                                   : void
    {
        $this->additional_data = $additional_data;
    }

setDescription()

ILIAS\components\Dashboard\Block\BlockDTO::setDescription ( string  $description )

final

Definition at line 74 of file BlockDTO.php.

                                                             : void
    {
        $this->description = $description;
    }

setEndDate()

ILIAS\components\Dashboard\Block\BlockDTO::setEndDate ( ?ilDateTime  $end_date )

final

Definition at line 94 of file BlockDTO.php.

                                                           : void
    {
        $this->end_date = $end_date;
    }

setStartDate()

ILIAS\components\Dashboard\Block\BlockDTO::setStartDate ( ?ilDateTime  $start_date )

final

Definition at line 84 of file BlockDTO.php.

                                                               : void
    {
        $this->start_date = $start_date;
    }

setTitle()

ILIAS\components\Dashboard\Block\BlockDTO::setTitle ( string  $title )

final

Definition at line 64 of file BlockDTO.php.

                                                 : void
    {
        $this->title = $title;
    }

setType()

ILIAS\components\Dashboard\Block\BlockDTO::setType ( string  $type )

final

Definition at line 44 of file BlockDTO.php.

                                               : void
    {
        $this->type = $type;
    }

toArray()

ILIAS\components\Dashboard\Block\BlockDTO::toArray ( )

final

Definition at line 129 of file BlockDTO.php.

                                   : array
    {
        return [
            'type' => $this->type,
            'ref_id' => $this->ref_id,
            'obj_id' => $this->obj_id,
            'title' => $this->title,
            'description' => $this->description,
            'start_date' => $this->start_date?->get(IL_CAL_DATETIME),
            'end_date' => $this->end_date?->get(IL_CAL_DATETIME),
            'additional_data' => $this->additional_data
        ];
    }

References $ref_id, and IL_CAL_DATETIME.

---

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

• components/ILIAS/Dashboard/Block/classes/BlockDTO.php