Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

MgdPartRevision

MgdVCObject
   |
  +-- MgdPartRevision

A revision of an object or object part, on a given branch

 

private class MgdPartRevision extends MgdVCObject

A revision of an object or object part, on a given branch

 

Methods inherited from MgdVCObject

mgdvcobject, &realvcs, addcomment, &retrievecomments

Public Method Summary

void

MgdPartRevision(array $db, [ integer $vcs ])

Construct a new MgdPartRevision.

Private Method Summary

void

getRevision()

Get the revision
void

getCreated()

Get the created date
void

getPath()

Get the path (at this revision)
void

getLastValidPath()

Get the last valid path (if deleted or orphaned, still returns a valid path)
void

isDeleted()

Returns true if deleted, false otherwise
void

getDepsUp()

Get the dependencies (links from object fields) as a list of guids
array

getCollections()

Get the ids of all collections this MgdPartRevision belongs to.
array

getCollectionsRecursive()

Get the ids of all collections this MgdPartRevision belongs to directly or indirectly
array

getProcs()

Get the ids of all WorkflowProcs that affected this MgdPartRevision
array

getPublishedProcs()

Returns the ids of all completed WorkflowProcs that affected this MgdPartRevision
object [unknown]

&retrieveNextRevision()

Retrieve the next revision after this one, as a MgdPartRevision
object [unknown]

&read(array $db, [ integer $vcs, integer $constraints ])

Static method
object [unknown]

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

Static method
object [unknown]

&readByGuid(string $guid, [ integer $vcs ])

Static method
object [unknown]

&readByPath(string $path, [ integer $vcs ])

Static method
object [unknown]

&readByGuidRev(string $guid, string $revision, [ integer $vcs ])

Static method
object [unknown]

&readByGuidDate(string $guid, int $date, [ integer $vcs ])

Static method
void

write()

Writes the MgdPartRevision to the DB
void

writeDepsUp()

Writes the dependencies of this MgdPartRevision (links from object fields)
array

_copyToBranch(string $branch)

Copies the MgdPartRevision to branch $branch.
void

updatePath(string $path)

Update the path stored in the DB
void

_containsFakeResource( $path)

void

handleStatus()

Warning: documentation is missing.
void

isWritable(boolean $doNotWarn)

Warning: documentation is missing.
void

writeRevision( $revision, string $authorfrom, integer $author)

Warning: documentation is missing.
void

commit(integer $author)

Warning: documentation is missing.
void

import(integer $author, integer $revision)

Warning: documentation is missing.
void

tag( $tag)

Warning: documentation is missing.
void

isLockedBySelf()

Warning: documentation is missing.
void

isLocked()

Warning: documentation is missing.
void

lock()

Warning: documentation is missing.
void

unlock()

Warning: documentation is missing.
void

getGuid()

Warning: documentation is missing.
void

getPartId()

Warning: documentation is missing.
void

getBranchId()

Warning: documentation is missing.
void

getStatus()

Warning: documentation is missing.
void

getPendingAuthor()

Warning: documentation is missing.
void

setStatus( $status, integer $pendingAuthor)

Warning: documentation is missing.
void

getDepsDown()

Warning: documentation is missing.
void

getDepsDownLang(integer $lang)

Warning: documentation is missing.
void

getCollectionsAnyRevision()

Warning: documentation is missing.
void

getProcsAnyRevision()

Warning: documentation is missing.
void

getPublishedProcsAnyRevision()

Warning: documentation is missing.
void

getKiddies()

Warning: documentation is missing.
void

getKiddiesByLang( $lang)

Warning: documentation is missing.
void

getCurrentRevision()

Warning: documentation is missing.
void

listBranches()

Warning: documentation is missing.
void

&listBranchesPresent()

Warning: documentation is missing.
void

listRevisions()

Warning: documentation is missing.
void

revertToRevision( $revision)

Warning: documentation is missing.
void

revertToDate( $date)

Warning: documentation is missing.
void

revertToTag( $tag)

Warning: documentation is missing.
void

writeCurrentDepsDown()

Warning: documentation is missing.
void

