Class Horde_Vcs_Rcs

Horde_Vcs_Rcs implementation.

Copyright 2004-2007 Jeff Schwentner jeffrey.schwentner@lmco.com

Horde_Vcs_Base

Extended by

Horde_Vcs_Rcs

Direct known subclasses

Package: Vcs
Author: Jeff Schwentner jeffrey.schwentner@lmco.com
Author: Chuck Hagenbuch chuck@horde.org
Located at Horde/Vcs/Rcs.php

Methods summary
`public boolean`	# `isValidRevision( mixed $rev )` TODO TODO Parameters `$rev` The purported revision string. Returns `boolean` True if a valid revision string.
`public array`	# `getRevisionRange( Horde_Vcs_File_Base $file, string $r1, string $r2 )` Create a range of revisions between two revision numbers. Create a range of revisions between two revision numbers. Parameters `$file` The desired file. `$r1` The initial revision. `$r2` The ending revision. Returns `array` The revision range, or empty if there is no straight line path between the revisions. Overrides `Horde_Vcs_Base::getRevisionRange()`
`public`	# `getFile( mixed $filename, mixed $opts = array() )` TODO TODO Overrides `Horde_Vcs_Base::getFile()`
`public string`	# `ci( string $filepath, string $message, string $user = null, boolean $newBinary = false )` Checks an RCS file in with a specified change log. Checks an RCS file in with a specified change log. Parameters `$filepath` Location of file to check in. `$message` Log of changes since last version. `$user` The user name to use for the check in. `$newBinary` Does the change involve binary data? Returns `string` The new revision number on success.
`public boolean`	# `isLocked( string $filepath, string & $locked_by )` Checks the locks on a CVS/RCS file. Checks the locks on a CVS/RCS file. Parameters `$filepath` Location of file. `$locked_by` $locked_by Returns the username holding the lock. Returns `boolean` True on success.
`public boolean`	# `lock( string $filepath, string $user = null )` Locks a CVS/RCS file. Locks a CVS/RCS file. Parameters `$filepath` Location of file. `$user` User name to lock the file with Returns `boolean` True on success.
`public boolean`	# `unlock( string $filepath, string $user = null )` Unlocks a CVS/RCS file. Unlocks a CVS/RCS file. Parameters `$filepath` Location of file. `$user` User name to unlock the file with Returns `boolean` True on success.
`public string`	# `strip( string $val, integer $amount = 1 )` Given a revision number, remove a given number of portions from it. For example, if we remove 2 portions of 1.2.3.4, we are left with 1.2. Given a revision number, remove a given number of portions from it. For example, if we remove 2 portions of 1.2.3.4, we are left with 1.2. Parameters `$val` Input revision. `$amount` Number of portions to strip. Returns `string` Stripped revision number.
`public integer`	# `cmp( string $rev1, string $rev2 )` Given two revision numbers, this figures out which one is greater than the other by stepping along the decimal points until a difference is found, at which point a sign comparison of the two is returned. Given two revision numbers, this figures out which one is greater than the other by stepping along the decimal points until a difference is found, at which point a sign comparison of the two is returned. Parameters `$rev1` Period delimited revision number `$rev2` Second period delimited revision number Returns `integer` 1 if the first is greater, -1 if the second if greater, and 0 if they are equal Overrides `Horde_Vcs_Base::cmp()`
`public string`	# `prev( string $rev )` Return the logical revision before this one. Normally, this will be the revision minus one, but in the case of a new branch, we strip off the last two decimal places to return the original branch point. Return the logical revision before this one. Normally, this will be the revision minus one, but in the case of a new branch, we strip off the last two decimal places to return the original branch point. Parameters `$rev` Revision number to decrement. Returns `string` Revision number, or null if none could be determined.

Methods inherited from Horde_Vcs_Base
`__construct(), abbrev(), annotate(), assertValidRevision(), availableDiffTypes(), checkout(), diff(), getDefaultBranch(), getDirectory(), getPatchset(), getPath(), getUsers(), hasFeature(), isFile()`

Properties inherited from Horde_Vcs_Base
`$sourceroot`