ilPRGMemberExport Class Reference

export assignments of PRG More...

Collaboration diagram for ilPRGMemberExport:

Public Member Functions
	__construct (protected int $prg_ref_id, protected int $prg_obj_id, protected ilStudyProgrammeUserTable $prg_user_table, protected ilUserFormSettings $settings, protected ilLanguage $lng, protected DataFactory $data_factory)
	create (int $type, string $filename)
	getCSVString ()

Data Fields
const	EXPORT_CSV = 1
const	EXPORT_EXCEL = 2

Protected Member Functions
	createExcel ()
	createCSV ()
	write ()
	writeData (array $fields, array $data)
	writeRow (array $values)
	writeCSVRow (array $values)
	writeExcelRow (array $values)

Protected Attributes
int	$export_type
	$writer
int	$current_row = 0

Detailed Description

export assignments of PRG

Definition at line 26 of file ilPRGMemberExport.php.

Constructor & Destructor Documentation

__construct()

ilPRGMemberExport::__construct	(	protected int	$prg_ref_id,
		protected int	$prg_obj_id,
		protected ilStudyProgrammeUserTable	$prg_user_table,
		protected ilUserFormSettings	$settings,
		protected ilLanguage	$lng,
		protected DataFactory	$data_factory
	)

Definition at line 40 of file ilPRGMemberExport.php.

      {
    }

Member Function Documentation

create()

ilPRGMemberExport::create	(	int	$type,
		string	$filename
	)

Definition at line 50 of file ilPRGMemberExport.php.

    {
        switch ($type) {
            case self::EXPORT_CSV:
                $this->writer = $this->createCSV();
                $this->write();
                break;
            case self::EXPORT_EXCEL:
                $this->writer = $this->createExcel();
                $this->write();
                $this->writer->writeToFile($filename);
                break;
            default:
                throw new Exception('Unknown type for export' . $this->export_type);
        }
    }

References $filename, createCSV(), createExcel(), EXPORT_CSV, EXPORT_EXCEL, and write().

Here is the call graph for this function:

createCSV()

ilPRGMemberExport::createCSV ( )

protected

Definition at line 74 of file ilPRGMemberExport.php.

                                  : ilCSVWriter
    {
        return new ilCSVWriter();
    }

Referenced by create().

Here is the caller graph for this function:

createExcel()

ilPRGMemberExport::createExcel ( )

protected

Definition at line 67 of file ilPRGMemberExport.php.

                                    : ilExcel
    {
        $writer = new ilExcel();
        $writer->addSheet($this->lng->txt("assignments"));
        return $writer;
    }

References $writer, and ILIAS\Repository\lng().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

getCSVString()

ilPRGMemberExport::getCSVString

(

)

Definition at line 79 of file ilPRGMemberExport.php.

                                  : ?string
    {
        if ($this->writer instanceof ilCSVWriter) {
            return $this->writer->getCSVString();
        }
        return null;
    }

write()

ilPRGMemberExport::write ( )

protected

Definition at line 87 of file ilPRGMemberExport.php.

                              : void
    {
        foreach ($this->prg_user_table->getColumns($this->prg_obj_id, true) as $user_table_field) {
            [$f_id, $f_title] = $user_table_field;
            if ($this->settings->enabled($f_id)) {
                $fields[$f_id] = $f_title;
            }
        }
        $this->writeRow(array_values($fields));
 
        $order = $this->data_factory->order('login', 'ASC');
        $data = $this->prg_user_table->fetchData($this->prg_obj_id, null, $order);
        $this->writeData(array_keys($fields), $data);
    }

References $data, ILIAS\Repository\settings(), writeData(), and writeRow().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

writeCSVRow()

ilPRGMemberExport::writeCSVRow ( array  $values )

protected

Definition at line 187 of file ilPRGMemberExport.php.

    {
        foreach ($values as $val) {
            $this->writer->addColumn($val);
        }
        $this->writer->addRow();
    }

Referenced by writeRow().

Here is the caller graph for this function:

writeData()

ilPRGMemberExport::writeData ( array  $fields, array  $data  )

protected

