Packageindex Classtrees Modulegroups Elementlist Report XML Files
& a C c d D e g h i l m M n N o P p r s S t u V W w x _

&

&getVCSession Function in class VCSessionRegistry
Get VCSession by key
&getVCSession Function in class WorkflowSession
&getDefaultVCSession Function in class VCSessionRegistry
Get default VCSession
&commit Function in class CVSVersionControl
Commits a MgdArchive / updated files to CVS.
&revertToDate Function in class CVSVersionControl
Reverts objects to revisions from an earlier date.
&revertToRevision Function in class CVSVersionControl
Reverts an object to an earlier revision.
&revertToTag Function in class CVSVersionControl
Reverts objects to revisions from a tag.
&getNew Function in class CVSVersionControl
Checks for updates and returns all updates since $sincetime
&getNew Function in class MgdDB
Returns a list of all the new / changed / deleted objects in the DB that have not yet been marked as committed.
&getNamespace Function in class CVSVersionControl
&getNamespace Function in class VCSession
Get the Namespace object (in CVS, a module)
&getBranch Function in class CVSVersionControl
&getBranch Function in class VCSession
Get the Branch object
&_crankOutNewRevs Function in class CVSVersionControl
&_genGuidLists Function in class CVSVersionControl
&_genFileLists Function in class CVSVersionControl
&getCurrentMtime Function in class CVSVersionControl
&getCurrentRevision Function in class CVSVersionControl
&getCurrentRevision Function in class MgdDeepCollection
Returns the revision of the first member that is no MgdDeepCollection itself (if there are any on the root level)
&getMgdPath Function in class WorkflowSession
Get the matching MgdPath for the given path, i.e. the "range" defined in workflow configuration.
&getDbh Function in class VCSession
Get the DB handle of the Midgard DB.
&getGlobDbh Function in class VCSession
Get the DB handle of the global DB (that contains meta-data about objects, collections and workflow data)
&getMgdDB Function in class VCSession
Get the Midgard DB as a MgdDB object.
&getVersionControl Function in class VCSession
Get the VersionControl object.
&getBranchId Function in class VCSession
Get the id of the current branch.
&getBranchLabel Function in class VCSession
Get the id of the current branch.
&getUser Function in class VCSession
Get the current user (guid)
&getOutgoing Function in class VCSession
Get the outgoing directory
&getNewByAuthor Function in class MgdDB
Returns a list of all the new / changed / deleted objects in the DB that have not yet been marked as committed, grouped by author.
&export Function in class MgdDB
Exports objects to a repligard archive.
&brew Function in class MgdArchive
Create a new MgdArchive as $outfile, stuffing together $files
&brew Function in class MgdPart
Static method
&brew Function in class MgdDeepCollection
Static method
&brew Function in class WorkflowProc
Static method
&readDB Function in class MgdArchive
read a db record
&readDBById Function in class MgdArchive
read a db record using primary key
&retrieveNextRevision Function in class MgdPartRevision
Retrieve the next revision after this one, as a MgdPartRevision
&read Function in class MgdPartRevision
Static method
&readById Function in class MgdPartRevision
Static method
&readById Function in class MgdPart
Static method
&readById Function in class MgdDeepCollection
Reads the MgdCollection and all elements from the meta DB.
&readById Function in class WorkflowProc
Static method
&readByGuid Function in class MgdPartRevision
Static method
&readByGuid Function in class MgdPart
Static method
&readByPath Function in class MgdPartRevision
Static method
&readByPath Function in class MgdPart
Static method
&readByGuidRev Function in class MgdPartRevision
Static method
&readByGuidDate Function in class MgdPartRevision
Static method
&listBranchesPresent Function in class MgdPartRevision
&listBranchesPresent Function in class MgdPart
Get branches this objects is on and not deleted, as string
&searchByStatus Function in class MgdPart
Static method
&searchNotCurrent Function in class MgdPart
Static method
&searchNotCurrent Function in class WorkflowProc
Static method
&retrieveRevision Function in class MgdPart
Retrieve the given revision as MgdPartRevision
&searchNewGuids Function in class MgdPart
Static method
&getParents Function in class MgdDeepCollection
Static method
&getDepsUp Function in class MgdDeepCollection
Get the dependencies of all elements of the MgdDeepCollection as a list of guids, not including objects that belong to the collection
&getDepsDown Function in class MgdDeepCollection
Returns the guids of all objects that have belonged / belong to the parts of this collection, not including objects that belong to the collection
&getDepsDownLang Function in class MgdDeepCollection
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
&flatListElements Function in class MgdCollection
Get a list of all MgdParts in this collection, without the sub-collections
&listElements Function in class MgdCollection
Get a list of all elements
&listGuids Function in class MgdCollection
Get the guids of all objects that belong to this MgdCollection (at any level)
&realVcs Function in class MgdVCObject
Check if this is really a VCSession, otherwise replace the argument with the default VCSession
&retrieveComments Function in class MgdVCObject
Get stored comments for this object

