Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

MgdCollection

MgdVCObject
   |
  +-- MgdCollection

Generic collection for MgdVCObjects with a GUID. Can be nested

 

private class MgdCollection extends MgdVCObject

Generic collection for MgdVCObjects with a GUID. Can be nested

 
Direct known subclasses: MgdDeepCollection

Methods inherited from MgdVCObject

mgdvcobject, &realvcs, addcomment, &retrievecomments

Public Method Summary

object [unknown]

MgdCollection([ integer $vcs ])

Construct a new MgdCollection

Private Method Summary

void

_fillGuidList( $part)

Callback function for internal use.
bool

addElement(Object &$element)

Add an element to the collection.
array

&flatListElements()

Get a list of all MgdParts in this collection, without the sub-collections
array

&listElements()

Get a list of all elements
array

&listGuids()

Get the guids of all objects that belong to this MgdCollection (at any level)
void

walkTree(string $func, object [unknown] &$obj)

Call function $func of object $obj with all the MgdParts of this MgdCollection as the first and only parameter
void

removeElement( &$element)

Warning: documentation is missing.

Fields inherited from MgdVCObject

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

Private Field Summary

unknown

$_members

unknown

$_guidList

Public Method Details

MgdCollection

public object [unknown] MgdCollection( [ integer $vcs ] )

  Construct a new MgdCollection

Parameter
integer $vcs = >>0<<
(optional) omit if you want to use the default VCSession
Returns object [unknown] $mgdCollection


Private Method Details

_fillGuidList

private void _fillGuidList( $part )

  Callback function for internal use.

Parameter
$part
Warning: documentation is missing.
Returns void


addElement

private bool addElement( Object &$element )

  Add an element to the collection.

Parameter
Object &$element
the new element
Returns bool $ok


&flatListElements

private array &flatListElements( )

  Get a list of all MgdParts in this collection, without the sub-collections

Returns array $elements


&listElements

private array &listElements( )

  Get a list of all elements

Returns array $elements


&listGuids

private array &listGuids( )

  Get the guids of all objects that belong to this MgdCollection (at any level)

Returns array $guids

all the objects


walkTree

private void walkTree( string $func, object [unknown] &$obj )

  Call function $func of object $obj with all the MgdParts of this MgdCollection as the first and only parameter

Parameter
string $func
the name of the function
object [unknown] &$obj
the object
Returns void


removeElement

private void removeElement( &$element )

 

Warning: documentation is missing.

Parameter
&$element
Warning: documentation is missing.
Returns void


Private Field Details

$_members

private unknown $_members

>><<



$_guidList

private unknown $_guidList

>><<




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta