SVN_CHECKOUT(3) 1 SVN_CHECKOUT(3)svn_checkout - Checks out a working copy from the repositorySYNOPSIS
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)
Check Out this Related Man Page
SVN_DIFF(3) 1 SVN_DIFF(3)svn_diff - Recursively diffs two pathsSYNOPSIS
array svn_diff (string $path1, int $rev1, string $path2, int $rev2)
DESCRIPTION
Recursively diffs two paths, $path1 and $path2.
Note
This is not a general-purpose diff utility. Only local files that are versioned may be diffed: other files will fail.
PARAMETERS
o $path1
- First path to diff. This can be a URL to a file/directory in an SVN repository or a local file/directory path.
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__).
Warning
If a local file path has only backslashes and no forward slashes, this extension will fail to find the path. Always replace
all backslashes with forward slashes when using this function.
o $rev1
- First path's revision number. Use SVN_REVISION_HEAD to specify the most recent revision.
o $path2
- Second path to diff. See $path1 for description.
o $rev2
- Second path's revision number. See $rev1 for description.
RETURN VALUES
Returns an array-list consisting of two streams: the first is the diff output and the second contains error stream output. The streams can
be read using fread(3). Returns FALSE or NULL on error.
The diff output will, by default, be in the form of Subversion's custom unified diff format, but an external diff engine may be used
depending on Subversion's configuration.
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 the basic usage of this function, and the retrieval of contents from the stream:
<?php
list($diff, $errors) = svn_diff(
'http://www.example.com/svnroot/trunk/foo', SVN_REVISION_HEAD,
'http://www.example.com/svnroot/branches/dev/foo', SVN_REVISION_HEAD
);
if (!$diff) exit;
$contents = '';
while (!feof($diff)) {
$contents .= fread($diff, 8192);
}
fclose($diff);
fclose($errors);
var_dump($contents);
?>
The above example will output:
Index: http://www.example.com/svnroot/trunk/foo
===================================================================
--- http://www.example.com/svnroot/trunk/foo (.../foo) (revision 23)
+++ http://www.example.com/svnroot/branches/dev/foo (.../foo) (revision 27)
// further diff output
Example #2
Diffing two revisions of a repository path
This example implements a wrapper function that allows a user to easily diff two revisions of the same item using an external
repository path (the default syntax is somewhat verbose):
<?php
function svn_diff_same_item($path, $rev1, $rev2) {
return svn_diff($path, $rev1, $path, $rev2);
}
?>
Example #3
Portably diffing two local files
This example implements a wrapper function that portably diffs two local files, compensating for the realpath(3) fix and the back-
slashes bug:
<?php
function svn_diff_local($path1, $rev1, $path2, $rev2) {
$path1 = str_replace('\', '/', realpath($path1));
$path2 = str_replace('\', '/', realpath($path2));
return svn_diff($path1, $rev1, $path2, $rev2);
}
?>
SEE ALSO
SVN documentation on svn diff.
PHP Documentation Group SVN_DIFF(3)