a

addLock Function in class PartLockRegistry
Adds a lock for a given PartBranchId.
addVCSession Function in class VCSessionRegistry
Add a VCSession to the global registry
addDefaultVCSession Function in class VCSessionRegistry
Add the VCSession that should be used as a default to the global registry
addElement Function in class MgdCollection
Add an element to the collection.
approveNext Function in class WorkflowProc
Go to next step, if it's the last step, set status to WF_TO_BE_PUBLISHED
approvePrevious Function in class WorkflowProc
Go back to the previous step
addComment Function in class MgdVCObject
Add a comment to the object and store it in the meta-db

C

CVSVersionControl Class CVSVersionControl.
Represents a CVS repository.
CVSVersionControl Function in class CVSVersionControl
CVSNamespace Function in class CVSVersionControl
CVSBranch Function in class CVSVersionControl

c

copyFromToBranch Function in class CVSVersionControl
cvsdo Function in class CVSVersionControl
containsTag Function in class CVSVersionControl
computeDepsUp Function in class MgdDB
Returns a list of objects that this object depends on but do not belong to it.
computeDepsDown Function in class MgdDB
Returns a list of objects that depend on / belong to this object.
computeDepsDownReverse Function in class MgdDB
Returns a list of objects that this object belongs to.
commit Function in class MgdPartRevision
commit Function in class MgdPart
Commits the revision of the Part that is currently in the DB to version control.
cancel Function in class WorkflowProc
Cancel the workflow process
$ctx Variable in Class WorkflowDefObject

d

deleteNamespace Function in class CVSVersionControl
deleteFile Function in class MgdArchive
Delete the MgdArchive on the filesystem.
deleteDB Function in class MgdArchive
delete a db record
$dest Variable in Class MgdPath

D

DBObject Function in class MgdArchive
Create a DBObject.

e

exists_obj Function in class MgdDB

g

