Inheritance diagram for ilCourseInfoFileTableDataRetrieval:

Collaboration diagram for ilCourseInfoFileTableDataRetrieval:

Public Member Functions
	__construct (protected ilObjCourse $course)

	getFileTitle (int $id)

	init ()

	getRows (\ILIAS\UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, \ILIAS\Data\Range $range, \ILIAS\Data\Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)

	getAllFileIds ()

	deleteFilesByIds (array $ids)

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Protected Attributes
array	$data

Detailed Description

Definition at line 23 of file class.ilCourseInfoFileTableDataRetrieval.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseInfoFileTableDataRetrieval::__construct ( protected ilObjCourse $course )

Definition at line 28 of file class.ilCourseInfoFileTableDataRetrieval.php.

      {
        $this->data = [];
    }

Member Function Documentation

◆ deleteFilesByIds()

ilCourseInfoFileTableDataRetrieval::deleteFilesByIds ( array $ids )

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

                                                : void
    {
        foreach ($ids as $file_id) {
            $file = new ilCourseFile((int) $file_id);
            if ($this->course->getId() == $file->getCourseId()) {
                $file->delete();
            }
        }
    }

◆ getAllFileIds()

ilCourseInfoFileTableDataRetrieval::getAllFileIds ( )

Returns: array<int>

Definition at line 74 of file class.ilCourseInfoFileTableDataRetrieval.php.

                                   : array
    {
        return array_keys($this->data);
    }

◆ getFileTitle()

ilCourseInfoFileTableDataRetrieval::getFileTitle ( int $id )

Definition at line 34 of file class.ilCourseInfoFileTableDataRetrieval.php.

                                         : string
    {
        return $this->data[$id]->getFileName();
    }

References $id.

◆ getRows()

ilCourseInfoFileTableDataRetrieval::getRows	(	\ILIAS\UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		\ILIAS\Data\Range	$range,
		\ILIAS\Data\Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Definition at line 50 of file class.ilCourseInfoFileTableDataRetrieval.php.

     : Generator {
        foreach ($this->data as $id => $file) {
            yield $row_builder->buildDataRow(
                $id . '',
                [
                    ilCourseInfoFileTableGUI::TABLE_COL_FILENAME => $file->getFileName(),
                    ilCourseInfoFileTableGUI::TABLE_COL_FILESIZE => $file->getFileSize(),
                    ilCourseInfoFileTableGUI::TABLE_COL_FILETYPE => $file->getFileType(),
                ]
            );
        }
    }

References $id, ilCourseInfoFileTableGUI\TABLE_COL_FILENAME, ilCourseInfoFileTableGUI\TABLE_COL_FILESIZE, and ilCourseInfoFileTableGUI\TABLE_COL_FILETYPE.

◆ getTotalRowCount()

ilCourseInfoFileTableDataRetrieval::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 89 of file class.ilCourseInfoFileTableDataRetrieval.php.

     : ?int {
        return count($this->data);
    }

◆ init()

ilCourseInfoFileTableDataRetrieval::init ( )

Definition at line 39 of file class.ilCourseInfoFileTableDataRetrieval.php.

                          : void
    {
        if (!count($files = ilCourseFile::_readFilesByCourse($this->course->getId()))) {
            return;
        }
        $this->data = [];
        foreach ($files as $file) {
            $this->data[$file->getFileId()] = $file;
        }
    }