Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

MgdDeepCollection

MgdVCObject
   |
  +-- MgdCollection
     |
    +-- MgdDeepCollection

Represents a collection of MgdPartRevisions.

 

private class MgdDeepCollection extends MgdCollection

Represents a collection of MgdPartRevisions.

 

Methods inherited from MgdCollection

mgdcollection, _fillguidlist, addelement, &flatlistelements, &listelements, &listguids, walktree, removeelement

Methods inherited from MgdVCObject

mgdvcobject, &realvcs, addcomment, &retrievecomments

Public Method Summary

void

MgdDeepCollection(array $db, array $downIds, array $pbrIds, [ integer $vcs ])

Construct a new MgdDeepCollection

Private Method Summary

void

&brew(string $spec, [ integer $mode, integer $vcs ])

Static method
array

&getParents(int $id, [ integer $vcs ])

Static method
array

&getDepsUp()

Get the dependencies of all elements of the MgdDeepCollection as a list of guids, not including objects that belong to the collection
array

&getDepsDown()

Returns the guids of all objects that have belonged / belong to the parts of this collection, not including objects that belong to the collection
array

&getDepsDownLang([ integer $lang ])

Returns the guids of all objects of language $lang that have belonged / belong to the parts of this collection, not including objects that belong to the collection
string

&getCurrentRevision()

Returns the revision of the first member that is no MgdDeepCollection itself (if there are any on the root level)
void

_copyToBranch(string $branch, integer $revision)

Copies the contents of the MgdCollection to another branch
void

&readById(int $id, integer $vcs)

Reads the MgdCollection and all elements from the meta DB.
void

revertTo()

Revert elements to their revisions
void

write([ integer $up ])

Writes the MgdCollection and all elements to the data DB

Fields inherited from MgdVCObject

$_vcs, $_mgddb, $_vc, $_nspace, $_branch

Private Field Summary

unknown

$_members

unknown

$_guidList

string

$_table

Public Method Details

MgdDeepCollection

public void MgdDeepCollection( array $db, array $downIds, array $pbrIds, [ integer $vcs ] )

  Construct a new MgdDeepCollection

Parameter
array $db
the new contents of the fields, name => value (id, up)
array $downIds
ids of the child MgdDeepCollections or 0
array $pbrIds
ids of the child MgdPartRevisions or 0
integer $vcs = >>0<<
(optional) omit if you want to use the default VCSession
Returns void


Private Method Details

&brew

private void &brew( string $spec, [ integer $mode, integer $vcs ] )

  Static method
Create a new MgdDeepCollection, starting from a root part

Parameter
string $spec
path or guid of the root part
integer $mode = >>0<<
(optional) specifies which revision to use and which child parts to add
revision => this revision (root part) default: latest revision
date => revision no later than date (root part) overrides revision
scope => all: all parts that belong to the object (default); metaonly: only the root part, contentonly: without root part
lang => all: any language (default) XXlangcode: only parts of this language
recursive => yes: include children not belonging to the object itself (per path) no: don't (default)
integer $vcs = >>0<<
(optional) omit if you want to use the default VCSession
Returns void


&getParents

private array &getParents( int $id, [ integer $vcs ] )

  Static method
Gets all parent collections for a given collection

Parameter
int $id
the collection id
integer $vcs = >>0<<
(optional) omit if you want to use the default VCSession
Returns array $parents


&getDepsUp

private array &getDepsUp( )

  Get the dependencies of all elements of the MgdDeepCollection as a list of guids, not including objects that belong to the collection

Returns array

guid []


&getDepsDown

private array &getDepsDown( )

  Returns the guids of all objects that have belonged / belong to the parts of this collection, not including objects that belong to the collection

Returns array $guid


&getDepsDownLang

private array &getDepsDownLang( [ integer $lang ] )

  Returns the guids of all objects of language $lang that have belonged / belong to the parts of this collection, not including objects that belong to the collection

Parameter
integer $lang = >>0<<
Returns array $guid


&getCurrentRevision

private string &getCurrentRevision( )

  Returns the revision of the first member that is no MgdDeepCollection itself (if there are any on the root level)

Returns string $revision


_copyToBranch

private void _copyToBranch( string $branch, integer $revision )

  Copies the contents of the MgdCollection to another branch

Parameter
string $branch
the branch
integer $revision
Warning: documentation is missing.
Returns void


&readById

private void &readById( int $id, integer $vcs )

  Reads the MgdCollection and all elements from the meta DB.

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


revertTo

private void revertTo( )

  Revert elements to their revisions

Returns void


write

private void write( [ integer $up ] )

  Writes the MgdCollection and all elements to the data DB

Parameter
integer $up = >>0<<
(optional) the parent collection
Returns void


Private Field Details

$_members

private unknown $_members

>><<



$_guidList

private unknown $_guidList

>><<



$_table

private string $_table

>>DEEP_COLLECTION_TABLE<<




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta