Public Member Functions | Public Attributes

Svn Class Reference

Revision Control System Model for SVN. More...

List of all members.

Public Member Functions

 type ()
 Get the repository type for this model.
 startup ($path)
 Startup the model initializing a path.
 authorize ($user, $passwd)
 Set authorization params for the model.
 cloneRemote ($url, $path=null, $branch=null)
 Checkout a repository.
 up ($path=null)
 Update a repository.
 status ($path=null)
 Get the current status of the repository.
 branch ($path=null)
 SVN does not use branches.
 branches ($path=null, $remote=false)
 SVN does not use branches.
 valid ($path=null)
 Check if the current or given path is a valid SVN repository.
 lastCommit ($path=null)
 Get last commit data.
 command ($cmd)
 Exec a given SVN command fill `lastCommand` and eventually `lastCommandCode` and `lastError` attributes.

Public Attributes

 $path = null
 $username = ''
 $passwd = ''
 $lastCommandCode = null
 $lastCommand = null
 $lastError = null

Detailed Description

Revision Control System Model for SVN.

Definition at line 30 of file svn.php.


Member Function Documentation

Svn::authorize ( user,
passwd 
)

Set authorization params for the model.

Parameters:
string $user: the SVN username
string $passwd: the SVN user password
Returns:
void

Definition at line 66 of file svn.php.

Svn::branch ( path = null  ) 

SVN does not use branches.

Returns:
boolean: false

Definition at line 133 of file svn.php.

Svn::branches ( path = null,
remote = false 
)

SVN does not use branches.

Returns:
boolean: false

Definition at line 142 of file svn.php.

Svn::cloneRemote ( url,
path = null,
branch = null 
)

Checkout a repository.

Parameters:
string $url: the repository remote url
string $path: where the repository should be checkouted
null $branch: SVN does not use branches
Returns:
array: the checkout command results

Definition at line 79 of file svn.php.

Svn::command ( cmd  ) 

Exec a given SVN command fill `lastCommand` and eventually `lastCommandCode` and `lastError` attributes.

Parameters:
string $cmd: the command to exec
Returns:
array: the result of the exec

Definition at line 195 of file svn.php.

Referenced by lastCommit(), status(), and up().

Svn::lastCommit ( path = null  ) 

Get last commit data.

Parameters:
string $path: optional. Can be a repository path
Returns:
array: a list of properties for the last commit

Definition at line 166 of file svn.php.

References command().

Svn::startup ( path  ) 

Startup the model initializing a path.

Parameters:
string $path: the repository path
Returns:
void

Definition at line 55 of file svn.php.

Svn::status ( path = null  ) 

Get the current status of the repository.

Parameters:
string $path: optional. Can be a repository path
Returns:
array: the status command results

Definition at line 112 of file svn.php.

References command().

Referenced by valid().

Svn::type (  ) 

Get the repository type for this model.

Returns:
string: the repository type

Definition at line 45 of file svn.php.

Svn::up ( path = null  ) 

Update a repository.

Parameters:
string $path: optional. Can be a repository path to update
Returns:
array: the update command results

Definition at line 95 of file svn.php.

References command().

Svn::valid ( path = null  ) 

Check if the current or given path is a valid SVN repository.

Parameters:
string $path: optional. Can be a repository path
Returns:
boolean: is a valid repository or not

Definition at line 152 of file svn.php.

References status().


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:47 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus