Class VersionControl_Hg_Repository

Description

The Mercurial repository

Usage: All calls are proxied from Hg

  1.  $hg new VersionControl_Hg('/path/to/repo');
  2.  $repository $hg->getRepository();

PHP version 5

Located in /Hg/Repository.php (line 39)


	
			
Class Constant Summary
 ROOT_NAME = '.hg'
Variable Summary
string $hg
string $_repository
Method Summary
VersionControl_Hg_Repository __construct (VersionControl_Hg $hg)
void create ()
boolean delete ()
string getRepository ()
boolean isRepository ( $path, string $repo)
mixed setRepository (string $path)
mixed __call (string $method, array $arguments)
Variables
string $hg (line 70)

Holds the current state of the Hg object

  • access: public
string $path_to_repository = null (line 63)

Path to a local Mercurial repository

  • access: protected
string $_repository (line 56)

Holds the filesystem path of a Mercurial repository

  • deprecated: replaced by $_path_to_repository
  • access: protected
Methods
Constructor __construct (line 77)

Repository constructor which currently does nothing.

  • todo: might be a good place to set the transport method?
  • access: public
VersionControl_Hg_Repository __construct (VersionControl_Hg $hg)
create (line 172)
  • access: public
void create ()
delete (line 189)

Deletes the repository, effectively removing the working copy from SCM.

  • access: public
boolean delete ()
getRepository (line 125)

Returns the path of a Mercurial repository as set by the user.

It is validated before being set as a class member.

string getRepository ()
isRepository (line 142)

Checks if $this is in fact a valid

  • access: public
boolean isRepository ( $path, string $repo)
  • string $repo: is the full repository path.
  • $path
setRepository (line 89)

Sets the path of a Mercurial repository after validating it as a Hg repo.

mixed setRepository (string $path)
  • string $path: as a local filesystem path.
__call (line 208)

Proxy calls to the Command class

  • access: public
mixed __call (string $method, array $arguments)
  • string $method
  • array $arguments
Class Constants
ROOT_NAME = '.hg' (line 48)

The name of all Mercurial repository roots.

Leading backslash is needed since _path may not have a trailing slash.

Documentation generated on Tue, 18 Aug 2009 23:53:20 -0600 by phpDocumentor 1.4.2