getLock Function in class PartLockRegistry
Gets unique-lock-id for a given PartBranchId, if present
getTmpPrivate Function in class CVSVersionControl
getArgLimit Function in class CVSVersionControl
getWcBase Function in class CVSVersionControl
getName Function in class CVSVersionControl
getBranchLabel Function in class WorkflowSession
getUserPath Function in class WorkflowSession
getSpoolerUrl Function in class VCSession
Get the URL of the spooler on this branch
getStatusHandler Function in class VCSession
Get the URL of the global status handler script
getAll Function in class MgdDB
Returns a list of all objects in the DB.
getAuthor Function in class MgdDB
Get the author of an object by guid
get_path_by_guid Function in class MgdDB
Get the path that matches the guid
get_guid_by_path Function in class MgdDB
Get the guid that matches the path
getContents Function in class MgdArchive
Returns the contents of the MgdArchive (raw text)
getFSPath Function in class MgdArchive
Returns the path of this MgdArchive on the filesystem.
getId Function in class MgdArchive
getRevision Function in class MgdPartRevision
Get the revision
getCreated Function in class MgdPartRevision
Get the created date
getPath Function in class MgdPartRevision
Get the path (at this revision)
getPath Function in class MgdPart
Returns the path of this MgdPart
getLastValidPath Function in class MgdPartRevision
Get the last valid path (if deleted or orphaned, still returns a valid path)
getDepsUp Function in class MgdPartRevision
Get the dependencies (links from object fields) as a list of guids
getCollections Function in class MgdPartRevision
Get the ids of all collections this MgdPartRevision belongs to.
getCollectionsRecursive Function in class MgdPartRevision
Get the ids of all collections this MgdPartRevision belongs to directly or indirectly
getProcs Function in class MgdPartRevision
Get the ids of all WorkflowProcs that affected this MgdPartRevision
getPublishedProcs Function in class MgdPartRevision
Returns the ids of all completed WorkflowProcs that affected this MgdPartRevision
getGuid Function in class MgdPartRevision
getGuid Function in class MgdPart
Returns the guid of this MgdPart
getPartId Function in class MgdPartRevision
getPartId Function in class MgdPart
Returns the id of this MgdPart (as in the DB)
getBranchId Function in class MgdPartRevision
getBranchId Function in class MgdPart
Returns the id of the branch this MgdPart is on
getStatus Function in class MgdPartRevision
getStatus Function in class MgdPart
Get the current status of this MgdPart as stored in the DB
getStatus Function in class WorkflowProc
Get the current status as stored in the DB
getPendingAuthor Function in class MgdPartRevision
getPendingAuthor Function in class MgdPart
getDepsDown Function in class MgdPartRevision
getDepsDown Function in class MgdPart
Returns the guids of all objects that have belonged / belong to this MgdPart.
getDepsDownLang Function in class MgdPartRevision
getDepsDownLang Function in class MgdPart
Returns the guids of all objects of language $lang that have belonged / belong to this MgdPart.
getCollectionsAnyRevision Function in class MgdPartRevision
getCollectionsAnyRevision Function in class MgdPart
Returns the ids of all collections this MgdPart has ever belonged to.
getProcsAnyRevision Function in class MgdPartRevision
getProcsAnyRevision Function in class MgdPart
Returns the ids of all WorkflowProcs that have ever affected this MgdPart.
getPublishedProcsAnyRevision Function in class MgdPartRevision
getPublishedProcsAnyRevision Function in class MgdPart
Returns the ids of all WorkflowProcs that have ever affected this MgdPart.
getKiddies Function in class MgdPartRevision
getKiddies Function in class MgdPart
Return all MgdParts below this one, i.e. whose path begins with this path.
getKiddiesByLang Function in class MgdPartRevision
getKiddiesByLang Function in class MgdPart
Return all MgdParts below this one that belong to the language specified
getCurrentRevision Function in class MgdPartRevision
getCurrentRevision Function in class MgdPart
Returns the current revision of the MgdPart
getMissingDeps Function in class WorkflowProc
Get objects (list of guids) that 1) the objects affected by this proc depend on and 2) are not present on the destination branch
getCurrentStep Function in class WorkflowProc
Returns the id of the current step
getCollectionId Function in class WorkflowProc
Returns the id of the MgdCollection that is affected by $this
getProcDefId Function in class WorkflowProc
Returns the id of the ProcDef (blueprint) for this WorkflowProc
getSrc Function in class WorkflowProc
Returns the id of the source branch
getDest Function in class WorkflowProc
Returns the id of the destination branch

h

handleStatus Function in class MgdPartRevision
handleStatus Function in class MgdPart
Handle pending actions, depending on status
handleStatus Function in class WorkflowProc
Do pending actions, based on status
hasApprovePerms Function in class WorkflowProc
Checks if the current user may call next() or previous() when the WorkflowProc is at the step specified.
hasUnPublishPerms Function in class WorkflowProc
Checks if the current user may unpublish this process. This is equivalent to the permission to do the last approve step

i

