ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilExportContainer Class Reference

Export Container. More...

+ Inheritance diagram for ilExportContainer:
+ Collaboration diagram for ilExportContainer:

Public Member Functions

 __construct (ilExportOptions $eo)
 Constructor. More...
 
 exportObject ($a_type, $a_id, $a_target_release)
 Export a container. More...
 
- Public Member Functions inherited from ilExport
 __construct ()
 Default constructor. More...
 
 getConfig ($a_comp)
 Get configuration (note that configurations are optional, null may be returned!) More...
 
 _getExportFiles ($a_obj_id, $a_export_types="", $a_obj_type="")
 Get Export Files for a repository object. More...
 
 _createExportDirectory ($a_obj_id, $a_export_type="xml", $a_obj_type="")
 Create export directory. More...
 
 _generateIndexFile ($a_filename, $a_obj_id, $a_files, $a_type="")
 Generates an index.html file including links to all xml files included (for container exports) More...
 
 exportObject ($a_type, $a_id, $a_target_release="")
 Export an ILIAS object (the object type must be known by objDefinition) More...
 
 exportEntity ($a_entity, $a_id, $a_target_release, $a_component, $a_title, $a_export_dir, $a_type_for_file="")
 Export an ILIAS entity. More...
 
 processExporter ($a_comp, $a_class, $a_entity, $a_target_release, $a_id)
 Process exporter. More...
 

Protected Member Functions

 manifestWriterBegin ($a_type, $a_id, $a_target_release)
 Write container manifest. More...
 
 addContainer ()
 Add container description. More...
 
 addSubitems ($a_id, $a_type, $a_target_release)
 Add subitems. More...
 
 manifestWriterEnd ($a_type, $a_id, $a_target_release)
 Write manifest footer. More...
 

Private Attributes

 $cont_export_dir = ''
 
 $cont_manifest_writer = null
 
 $eo = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilExport
static _getValidExportSubItems ($a_ref_id)
 Get a list of subitems of a repository resource, that implement the export. More...
 
static _getLastExportFileDate ($a_obj_id, $a_type="", $a_obj_type="")
 Get date of last export file. More...
 
static _getLastExportFileInformation ($a_obj_id, $a_type="", $a_obj_type="")
 Get last export file information. More...
 
static _getExportDirectory ($a_obj_id, $a_type="xml", $a_obj_type="", $a_entity="")
 Get export directory for an repository object. More...
 
- Static Public Attributes inherited from ilExport
static $new_file_structure = array('cat','exc','crs','sess','file','grp','frm', 'usr', 'catr', 'crsr')
 
static $export_implementer = array("tst", "lm", "glo")
 
- Protected Attributes inherited from ilExport
 $configs = array()
 

Detailed Description

Export Container.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 15 of file class.ilExportContainer.php.

Constructor & Destructor Documentation

◆ __construct()

ilExportContainer::__construct ( ilExportOptions  $eo)

Constructor.

Parameters
ilExportOptions$eo
Returns

Definition at line 27 of file class.ilExportContainer.php.

28 {
29 $this->eo = $eo;
30 parent::__construct();
31 }

References $eo.

Member Function Documentation

◆ addContainer()

ilExportContainer::addContainer ( )
protected

Add container description.

Returns

Definition at line 88 of file class.ilExportContainer.php.

89 {
90
91 }

Referenced by exportObject().

+ Here is the caller graph for this function:

◆ addSubitems()

ilExportContainer::addSubitems (   $a_id,
  $a_type,
  $a_target_release 
)
protected

Add subitems.

Parameters
object$a_id
object$a_type
Returns

Definition at line 100 of file class.ilExportContainer.php.

101 {
102 $GLOBALS['ilLog']->write(__METHOD__);
103 $set_number = 1;
104 foreach($this->eo->getSubitemsForExport() as $ref_id)
105 {
106 // get last export file
108
109 $expi = ilExportFileInfo::lookupLastExport($obj_id, 'xml',$a_target_release);
110
111 if(!$expi instanceof ilExportFileInfo)
112 {
113 $GLOBALS['ilLog']->write(__METHOD__.': Cannot find export file for refId '.$ref_id.', type '.ilObject::_lookupType($a_id));
114 continue;
115 }
116
117 $exp_dir = ilExport::_getExportDirectory($obj_id,'xml',ilObject::_lookupType($obj_id));
118 $exp_full = $exp_dir.DIRECTORY_SEPARATOR.$expi->getFilename();
119
120 $GLOBALS['ilLog']->write(__METHOD__.': zip path '.$exp_full);
121
122 // Unzip
123 ilUtil::unzip($exp_full,true,false);
124
125 // create set directory
126 ilUtil::makeDirParents($this->cont_export_dir.DIRECTORY_SEPARATOR.'set_'.$set_number);
127
128 // cut .zip
129 $new_path_rel = 'set_'.$set_number.DIRECTORY_SEPARATOR.$expi->getBasename();
130 $new_path_abs = $this->cont_export_dir.DIRECTORY_SEPARATOR.$new_path_rel;
131
132 $GLOBALS['ilLog']->write(__METHOD__.': '.$new_path_rel.' '.$new_path_abs);
133
134 // Move export
135 rename(
136 $exp_dir.DIRECTORY_SEPARATOR.$expi->getBasename(),
137 $new_path_abs
138 );
139
140 $GLOBALS['ilLog']->write($exp_dir.DIRECTORY_SEPARATOR.$expi->getBasename().' -> '.$new_path_abs);
141
142 // Delete latest container xml of source
143 if($a_id == $obj_id)
144 {
145 $expi->delete();
146 if(file_exists($exp_full))
147 {
148 $GLOBALS['ilLog']->write(__METHOD__.': Deleting'. $exp_full);
149 unlink($exp_full);
150 }
151 }
152
153 $this->cont_manifest_writer->xmlElement(
154 'ExportSet',
155 array(
156 'Path' => $new_path_rel,
157 'Type' => ilObject::_lookupType($obj_id)
158 )
159 );
160
161
162 ++$set_number;
163 }
164 }
@classDescription Stores information of creation date and versions of export files
static lookupLastExport($a_obj_id, $a_type, $a_version='')
Lookup last export.
static _getExportDirectory($a_obj_id, $a_type="xml", $a_obj_type="", $a_entity="")
Get export directory for an repository object.
static _lookupObjId($a_id)
static _lookupType($a_id, $a_reference=false)
lookup object type
static unzip($a_file, $overwrite=false, $a_flat=false)
unzip file
static makeDirParents($a_dir)
Create a new directory and all parent directories.
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
$ref_id
Definition: sahs_server.php:39