updatePathRecursive( $path, integer $mode)

Warning: documentation is missing.
void

recomputePath()

Warning: documentation is missing.

Fields inherited from MgdVCObject

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

Private Field Summary

unknown

$_part

string

$_table

Public Method Details

MgdPartRevision

public void MgdPartRevision( array $db, [ integer $vcs ] )

  Construct a new MgdPartRevision.

Parameter
array $db
the new contents of the fields, name => value
integer $vcs = >>0<<
the VCSession (optional) omit if you want to use the default VCSession
Returns void


Private Method Details

getRevision

private void getRevision( )

  Get the revision
return string $revision

Returns void


getCreated

private void getCreated( )

  Get the created date
return string $created

Returns void


getPath

private void getPath( )

  Get the path (at this revision)
return string $path

Returns void


getLastValidPath

private void getLastValidPath( )

  Get the last valid path (if deleted or orphaned, still returns a valid path)
return string $path

Returns void


isDeleted

private void isDeleted( )

  Returns true if deleted, false otherwise
return bool $deleted

Returns void


getDepsUp

private void getDepsUp( )

  Get the dependencies (links from object fields) as a list of guids
return array $guid

Returns void


getCollections

private array getCollections( )

  Get the ids of all collections this MgdPartRevision belongs to.

Returns array $collectionIds


getCollectionsRecursive

private array getCollectionsRecursive( )

  Get the ids of all collections this MgdPartRevision belongs to directly or indirectly

Returns array $collectionIds


getProcs

private array getProcs( )

  Get the ids of all WorkflowProcs that affected this MgdPartRevision

Returns array $wfProcIds


getPublishedProcs

private array getPublishedProcs( )

  Returns the ids of all completed WorkflowProcs that affected this MgdPartRevision

Returns array $wfProcIds


&retrieveNextRevision

private object [unknown] &retrieveNextRevision( )

  Retrieve the next revision after this one, as a MgdPartRevision

Returns object [unknown] $mgdPartRevision


&read

private object [unknown] &read( array $db, [ integer $vcs, integer $constraints ] )

  Static method
Construct a MgdPartRevision from the DB using the fields and values in $db and the string $constraints as constraints

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


&readById

private object [unknown] &readById( int $id, [ integer $vcs ] )

  Static method
Construct a MgdPartRevision from the DB by id

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


&readByGuid

private object [unknown] &readByGuid( string $guid, [ integer $vcs ] )

  Static method
Construct a MgdPartRevision from the DB by guid. Takes the newest one for this guid and branch

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


&readByPath

private object [unknown] &readByPath( string $path, [ integer $vcs ] )

  Static method
Construct a MgdPartRevision from the DB by path. Takes the latest one for this path and branch

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


&readByGuidRev

private object [unknown] &readByGuidRev( string $guid, string $revision, [ integer $vcs ] )

  Static method
Construct a MgdPartRevision from the DB by guid and revision. This identifies MgdPartRevisions uniquely per branch

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


&readByGuidDate

private object [unknown] &readByGuidDate( string $guid, int $date, [ integer $vcs ] )

  Static method
Construct a MgdPartRevision from the DB by guid and date. Takes the latest one no lates than date

Parameter
string $guid
int $date
(UNIX timestamp)
integer $vcs = >>0<<
(optional) omit if you want to use the default VCSession
Returns object [unknown] $mgdPartRevision


write

private void write( )

  Writes the MgdPartRevision to the DB

Returns void


writeDepsUp

private void writeDepsUp( )

  Writes the dependencies of this MgdPartRevision (links from object fields)

Returns void


_copyToBranch

private array _copyToBranch( string $branch )

  Copies the MgdPartRevision to branch $branch.

Parameter
string $branch
the branch where it should go
Returns array $guids

all objects that have changed on the other branch


updatePath

private void updatePath( string $path )

  Update the path stored in the DB

Parameter
string $path
Returns void


_containsFakeResource

private void _containsFakeResource( $path )

 

Parameter
$path
Warning: documentation is missing.
Returns void


handleStatus

private void handleStatus( )

 

Warning: documentation is missing.