isOnBranch Function in class CVSVersionControl
import Function in class MgdDB
Imports objects from a repligard archive.
import Function in class MgdPartRevision
import Function in class MgdPart
Imports the version of the Part that is currently in version control into the DB.
importAsNew Function in class MgdDB
Imports objects from a repligard archive and marks them as uncommitted.
importKeepDeleted Function in class MgdDB
Imports objects from a repligard archive, keeping information about deleted objects in the repligard table
is_owner_by_path Function in class MgdDB
Get the owner of the object, by path (can be helpful if the object is no longer present)
isNew Function in class MgdDB
Checks if object is newly created / updated / deleted
isDeleted Function in class MgdPartRevision
Returns true if deleted, false otherwise
isWritable Function in class MgdPartRevision
isWritable Function in class MgdPart
Checks if the MgdPart is writable by the current user.
isLockedBySelf Function in class MgdPartRevision
isLockedBySelf Function in class MgdPart
Checks if the MgdPart is locked by the current script.
isLocked Function in class MgdPartRevision
isLocked Function in class MgdPart
Checks if the MgdPart is locked
$id Variable in Class WorkflowDefObject

l

listNamespaces Function in class CVSVersionControl
listBranches Function in class CVSVersionControl
listBranches Function in class MgdPartRevision
listBranches Function in class MgdPart
Get branches this object is on, as string
listMgdPaths Function in class WorkflowSession
List all MgdPaths defined for the source branch = current branch
listPendingProcs Function in class WorkflowSession
Lists all pending WorkflowProcs for the current user.
listGuids Function in class MgdArchive
Extracts the guids of all objects from the archive.
lock Function in class MgdPartRevision
lock Function in class MgdPart
Locks the MgdPart
listRevisions Function in class MgdPartRevision
listRevisions Function in class MgdPart
Returns all revisions of this part on the current branch. Later revisions come before earlier ones.
listProcDefs Function in class MgdPath

m

makeArchive Function in class CVSVersionControl
Makes an archive out of the current revisions of the objects speicified.
mayDoStepDef Function in class WorkflowSession
Checks permission for the current user to do something with the StepDef

M

MgdDB Class MgdDB.
Represents a Midgard DB.
MgdDB Function in class MgdDB
Construct a MgdDB
MgdArchive Class MgdArchive.
Represents an uncompressed repligard xml archive.
MgdArchive Function in class MgdArchive
Construct a new MgdArchive
MgdPartRevision Class MgdPartRevision.
A revision of an object or object part, on a given branch
MgdPartRevision Function in class MgdPartRevision
Construct a new MgdPartRevision.
MgdPart Class MgdPart.
An object or object part on a given branch
MgdPart Function in class MgdPart
Construct a new MgdPart
MgdDeepCollection Class MgdDeepCollection.
Represents a collection of MgdPartRevisions.
MgdDeepCollection Function in class MgdDeepCollection
Construct a new MgdDeepCollection
MgdCollection Class MgdCollection.
Generic collection for MgdVCObjects with a GUID. Can be nested
MgdCollection Function in class MgdCollection
Construct a new MgdCollection
MgdVCObject Class MgdVCObject.
Represents a "bridge" from DB to CVS.
MgdVCObject Function in class MgdVCObject
Construct a new MgdVCObject.
MgdPath Class MgdPath.
Represents an in the XML config file.
MgdPath Function in class MgdPath

n

notifySpooler Function in class VCSession
Notify the spooler on this branch
notifyStatusHandler Function in class VCSession
Notify the global status handler
$node Variable in Class WorkflowDefObject

N

No Package specified Package

o

$op Variable in Class StepDef

P

PartLockRegistry Class PartLockRegistry.
Global registry for MgdPart locks. On $MgdPart->lock() a unique identifier is placed here and later read to determine if the current script is the locker.
ProcDef Class ProcDef.
Represents a in the XML config file.
ProcDef Function in class ProcDef

p

$procDefs Variable in Class MgdPath
$path Variable in Class MgdPath
$path Variable in Class SubStepDef

