ILIAS\components\Dashboard\Block\BlockDTO Class Reference

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

Public Member Functions
	__construct (private string $type, private int $ref_id, private int $obj_id, private string $title, private string $description, private ?ilDateTime $startDate=null, private ?ilDateTime $endDate=null, private array $additional_data=[])
	getType ()
	setType (string $type)
	getRefId ()
	setRefId (int $ref_id)
	getObjId ()
	setObjId (int $obj_id)
	getTitle ()
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getStartDate ()
	setStartDate (?ilDateTime $startDate)
	getEndDate ()
	setEndDate (?ilDateTime $endDate)
	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 int	$ref_id,
		private int	$obj_id,
		private string	$title,
		private string	$description,
		private ?ilDateTime	$startDate = null,
		private ?ilDateTime	$endDate = null,
		private array	$additional_data = []
	)

Definition at line 27 of file BlockDTO.php.

References $ref_id.

      {
        $this->type = $type;
        $this->ref_id = $ref_id;
        $this->obj_id = $obj_id;
        $this->title = $title;
        $this->description = $description;
        $this->startDate = $startDate;
        $this->endDate = $endDate;
        $this->additional_data = $additional_data;
    }

Member Function Documentation

getAdditionalData()

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

(

)

Definition at line 137 of file BlockDTO.php.

Referenced by ilDashboardBlockGUI\getListItemForDataDTO().

                                       : array
    {
        return $this->additional_data;
    }

Here is the caller graph for this function:

getDescription()

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

(

)

Definition at line 87 of file BlockDTO.php.

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

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getEndDate()

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

(

)

Definition at line 107 of file BlockDTO.php.

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

getObjId()

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

(

)

Definition at line 67 of file BlockDTO.php.

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

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getRefId()

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

(

)

Definition at line 57 of file BlockDTO.php.

References $ref_id.

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

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

getStartDate()

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

(

)

Definition at line 97 of file BlockDTO.php.

Referenced by ilDashboardBlockGUI\sortByDate().

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

Here is the caller graph for this function:

getTitle()

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

(

)

Definition at line 77 of file BlockDTO.php.

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

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

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

(

)

Definition at line 47 of file BlockDTO.php.

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

                             : string
    {
        return $this->type;
    }

Here is the caller graph for this function:

hasEnded()

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

(

)

Definition at line 122 of file BlockDTO.php.

References IL_CAL_UNIX.

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

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

Here is the caller graph for this function:

hasNotStarted()

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

(

)

Definition at line 117 of file BlockDTO.php.

References IL_CAL_UNIX.

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

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

Here is the caller graph for this function:

isDated()

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

(

)

Definition at line 132 of file BlockDTO.php.

                             : bool
    {
        return $this->startDate || $this->endDate;
    }

isRunning()

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

(

)

Definition at line 127 of file BlockDTO.php.

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

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

Here is the call graph for this function:

setAdditionalData()

ILIAS\components\Dashboard\Block\BlockDTO::setAdditionalData

(

array

$additional_data

)

Definition at line 142 of file BlockDTO.php.

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

setDescription()

ILIAS\components\Dashboard\Block\BlockDTO::setDescription

(

string

$description

)

Definition at line 92 of file BlockDTO.php.

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

setEndDate()

ILIAS\components\Dashboard\Block\BlockDTO::setEndDate

(

?ilDateTime

$endDate

)

Definition at line 112 of file BlockDTO.php.

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

setObjId()

ILIAS\components\Dashboard\Block\BlockDTO::setObjId

(

int

$obj_id

)

Definition at line 72 of file BlockDTO.php.

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

setRefId()

ILIAS\components\Dashboard\Block\BlockDTO::setRefId

(

int

$ref_id

)

Definition at line 62 of file BlockDTO.php.

References $ref_id.

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

setStartDate()

ILIAS\components\Dashboard\Block\BlockDTO::setStartDate

(

?ilDateTime

$startDate

)

Definition at line 102 of file BlockDTO.php.

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

setTitle()

ILIAS\components\Dashboard\Block\BlockDTO::setTitle

(

string

$title

)

Definition at line 82 of file BlockDTO.php.

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

setType()

ILIAS\components\Dashboard\Block\BlockDTO::setType

(

string

$type

)

Definition at line 52 of file BlockDTO.php.

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

toArray()

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

(

)

Definition at line 147 of file BlockDTO.php.

References $ref_id, and IL_CAL_DATETIME.

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

---

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

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