ilAdvancedMDRecordExportFiles Class Reference

Collaboration diagram for ilAdvancedMDRecordExportFiles:

Public Member Functions
	__construct ($a_obj_id=null)
	Constructor. More...
	readFilesInfo ()
	Read files info. More...
	getFiles ()
	Get files. More...
	create ($a_xml)
	Create new export file from xml string. More...
	deleteByFileId ($a_timest)
	Delete by file id. More...
	getAbsolutePathByFileId ($a_file_basename)
	Get absolut path by file id. More...

Protected Attributes
	$export_dir = ''

Private Member Functions
	init ()
	init export directory More...

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilAdvancedMDRecordExportFiles::__construct

(

$a_obj_id = null

)

Constructor.

public

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

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

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

Here is the call graph for this function:

Member Function Documentation

create()

ilAdvancedMDRecordExportFiles::create

(

$a_xml

)

Create new export file from xml string.

public

Parameters

string

xml presentation

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

References $ilLog, and time.

        {
                 global $ilLog;
                 
                 if(!$fp = @fopen($this->export_dir.'/'.time().'.xml','w+'))
                 {
                        $ilLog->write(__METHOD__.': Cannot open file '.$this->export_dir.'/'.time().'.xml');

                        require_once './Services/Exceptions/classes/class.ilException.php';
                        throw new ilException('Cannot write export file.');
                 }
                 
                 @fwrite($fp,$a_xml);
                 @fclose($fp);
        }

deleteByFileId()

ilAdvancedMDRecordExportFiles::deleteByFileId

(

$a_timest

)

Delete by file id.

public

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

References $ilLog.

        {
                global $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; 
        }

getAbsolutePathByFileId()

ilAdvancedMDRecordExportFiles::getAbsolutePathByFileId

(

$a_file_basename

)

Get absolut path by file id.

public

Parameters

string

basename of file

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

References $ilLog.

        {
                global $ilLog;
                
                if(!@file_exists($this->export_dir.'/'.$a_file_basename.'.xml'))
                {
                        $ilLog->write(__METHOD__.': Cannot find file '.$this->export_dir.'/'.$a_file_basename.'.xml');
                        return false;
                }
                return $this->export_dir.'/'.$a_file_basename.'.xml';
        }

getFiles()

ilAdvancedMDRecordExportFiles::getFiles

(

)

Get files.

public

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

References $files, array, and ilUtil\getDir().

Referenced by readFilesInfo().

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

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilAdvancedMDRecordExportFiles::init ( )

private

init export directory

private

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

References ilUtil\makeDirParents().

Referenced by __construct().

        {
                if(!@is_dir($this->export_dir))
                {
                        ilUtil::makeDirParents($this->export_dir);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

readFilesInfo()

ilAdvancedMDRecordExportFiles::readFilesInfo

(

)

Read files info.

public

Returns

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

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

References $data, $records, $title, array, getFiles(), and string.

        {
                $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_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 ? $file_info : array();
        }

Here is the call graph for this function:

Field Documentation

$export_dir

ilAdvancedMDRecordExportFiles::$export_dir = ''

protected

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

---

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

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