References $GLOBALS, $ref_id, ilExport\_getExportDirectory(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilExportFileInfo\lookupLastExport(), ilUtil\makeDirParents(), and ilUtil\unzip().

Referenced by exportObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ exportObject()

ilExportContainer::exportObject (   $a_type,
  $a_id,
  $a_target_release 
)

Export a container.

Parameters
object$a_type
object$a_obj_id
object$a_target_release
Returns

Reimplemented from ilExport.

Definition at line 41 of file class.ilExportContainer.php.

42 {
43 // Create base export directory
44 ilExport::_createExportDirectory($a_id, "xml", $a_type);
45 $export_dir = ilExport::_getExportDirectory($a_id, "xml", $a_type);
46 $ts = time();
47 $sub_dir = $ts."__".IL_INST_ID."__".$a_type."_".$a_id;
48
49 $this->cont_export_dir = $export_dir.DIRECTORY_SEPARATOR.$sub_dir;
50 ilUtil::makeDirParents($this->cont_export_dir);
51
52 $GLOBALS['ilLog']->write(__METHOD__.' using base directory: '.$this->export_run_dir);
53
54 $this->manifestWriterBegin($a_type, $a_id, $a_target_release);
55 $this->addContainer();
56 $this->addSubitems($a_id,$a_type,$a_target_release);
57 $this->manifestWriterEnd($a_type, $a_id, $a_target_release);
58
59 ilUtil::zip($this->cont_export_dir, $this->cont_export_dir.'.zip');
60 ilUtil::delDir($this->cont_export_dir);
61 }
manifestWriterBegin($a_type, $a_id, $a_target_release)
Write container manifest.
addSubitems($a_id, $a_type, $a_target_release)
Add subitems.
manifestWriterEnd($a_type, $a_id, $a_target_release)
Write manifest footer.
addContainer()
Add container description.
_createExportDirectory($a_obj_id, $a_export_type="xml", $a_obj_type="")
Create export directory.
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
static zip($a_dir, $a_file, $compress_content=false)

References $GLOBALS, ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), addContainer(), addSubitems(), ilUtil\delDir(), ilUtil\makeDirParents(), manifestWriterBegin(), manifestWriterEnd(), and ilUtil\zip().

+ Here is the call graph for this function:

◆ manifestWriterBegin()

ilExportContainer::manifestWriterBegin (   $a_type,
  $a_id,
  $a_target_release 
)
protected

Write container manifest.

Returns

Definition at line 67 of file class.ilExportContainer.php.

68 {
69 $GLOBALS['ilLog']->write(__METHOD__.': wrinting manifest');
70 include_once "./Services/Xml/classes/class.ilXmlWriter.php";
71 $this->cont_manifest_writer = new ilXmlWriter();
72 $this->cont_manifest_writer->xmlHeader();
73 $this->cont_manifest_writer->xmlStartTag(
74 'Manifest',
75 array(
76 "MainEntity" => $a_type,
77 "Title" => ilObject::_lookupTitle($a_id),
78 "TargetRelease" => $a_target_release,
79 "InstallationId" => IL_INST_ID,
80 "InstallationUrl" => ILIAS_HTTP_PATH)
81 );
82 }
static _lookupTitle($a_id)
lookup object title
XML writer class.

References $GLOBALS, and ilObject\_lookupTitle().

Referenced by exportObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ manifestWriterEnd()

ilExportContainer::manifestWriterEnd (   $a_type,
  $a_id,
  $a_target_release 
)
protected

Write manifest footer.

Parameters
object$a_type
object$a_id
object$a_target_release
Returns

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

174 {
175 $this->cont_manifest_writer->xmlEndTag('Manifest');
176 $GLOBALS['ilLog']->write(__METHOD__.': '.$this->cont_export_dir.DIRECTORY_SEPARATOR.'manifest.xml');
177 $this->cont_manifest_writer->xmlDumpFile($this->cont_export_dir.DIRECTORY_SEPARATOR.'manifest.xml',true);
178 }

References $GLOBALS.

Referenced by exportObject().

+ Here is the caller graph for this function:

Field Documentation

◆ $cont_export_dir

ilExportContainer::$cont_export_dir = ''
private

Definition at line 17 of file class.ilExportContainer.php.

◆ $cont_manifest_writer

ilExportContainer::$cont_manifest_writer = null
private

Definition at line 18 of file class.ilExportContainer.php.

◆ $eo

ilExportContainer::$eo = null
private

Definition at line 19 of file class.ilExportContainer.php.

Referenced by __construct().


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