Class VC_File_cvs

Description

VC_cvs file class.

Copyright Anil Madhavapeddy, <anil@recoil.org>

Located in /VC/VC/cvs.php (line 570)

VC_File
   |
   --VC_File_cvs
Method Summary
 VC_File_cvs VC_File_cvs (string $fl, [ $quicklog = false])
 void applySort ([integer $how = VC_SORT_REV])
 boolean|object getBrowseInfo ()
 void &getFileObject ( $rep,  $filename, [ $cache = null], [ $quicklog = false])
 boolean isAtticFile ()
 Fully queryFullPath ()
 string queryHead ()
 VC_log queryLastLog ()
 string queryModulePath ()
 string queryName ()
 void queryPreviousRevision ( $rev)
 string|object queryRevision ()
 void sortByAge ( $a,  $b)
 void sortByName ( $a,  $b)
 void sortByRevision ( $a,  $b)
 string toBranch (string $rev)
Variables
Methods
Constructor VC_File_cvs (line 578)

Create a repository file object, and give it information about what its parent directory and repository objects are.

VC_File_cvs VC_File_cvs (string $fl, [ $quicklog = false])
  • string $fl: Full path to this file.
  • $quicklog
applySort (line 704)

Sort the list of VC_log objects that this file contains.

void applySort ([integer $how = VC_SORT_REV])
  • integer $how: VC_SORT_REV (sort by revision), VC_SORT_NAME (sort by author name), VC_SORT_AGE (sort by commit date)
getBrowseInfo (line 748)

Populate the object with information about the revisions logs and dates of the file.

  • return: PEAR_Error object on error, or true on success
boolean|object getBrowseInfo ()
getFileObject (line 589)
void &getFileObject ( $rep,  $filename, [ $cache = null], [ $quicklog = false])
  • $rep
  • $filename
  • $cache
  • $quicklog
isAtticFile (line 629)

If this file is present in an Attic directory, this indicates it.

  • return: True if file is in the Attic, and false otherwise
boolean isAtticFile ()
queryFullPath (line 829)

Return the fully qualified filename of this object.

  • return: qualified filename of this object
Fully queryFullPath ()
queryHead (line 679)

Return the HEAD (most recent) revision number for this file.

  • return: HEAD revision number
string queryHead ()
queryLastLog (line 689)

Return the last VC_log object in the file.

  • return: of the last entry in the file
VC_log queryLastLog ()
queryModulePath (line 839)

Return the name of this file relative to its sourceroot.

  • return: Pathname relative to the sourceroot.
string queryModulePath ()
queryName (line 650)

Returns name of the current file without the repository extensions (usually ,v)

  • return: Filename without repository extension
string queryName ()
queryPreviousRevision (line 669)
void queryPreviousRevision ( $rev)
  • $rev
queryRepositoryName (line 639)

Returns the name of the current file as in the repository

  • return: Filename (without the path)
string queryRepositoryName ()
queryRevision (line 661)

Return the last revision of the current file on the HEAD branch

  • return: Last revision of the current file or PEAR_Error on failure.
string|object queryRevision ()
sortByAge (line 732)
void sortByAge ( $a,  $b)
  • $a
  • $b
sortByName (line 737)
void sortByName ( $a,  $b)
  • $a
  • $b
sortByRevision (line 727)

The sortBy*() functions are internally used by applySort.

void sortByRevision ( $a,  $b)
  • $a
  • $b
toBranch (line 852)

Given a revision number of the form x.y.0.z, this remaps it into the appropriate branch number, which is x.y.z

  • return: Odd-digit Branch number
string toBranch (string $rev)
  • string $rev: Even-digit revision number of a branch

Inherited Methods

Inherited From VC_File

 VC_File::setRepository()

Documentation generated on Sun, 30 Jan 2011 05:16:16 +0000 by phpDocumentor 1.4.3