php man page for svn_checkout

SVN_CHECKOUT(3) 							 1							   SVN_CHECKOUT(3)

svn_checkout - Checks out a working copy from the repository

SYNOPSIS
       bool svn_checkout (string  $repos, string  $targetpath, [int  $revision], [int  $flags])

DESCRIPTION
	Checks out a working copy from the repository at $repos to $targetpath at revision $revision.

PARAMETERS
	      o $repos
		- String URL path to directory in repository to check out.

	      o $targetpath
		- String local path to directory to check out in to

	      Note

		     Relative  paths  will  be	resolved  as if the current working directory was the one that contains the PHP binary. To use the
		     calling script's working directory, use realpath(3) or dirname(__FILE__).

	      o $revision
		- Integer revision number of repository to check out. Default is HEAD, the most recent revision.

	      o $flags
		- Any combination of SVN_NON_RECURSIVE and SVN_IGNORE_EXTERNALS.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

NOTES
       Warning

	      This function is EXPERIMENTAL. The behaviour of this function, its name, and surrounding documentation may change without notice	in
	      a future release of PHP. This function should be used at your own risk.

EXAMPLES
       Example #1

	      Basic example

	       This example demonstrates how to check out a directory from a repository to a directory named calc:

	      <?php
	      svn_checkout('http://www.example.com/svnroot/calc/trunk', dirname(__FILE__) . '/calc');
	      ?>

	       The  dirname(__FILE__)  call  is necessary in order to convert the calc relative path into an absolute one. If calc exists, you can
	      also use realpath(3) to retrieve an absolute path.

SEE ALSO
       svn_add(3), svn_commit(3), svn_status(3), svn_update(3), SVN documentation on svn checkout.

PHP Documentation Group 													   SVN_CHECKOUT(3)