r

revertToRevision Function in class MgdPartRevision
revertToRevision Function in class MgdPart
Reverts this part to revision $revision.
revertToDate Function in class MgdPartRevision
revertToDate Function in class MgdPart
Reverts this part to the revision at date $date
revertToTag Function in class MgdPartRevision
revertToTag Function in class MgdPart
Reverts this part to the revision at date $date
recomputePath Function in class MgdPartRevision
recomputePath Function in class MgdPart
Recompute the path for this MgdPart and update recursively
recomputePathSelf Function in class MgdPart
Recompute the path for this MgdPart and update recursively
revertTo Function in class MgdDeepCollection
Revert elements to their revisions
removeElement Function in class MgdCollection
resolveDeps Function in class WorkflowProc
Starts the WorkflowProcs necessary to resolve dependencies or suggests to start them if the current user doesn't have permission

s

su Function in class WorkflowSession
Do stuff as another user. Only root may do that
setExported Function in class MgdDB
Marks this object as exported, or all objects if not specified
setFSPath Function in class MgdArchive
Sets the path of this MgdArchive on the filesystem.
splitInto Function in class MgdArchive
Splits the archive into its parts and puts them into the directory hierarchy
setStatus Function in class MgdPartRevision
setStatus Function in class MgdPart
Set the status
$src Variable in Class MgdPath
$stepDefs Variable in Class ProcDef
$subStepDefs Variable in Class StepDef
$session Variable in Class WorkflowDefObject

S

StepDef Class StepDef.
Represents a in the XML config file.
StepDef Function in class StepDef
SubStepDef Class SubStepDef.
Base class.
SubStepDef Function in class SubStepDef

t

tag Function in class CVSVersionControl
Tag the specified objects.
tag Function in class MgdPartRevision
tag Function in class MgdPart
Tag the current revision
$type Variable in Class StepDef

u

updatePath Function in class MgdPartRevision
Update the path stored in the DB
updatePath Function in class MgdPart
Update the path stored in the DB
unlock Function in class MgdPartRevision
unlock Function in class MgdPart
Unlocks the MgdPart
updatePathRecursive Function in class MgdPartRevision
updatePathRecursive Function in class MgdPart
Update the path stored in the DB, recursively
undo Function in class WorkflowProc
Undo / unpublish
$user_group Variable in Class SubStepDef

V

VCSessionRegistry Class VCSessionRegistry.
Global registry easy access to and reuse of VCSessions (and also WorkflowSessions)
VCSession Class VCSession.
Manages configuration and reuse of db connections, MgdDBs, VersionControl objects.
VCSession Function in class VCSession
Construct a new VCSession.

W

WorkflowSession Class WorkflowSession.
Handles configuration and "global" stuff.
WorkflowSession Function in class WorkflowSession
Construct a WorkflowSession
WorkflowProc Class WorkflowProc.
Represents a Workflow process.
WorkflowProc Function in class WorkflowProc
Construct a new WorkflowProc
WorkflowDefObject Class WorkflowDefObject.
Base class.
WorkflowDefObject Function in class WorkflowDefObject

w

writeDB Function in class MgdArchive
create a db record containing the values currently in $this->_db. $this->_db['id'] is not used.
write Function in class MgdPartRevision
Writes the MgdPartRevision to the DB
write Function in class MgdPart
Write the MgdPart to the DB
write Function in class MgdDeepCollection
Writes the MgdCollection and all elements to the data DB
writeDepsUp Function in class MgdPartRevision
Writes the dependencies of this MgdPartRevision (links from object fields)
writeRevision Function in class MgdPartRevision
writeRevision Function in class MgdPart
Write a new MgdPartRevision for this MgdPart
writeCurrentDepsDown Function in class MgdPartRevision
writeCurrentDepsDown Function in class MgdPart
Add any new sub-parts to the list of objects that belong to this MgdPart and store them in the DB
walkTree Function in class MgdCollection
Call function $func of object $obj with all the MgdParts of this MgdCollection as the first and only parameter