Returns void


isWritable

private void isWritable( boolean $doNotWarn )

 

Warning: documentation is missing.

Parameter
boolean $doNotWarn
Warning: documentation is missing.
Returns void


writeRevision

private void writeRevision( $revision, string $authorfrom, integer $author )

 

Warning: documentation is missing.

Parameter
$revision
Warning: documentation is missing.
string $authorfrom
Warning: documentation is missing.
integer $author
Warning: documentation is missing.
Returns void


commit

private void commit( integer $author )

 

Warning: documentation is missing.

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


import

private void import( integer $author, integer $revision )

 

Warning: documentation is missing.

Parameter
integer $author
Warning: documentation is missing.
integer $revision
Warning: documentation is missing.
Returns void


tag

private void tag( $tag )

 

Warning: documentation is missing.

Parameter
$tag
Warning: documentation is missing.
Returns void


isLockedBySelf

private void isLockedBySelf( )

 

Warning: documentation is missing.

Returns void


isLocked

private void isLocked( )

 

Warning: documentation is missing.

Returns void


lock

private void lock( )

 

Warning: documentation is missing.

Returns void


unlock

private void unlock( )

 

Warning: documentation is missing.

Returns void


getGuid

private void getGuid( )

 

Warning: documentation is missing.

Returns void


getPartId

private void getPartId( )

 

Warning: documentation is missing.

Returns void


getBranchId

private void getBranchId( )

 

Warning: documentation is missing.

Returns void


getStatus

private void getStatus( )

 

Warning: documentation is missing.

Returns void


getPendingAuthor

private void getPendingAuthor( )

 

Warning: documentation is missing.

Returns void


setStatus

private void setStatus( $status, integer $pendingAuthor )

 

Warning: documentation is missing.

Parameter
$status
Warning: documentation is missing.
integer $pendingAuthor
Warning: documentation is missing.
Returns void


getDepsDown

private void getDepsDown( )

 

Warning: documentation is missing.

Returns void


getDepsDownLang

private void getDepsDownLang( integer $lang )

 

Warning: documentation is missing.

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


getCollectionsAnyRevision

private void getCollectionsAnyRevision( )

 

Warning: documentation is missing.

Returns void


getProcsAnyRevision

private void getProcsAnyRevision( )

 

Warning: documentation is missing.

Returns void


getPublishedProcsAnyRevision

private void getPublishedProcsAnyRevision( )

 

Warning: documentation is missing.

Returns void


getKiddies

private void getKiddies( )

 

Warning: documentation is missing.

Returns void


getKiddiesByLang

private void getKiddiesByLang( $lang )

 

Warning: documentation is missing.

Parameter
$lang
Warning: documentation is missing.
Returns void


getCurrentRevision

private void getCurrentRevision( )

 

Warning: documentation is missing.

Returns void


listBranches

private void listBranches( )

 

Warning: documentation is missing.

Returns void


&listBranchesPresent

private void &listBranchesPresent( )

 

Warning: documentation is missing.

Returns void


listRevisions

private void listRevisions( )

 

Warning: documentation is missing.

Returns void


revertToRevision

private void revertToRevision( $revision )

 

Warning: documentation is missing.

Parameter
$revision
Warning: documentation is missing.
Returns void


revertToDate

private void revertToDate( $date )

 

Warning: documentation is missing.

Parameter
$date
Warning: documentation is missing.
Returns void


revertToTag

private void revertToTag( $tag )

 

Warning: documentation is missing.

Parameter
$tag
Warning: documentation is missing.
Returns void


writeCurrentDepsDown

private void writeCurrentDepsDown( )

 

Warning: documentation is missing.

Returns void


updatePathRecursive

private void updatePathRecursive( $path, integer $mode )

 

Warning: documentation is missing.

Parameter
$path
Warning: documentation is missing.
integer $mode
Warning: documentation is missing.
Returns void


recomputePath

private void recomputePath( )

 

Warning: documentation is missing.

Returns void


Private Field Details

$_part

private unknown $_part

>><<



$_table

private string $_table

>>PART_REVISION_TABLE<<




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta