Overview

Packages

  • None
  • Vcs

Classes

  • Horde_Vcs
  • Horde_Vcs_Base
  • Horde_Vcs_Cvs
  • Horde_Vcs_Directory_Base
  • Horde_Vcs_Directory_Cvs
  • Horde_Vcs_Directory_Git
  • Horde_Vcs_Directory_Rcs
  • Horde_Vcs_Directory_Svn
  • Horde_Vcs_File_Base
  • Horde_Vcs_File_Cvs
  • Horde_Vcs_File_Git
  • Horde_Vcs_File_Rcs
  • Horde_Vcs_File_Svn
  • Horde_Vcs_Git
  • Horde_Vcs_Log_Base
  • Horde_Vcs_Log_Cvs
  • Horde_Vcs_Log_Git
  • Horde_Vcs_Log_Rcs
  • Horde_Vcs_Log_Svn
  • Horde_Vcs_Patchset
  • Horde_Vcs_Patchset_Base
  • Horde_Vcs_Patchset_Cvs
  • Horde_Vcs_Patchset_Git
  • Horde_Vcs_Patchset_Svn
  • Horde_Vcs_QuickLog_Base
  • Horde_Vcs_QuickLog_Cvs
  • Horde_Vcs_QuickLog_Git
  • Horde_Vcs_QuickLog_Rcs
  • Horde_Vcs_QuickLog_Svn
  • Horde_Vcs_Rcs
  • Horde_Vcs_Svn
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Vcs_File_Base

Base file class.

Copyright 2008-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Direct known subclasses

Horde_Vcs_File_Git, Horde_Vcs_File_Rcs, Horde_Vcs_File_Svn

Indirect known subclasses

Horde_Vcs_File_Cvs
Abstract
Package: Vcs
Located at Horde/Vcs/File/Base.php
Methods summary
public
# __construct( string $filename, array $opts = array() )

Constructor.

Constructor.

Parameters

$filename
Full path (inside the source root) to this file.
$opts
<p>Additional parameters: - 'branch': (string)</p>
public
# __sleep( )

When serializing, don't return the repository object

When serializing, don't return the repository object

public
# setRepository( mixed $rep )

TODO

TODO

public
# getBlob( mixed $revision )

TODO - better name, wrap an object around this?

TODO - better name, wrap an object around this?

public boolean
# isDeleted( )

Has the file been deleted?

Has the file been deleted?

Returns

boolean
Is this file deleted?
public string
# getFileName( )

Returns name of the current file without the repository extensions.

Returns name of the current file without the repository extensions.

Returns

string
Filename without repository extension
public string
# getRevision( )

Returns the last revision of the current file on the HEAD branch.

Returns the last revision of the current file on the HEAD branch.

Returns

string
Last revision of the current file.

Throws

Horde_Vcs_Exception
public string
# getPreviousRevision( string $rev )

Returns the revision before the specified revision.

Returns the revision before the specified revision.

Parameters

$rev
A revision.

Returns

string
The previous revision or null if the first revision.
abstract public Horde_Vcs_QuickLog
# getLastLog( )

Returns a log object for the most recent log entry of this file.

Returns a log object for the most recent log entry of this file.

Returns

Horde_Vcs_QuickLog
Log object of the last entry in the file.

Throws

Horde_Vcs_Exception
public
# applySort( integer $how = Horde_Vcs::SORT_REV )

Sort the list of Horde_Vcs_Log objects that this file contains.

Sort the list of Horde_Vcs_Log objects that this file contains.

Parameters

$how
<p>Horde_Vcs::SORT_REV (sort by revision), Horde_Vcs::SORT_NAME (sort by author name), or Horde_Vcs::SORT_AGE (sort by commit date).</p>
public
# sortByRevision( mixed $a, mixed $b )

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

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

public
# sortByAge( mixed $a, mixed $b )
public
# sortByName( mixed $a, mixed $b )
public string
# getSourcerootPath( )

Return the filename relative to its sourceroot.

Return the filename relative to its sourceroot.

Returns

string
Pathname relative to the sourceroot.
public string
# getPath( )

Return the "base" filename (i.e. the filename needed by the various command line utilities).

Return the "base" filename (i.e. the filename needed by the various command line utilities).

Returns

string
A filename.
public
# getBranches( )

TODO

TODO

public
# getLog( mixed $rev = null )

TODO

TODO

public
# revisionCount( )

TODO

TODO

public
# getTags( )

TODO

TODO

API documentation generated by ApiGen