x

$xmlsnipp Variable in Class WorkflowDefObject

_

$_cvsrepos Variable in Class CVSVersionControl
$_cvswcbase Variable in Class CVSVersionControl
$_arglimit Variable in Class CVSVersionControl
$_message Variable in Class CVSVersionControl
$_fsconf Variable in Class CVSVersionControl
$_fsconf Variable in Class MgdDB
$_cvsvc Variable in Class CVSVersionControl
$_namespace Variable in Class CVSVersionControl
$_cvsnsdir Variable in Class CVSVersionControl
$_cvsns Variable in Class CVSVersionControl
$_branch Variable in Class CVSVersionControl
$_branch Variable in Class VCSession
$_branch Variable in Class MgdVCObject
$_cvswc Variable in Class CVSVersionControl
$_confPath Variable in Class WorkflowSession
$_confDoc Variable in Class WorkflowSession
$_confCtx Variable in Class WorkflowSession
$_mgdPaths Variable in Class WorkflowSession
$_mgdUser Variable in Class WorkflowSession
$_mgdUserGuid Variable in Class WorkflowSession
$_mgdGroups Variable in Class WorkflowSession
$_dbh Variable in Class VCSession
$_dbh Variable in Class MgdDB
$_dbh Variable in Class MgdArchive
$_glob_dbh Variable in Class VCSession
$_mgddb Variable in Class VCSession
$_mgddb Variable in Class MgdVCObject
$_vc Variable in Class VCSession
$_vc Variable in Class MgdVCObject
$_nSpace Variable in Class VCSession
$_nSpace Variable in Class MgdVCObject
$_branchid Variable in Class VCSession
$_branchlabel Variable in Class VCSession
$_user Variable in Class VCSession
$_outgoing Variable in Class VCSession
$_conf Variable in Class VCSession
_init_xml_handler Function in class MgdDB
To be called only from the XML parser. Uses the tag and attribute information to fill $_lup and $_ldown with links
$_dbconf Variable in Class MgdDB
$_lup Variable in Class MgdDB
$_ldown Variable in Class MgdDB
$_xmlcontext Variable in Class MgdDB
_checkFSPath Function in class MgdArchive
Checks if this MgdArchive is really a file
$_fpath Variable in Class MgdArchive
$_table Variable in Class MgdArchive
$_table Variable in Class MgdPartRevision
$_table Variable in Class MgdPart
$_table Variable in Class MgdDeepCollection
$_table Variable in Class WorkflowProc
$_db Variable in Class MgdArchive
_copyToBranch Function in class MgdPartRevision
Copies the MgdPartRevision to branch $branch.
_copyToBranch Function in class MgdDeepCollection
Copies the contents of the MgdCollection to another branch
_containsFakeResource Function in class MgdPartRevision
_containsFakeResource Function in class MgdPart
$_part Variable in Class MgdPartRevision
$_guid Variable in Class MgdPart
$_revision Variable in Class MgdPart
$_created Variable in Class MgdPart
$_path Variable in Class MgdPart
$_branchcond Variable in Class MgdPart
$_deleted Variable in Class MgdPart
$_members Variable in Class MgdDeepCollection
$_members Variable in Class MgdCollection
$_guidList Variable in Class MgdDeepCollection
$_guidList Variable in Class MgdCollection
_fillGuidList Function in class MgdCollection
Callback function for internal use.
_setStatus Function in class WorkflowProc
Set the status
_publish Function in class WorkflowProc
Do the publish (internal)
_unpublish Function in class WorkflowProc
Do the unpublish (internal)
_prepare_step Function in class WorkflowProc
For internal use
$_collectionId Variable in Class WorkflowProc
$_stepDefId Variable in Class WorkflowProc
$_procDefId Variable in Class WorkflowProc
$_destId Variable in Class WorkflowProc
$_closed Variable in Class WorkflowProc
$_vcs Variable in Class MgdVCObject
Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta