Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/schmitt/local-cvs/midgard-current/workflow/fordoc/MgdArchive.php
DataWorkFlow + DataflowVC -

MgdArchive

MgdArchive

Represents an uncompressed repligard xml archive.

 

private class MgdArchive

Represents an uncompressed repligard xml archive.

 

Public Method Summary

object [unknown]

MgdArchive([ integer $fpath ])

Construct a new MgdArchive

Private Method Summary

bool

_checkFSPath()

Checks if this MgdArchive is really a file
object [unknown]

&brew(array $files, string $outfile)

Create a new MgdArchive as $outfile, stuffing together $files
string

getContents()

Returns the contents of the MgdArchive (raw text)
string

getFSPath()

Returns the path of this MgdArchive on the filesystem.
int

setFSPath(string $fpath)

Sets the path of this MgdArchive on the filesystem.
array

splitInto(string $dir, [ boolean $removeRemoved ])

Splits the archive into its parts and puts them into the directory hierarchy
array

listGuids()

Extracts the guids of all objects from the archive.
int

deleteFile()

Delete the MgdArchive on the filesystem.
void

DBObject( $dbh)

Create a DBObject.
void

writeDB()

create a db record containing the values currently in $this->_db. $this->_db['id'] is not used.
void

&readDB(object [unknown] &$dbh, string $table, array $db, [ integer $constraints ])

read a db record
void

&readDBById(object [unknown] &$dbh, string $table, int $id)

read a db record using primary key
void

deleteDB(integer $id)

delete a db record
void

getId()

Warning: documentation is missing.

Private Field Summary

unknown

$_fpath

unknown

$_dbh

unknown

$_table

unknown

$_db

Public Method Details

MgdArchive

public object [unknown] MgdArchive( [ integer $fpath ] )

  Construct a new MgdArchive

Parameter
integer $fpath = >>0<<
where it is on the filesystem
Returns object [unknown] $newArchive


Private Method Details

_checkFSPath

private bool _checkFSPath( )

  Checks if this MgdArchive is really a file

Returns bool $isPresent


&brew

private object [unknown] &brew( array $files, string $outfile )

  Create a new MgdArchive as $outfile, stuffing together $files
Can be used as static method

Parameter
array $files
string $outfile
Returns object [unknown] $newArchive


getContents

private string getContents( )

  Returns the contents of the MgdArchive (raw text)

Returns string $contents

the contents of the XMLArchive


getFSPath

private string getFSPath( )

  Returns the path of this MgdArchive on the filesystem.

Returns string $path

the path


setFSPath

private int setFSPath( string $fpath )

  Sets the path of this MgdArchive on the filesystem.

Parameter
string $fpath
the path
Returns int $code


splitInto

private array splitInto( string $dir, [ boolean $removeRemoved ] )

  Splits the archive into its parts and puts them into the directory hierarchy

Parameter
string $dir
the root of the directory hierarchy
boolean $removeRemoved = >>false<<
if the xml dump for the deleted objects should be removed (optional, default false)
Returns array $guidList

if not removeRemoved (default): guids of all objects in the archive
if removeRemoved: all => the guids of all objects in the archive,
removed => the removed objects


listGuids

private array listGuids( )

  Extracts the guids of all objects from the archive.

Returns array $guidList

the guids of all the objects contained in the archive


deleteFile

private int deleteFile( )

  Delete the MgdArchive on the filesystem.

Returns int $statuscode


DBObject

private void DBObject( $dbh )

  Create a DBObject.

Parameter
$dbh
Warning: documentation is missing.
Returns void


writeDB

private void writeDB( )

  create a db record containing the values currently in $this->_db. $this->_db['id'] is not used.

Returns void


&readDB

private void &readDB( object [unknown] &$dbh, string $table, array $db, [ integer $constraints ] )

  read a db record

Parameter
object [unknown] &$dbh
the db handle
string $table
array $db
WHERE fields => values
integer $constraints = >>0<<
(optional) additional constraints in SQL
return array $db the record
Returns void


&readDBById

private void &readDBById( object [unknown] &$dbh, string $table, int $id )

  read a db record using primary key

Parameter
object [unknown] &$dbh
the db handle
string $table
int $id
return array $db the record
Returns void


deleteDB

private void deleteDB( integer $id )

  delete a db record

Parameter
integer $id
Warning: documentation is missing.
Returns void


getId

private void getId( )

 

Warning: documentation is missing.

Returns void


Private Field Details

$_fpath

private unknown $_fpath

>><<



$_dbh

private unknown $_dbh

>><<



$_table

private unknown $_table

>><<



$_db

private unknown $_db

>><<




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta