ilAdvancedMDRecordExportFiles Class Reference

Collaboration diagram for ilAdvancedMDRecordExportFiles:

Public Member Functions
	__construct (int $a_obj_id=null)
	readFilesInfo ()
	Read files info @access public. More...
	getFiles ()
	Get files. More...
	create (string $a_xml)
	Create new export file from xml string. More...
	deleteByFileId (int $a_timest)
	getAbsolutePathByFileId (int $a_file_basename)

Protected Attributes
string	$export_dir = ''

Private Member Functions
	init ()
	init export directory @access private More...

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Todo:

use logger and filestorage

Definition at line 31 of file class.ilAdvancedMDRecordExportFiles.php.

Constructor & Destructor Documentation

__construct()

ilAdvancedMDRecordExportFiles::__construct

(

int

$a_obj_id = null

)

Definition at line 35 of file class.ilAdvancedMDRecordExportFiles.php.

    {
        $this->export_dir = ilFileUtils::getDataDir() . '/ilAdvancedMetaData/export';
        if ($a_obj_id) {
            $this->export_dir .= "_" . $a_obj_id;
        }
        $this->init();
    }

References ilFileUtils\getDataDir(), and init().

Here is the call graph for this function:

Member Function Documentation

create()

ilAdvancedMDRecordExportFiles::create

(

string

$a_xml

)

Create new export file from xml string.

Definition at line 94 of file class.ilAdvancedMDRecordExportFiles.php.

                                         : void
    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
 
        if (!$fp = fopen($this->export_dir . '/' . time() . '.xml', 'w+')) {
            $ilLog->write(__METHOD__ . ': Cannot open file ' . $this->export_dir . '/' . time() . '.xml');
            throw new ilException('Cannot write export file.');
        }
 
        fwrite($fp, $a_xml);
        fclose($fp);
    }

References $DIC.

deleteByFileId()

ilAdvancedMDRecordExportFiles::deleteByFileId

(

int

$a_timest

)

Definition at line 109 of file class.ilAdvancedMDRecordExportFiles.php.

                                                 : bool
    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
 
        if (!unlink($this->export_dir . '/' . $a_timest . '.xml')) {
            $ilLog->write(__METHOD__ . ': Cannot delete file ' . $this->export_dir . '/' . $a_timest . '.xml');
            return false;
        }
        return true;
    }

References $DIC.

getAbsolutePathByFileId()

ilAdvancedMDRecordExportFiles::getAbsolutePathByFileId

(

int

$a_file_basename

)

Definition at line 122 of file class.ilAdvancedMDRecordExportFiles.php.

                                                                 : string
    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
 
        $a_file_basename = (string) $a_file_basename;
        if (!file_exists($this->export_dir . '/' . $a_file_basename . '.xml')) {
            $ilLog->write(__METHOD__ . ': Cannot find file ' . $this->export_dir . '/' . $a_file_basename . '.xml');
            return '';
        }
        return $this->export_dir . '/' . $a_file_basename . '.xml';
    }

References $DIC.

getFiles()

ilAdvancedMDRecordExportFiles::getFiles

(

)

Get files.

Returns

array<int, array{type: string, size: string}>

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

                              : array
    {
        if (!is_dir($this->export_dir)) {
            return array();
        }
        $files = [];
        foreach (ilFileUtils::getDir($this->export_dir) as $file_name => $file_data) {
            $files[$file_name] = $file_data;
        }
        return $files;
    }

References ilFileUtils\getDir().

Referenced by readFilesInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilAdvancedMDRecordExportFiles::init ( )

private

init export directory @access private

Definition at line 140 of file class.ilAdvancedMDRecordExportFiles.php.

                           : void
    {
        if (!is_dir($this->export_dir)) {
            ilFileUtils::makeDirParents($this->export_dir);
        }
    }

References ilFileUtils\makeDirParents().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

readFilesInfo()

ilAdvancedMDRecordExportFiles::readFilesInfo

(

)

Read files info @access public.

Returns

array array e.g array(records => 'ECS-Server',size => '123',created' => 121212)

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

                                   : array
    {
        $file_info = array();
        foreach ($this->getFiles() as $name => $data) {
            if ($data['type'] != 'file') {
                continue;
            }
            $file_parts = explode('.', $name);
            if (!is_numeric($file_parts[0]) or (strcmp('xml', $file_parts[1]) != 0)) {
                continue;
            }
            $file_info = [];
            $file_info[$file_parts[0]]['size'] = $data['size'];
            $file_info[$file_parts[0]]['date'] = $file_parts[0];
 
            if ($xml = simplexml_load_file($this->export_dir . '/' . $name)) {
                $records = array();
                foreach ($xml->xpath('Record/Title') as $title) {
                    $records[] = (string) $title;
                }
                $file_info[$file_parts[0]]['name'] = $records;
            }
        }
        return $file_info;
    }

References $data, $name, $xml, and getFiles().

Here is the call graph for this function:

Field Documentation

$export_dir

string ilAdvancedMDRecordExportFiles::$export_dir = ''

protected

Definition at line 33 of file class.ilAdvancedMDRecordExportFiles.php.

---

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

• Services/AdvancedMetaData/classes/Record/class.ilAdvancedMDRecordExportFiles.php