Parameters

string[]	$fields
ilStudyProgrammeUserTableRow[]	$data

Definition at line 106 of file ilPRGMemberExport.php.

                                                            : void
    {
        foreach ($data as $usr_row) {
            $row = [];
            //$usr_data = ilObjUser::_lookupFields($usr_row->getUsrId());
 
            foreach ($fields as $f_id) {
                switch ($f_id) {
                    case 'name':
                        $row[] = $usr_row->getFirstname() . $usr_row->getLastname();
                        break;
                    case 'login':
                        $row[] = $usr_row->getLogin();
                        break;
                    case 'prg_orgus':
                        $row[] = $usr_row->getOrgUs();
                        break;
                    case 'prg_status':
                        $row[] = $usr_row->getStatus();
                        break;
                    case 'prg_completion_date':
                        $row[] = $usr_row->getCompletionDate();
                        break;
                    case 'prg_completion_by':
                        $row[] = $usr_row->getCompletionBy();
                        break;
                    case 'points':
                        $row[] = $usr_row->getPointsReachable();
                        break;
                    case 'points_required':
                        $row[] = $usr_row->getPointsRequired();
                        break;
                    case 'points_current':
                        $row[] = $usr_row->getPointsCurrent();
                        break;
                    case 'prg_custom_plan':
                        $row[] = $usr_row->getCustomPlan();
                        break;
                    case 'prg_belongs_to':
                        $row[] = $usr_row->getBelongsTo();
                        break;
                    case 'prg_assign_date':
                        $row[] = $usr_row->getAssignmentDate();
                        break;
                    case 'prg_assigned_by':
                        $row[] = $usr_row->getAssignmentBy();
                        break;
                    case 'prg_deadline':
                        $row[] = $usr_row->getDeadline();
                        break;
                    case 'prg_expiry_date':
                        $row[] = $usr_row->getExpiryDate();
                        break;
                    case 'prg_validity':
                        $row[] = $usr_row->getValidity();
                        break;
                    case 'active':
                        $row[] = $usr_row->getUserActive();
                        break;
                    default:
                        $row[] = $usr_row->getUserData($f_id);
                }
            }
 
            $this->writeRow($row);
        }
    }

References $data, and writeRow().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeExcelRow()

ilPRGMemberExport::writeExcelRow ( array  $values )

protected

Definition at line 195 of file ilPRGMemberExport.php.

    {
        $this->current_row++;
        $current_col = 0;
        foreach ($values as $val) {
            $this->writer->setCell($this->current_row, $current_col, $val);
            $current_col++;
        }
    }

Referenced by writeRow().

Here is the caller graph for this function:

writeRow()

ilPRGMemberExport::writeRow ( array  $values )

protected

Parameters

string[]

$values

Definition at line 177 of file ilPRGMemberExport.php.

    {
        if ($this->writer instanceof ilCSVWriter) {
            $this->writeCSVRow($values);
        }
        if ($this->writer instanceof ilExcel) {
            $this->writeExcelRow($values);
        }
    }

References writeCSVRow(), and writeExcelRow().

Referenced by write(), and writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$current_row

int ilPRGMemberExport::$current_row = 0

protected

Definition at line 38 of file ilPRGMemberExport.php.

$export_type

int ilPRGMemberExport::$export_type

protected

Definition at line 31 of file ilPRGMemberExport.php.

$writer

ilPRGMemberExport::$writer

protected

Definition at line 36 of file ilPRGMemberExport.php.

Referenced by createExcel().

EXPORT_CSV

const ilPRGMemberExport::EXPORT_CSV = 1

Definition at line 28 of file ilPRGMemberExport.php.

Referenced by create(), ilPRGMembersExportGUI\export(), and ilPRGMembersExportGUI\exportAssignments().

EXPORT_EXCEL

const ilPRGMemberExport::EXPORT_EXCEL = 2

Definition at line 29 of file ilPRGMemberExport.php.

Referenced by create(), and ilPRGMembersExportGUI\exportExcel().

---

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

• components/ILIAS/StudyProgramme/classes/memberexport/ilPRGMemberExport.php