Docs For Class XMLExporter

Description

Exports into XML for use with the XML Importer

version: $Id: XMLExporter.class.php,v 1.13 2007/09/19 14:04:44 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 10/17/05

Located in /polyphony/main/library/Exporter/XMLExporter.class.php (line 27)

Direct descendents

Class	Description
XMLAssetExporter	Exports into XML for use with the XML Importer
XMLRepositoryExporter	Exports into XML for use with the XML Importer

Method Summary

XMLExporter XMLExporter ()

string compressWithStatus ()

void exportAll ()

<##> exportRepositories ()

string getTarKey (string $extension)

boolean is_process_running (integer $PID)

integer numFiles (string $dir)

integer run_in_background (string $Command, integer $Priority, [string $outputFile = '/dev/null'])

void setupSelf ()

void setupXML (string $dir)

void withCompression (string $compression, [mixed $class = 'XMLExporter'])

Methods

Constructor XMLExporter (line 35)

Constructor

since: 10/17/05
access: public

XMLExporter XMLExporter ()

compressWithStatus (line 165)

Compress a directory with status stars. Return the resulting file path

return: the new archive path.
since: 12/12/06
access: public
static:

string compressWithStatus ()

exportAll (line 102)

Exporter of All things

since: 10/17/05
access: public

void exportAll ()

exportRepositories (line 140)

Exporter of repositories

Adds repositoryfile elements to the xml, which pass off to individual repository Importers.

since: 10/17/05
access: public

<##> exportRepositories ()

getTarKey (line 87)

finds the appropriate key for Archive_Tar

since: 10/31/05
access: public

string getTarKey (string $extension)

string $extension

is_process_running (line 234)

Verifies if a process is running in linux

Posted to PHP.net by jesuse.gonzalez@venalum.com.ve on 15-Jul-2005 11:34 Inclusion into this class by Adam Franco.

since: 12/13/06
access: public

boolean is_process_running (integer $PID)

integer $PID

numFiles (line 249)

Return the number of files in a directory (recursively) including the directory its self;

since: 12/12/06
access: public

integer numFiles (string $dir)

string $dir

run_in_background (line 214)

Run linux command in background and return the PID created by the OS

Posted to PHP.net by jesuse.gonzalez@venalum.com.ve on 15-Jul-2005 11:34 Addition of output file parameter and inclusion into this class by Adam Franco

since: 12/13/06
access: public

integer run_in_background (string $Command, integer $Priority, [string $outputFile = '/dev/null'])

string $Command
integer $Priority
string $outputFile

setupSelf (line 45)

Creates the child lists

since: 10/31/05
access: public

void setupSelf ()

Redefined in descendants as:

XMLAssetExporter::setupSelf() : Creates the child lists
XMLRepositoryExporter::setupSelf() : Creates the child lists

setupXML (line 125)

creates xmlfile and initializes it

since: 10/31/05
access: public

void setupXML (string $dir)

string $dir: the directory in which the xml file resides

withCompression (line 58)

Initializes the export by creating a dir in /tmp/

since: 10/31/05
access: public

void withCompression (string $compression, [mixed $class = 'XMLExporter'])

string $compression

Redefined in descendants as:

XMLAssetExporter::withCompression() : Constructor for starting an export
XMLRepositoryExporter::withCompression() : Constructor for starting an export