Pre-work for DataForm bug fix.

Added POD to VersionTag.pm showing some of the properties that can be gotten via get.
This commit is contained in:
Colin Kuskie 2007-05-01 21:18:21 +00:00
parent 8768116f76
commit ec1d8dc2d1
2 changed files with 43 additions and 1 deletions

View file

@ -1108,12 +1108,16 @@ sub www_exportTab {
$i++;
}
$entries->finish;
##Output field headers
my @row;
foreach my $fieldId (keys %fields) {
next if (isIn($fields{$fieldId}, qw(to from cc bcc subject)) && $noMailData);
push(@row, $fields{$fieldId});
}
my $tab = join("\t",@row)."\n";
##Output actual row data
foreach my $record (@data) {
@row = ();
foreach my $fieldId (keys %fields) {

View file

@ -127,7 +127,45 @@ sub commit {
=head2 get ( name )
Returns the value for a given property.
Returns the value for a given property. An incomplete list of properties is below:
=head3 name
The name of the tag.
=head4 createdBy
The ID of the user who originally created the tag.
=head4 committedBy
The ID of the user who committed the tag.
=head4 lockedBy
If the version tag is locked, the ID of the user who has it locked.
=head4 isLocked
An integer that indicates whether the version tag is locked. A 1 indicates that the tag
is locked. Note that this is different from edit locking an Asset. Locked Version Tags may
not be edited.
=head3 groupToUse
The ID of the group that's allowed to use this tag. Defaults to the turn admin on group.
=head4 commitDate
The epoch date the tag was committed.
=head3 creationDate
The epoch date the tag was created.
=head3 comments
Some text about this version tag, what it's for, why it was committed, why it was denied, why it was approved, etc.
=cut