[ class tree: VersionControl_SVN ] [ index: VersionControl_SVN ] [ all elements ]

Class: VersionControl_SVN_Command_Checkout

Source Location: /VersionControl_SVN-0.5.2/VersionControl/SVN/Command/Checkout.php

Class Overview


Subversion Checkout command manager class



  • 0.5.2


  • 2004-2007 Clay Loveless



Inherited Variables

Inherited Methods

Class: VersionControl_SVN_Command

Constructor. Can't be called directly as class is abstract.
Standardized validation of requirements for a command class.
Fills the switches array on given name with value if not already set and value is not null.
Handles output parsing of standard and verbose output of command.
Called after handling switches.
Prepare the command switches.
Called before handling switches.
Run the command with the defined switches.
Allow for overriding of previously declared options.

Class Details

[line 133]
Subversion Checkout command manager class

Checkout a working copy from a repository.

$switches is an array containing one or more command line options defined by the following associative keys:

  1.  $switches = array(
  2.   'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  3.                         A revision argument can be one of:
  4.                            NUMBER       revision number
  5.                            "{" DATE "}" revision at start of the date
  6.                            "HEAD"       latest in repository
  7.                            "BASE"       base rev of item's working copy
  8.                            "COMMITTED"  last commit at or before BASE
  9.                            "PREV"       revision just before COMMITTED',
  10.                       // either 'r' or 'revision' may be used
  11.   '[quiet]'     =>  true|false,
  12.                       // prints as little as possible
  13.   'N'             =>  true|false,
  14.                       // operate on single directory only
  15.   'non-recursive' =>  true|false,
  16.                       // operate on single directory only
  17.   'username'      =>  'Subversion repository login',
  18.   'password'      =>  'Subversion repository password',
  19.   'no-auth-cache' =>  true|false,
  20.                       // Do not cache authentication tokens
  21.   'config-dir'    =>  'Path to a Subversion configuration directory'
  22.  );

Note: If PATH is omitted from $args, the basename of the URL will be used as the destination. If multiple URLs are given each will be checked out into a sub-directory of PATH, with the name of the sub-directory being the basename of the URL.

Note: Subversion does not offer an XML output option for this subcommand

The non-interactive option available on the command-line svn client may also be set (true|false), but it is set to true by default.

Usage example:

[ Top ]

Class Variables

$minArgs =  1

[line 142]

Minimum number of args required by this subcommand.

See Version Control with Subversion, Subversion Complete Reference for details on arguments for this subcommand.

  • Access: protected

Type:   int
Overrides:   Array

[ Top ]

Method Detail

__construct (Constructor)   [line 147]

VersionControl_SVN_Command_Checkout __construct( )

Constuctor of command. Adds available switches.
  • Access: public

Overrides VersionControl_SVN_Command::__construct() (Constructor. Can't be called directly as class is abstract.)
[ Top ]

Documentation generated on Mon, 11 Mar 2019 15:58:56 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.