sTEFANs Subversion Web Contol (SWC)
Config
[ class tree: Swc ] [ index: Swc ] [ all elements ]

Class: TestProject2Config

Source Location: /swc/config/std_config2.inc.php

Class TestProject2Config

Class Overview

This class implements a sample configuration for Test Project 1.

This class implements a sample configuration for Test Project 1.

Located in /swc/config/std_config2.inc.php [line 52]



		
				Author(s):
		
API Tags:
See:  SwcConfig
See:  config.inc.php

Information Tags:
Since:  v1.0.0
Version:  v1.1.0

Methods

[ Top ]
Method Summary
string   GetMainFrame()   Returns the relative URL of the Webpage under control.
string   GetProjectName()   Returns a user friendly name for the project.
string   GetRepositoryRoot()   Returns the URL of the repository for the main frame.
string   GetRepositoryRootDir()   Returns the absolute path of the repository in the local file system.
string   GetWebspaceRoot()   Returns the HTTP URL for the workspace where the project is checked out.
string   GetWebspaceRootDir()   Returns the absolute path of the workspace directory in the local file system.
void   GetWebSvnUrl()   Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.

[ Top ]
Methods
GetMainFrame  [line 70]

  string GetMainFrame( )

Returns the relative URL of the Webpage under control.

Returns the relative URL of the Webpage under control.


API Tags:
Return:  URL of page to display in MainFrame.
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
GetProjectName  [line 60]

  string GetProjectName( )

Returns a user friendly name for the project.

Returns a user friendly name for the project.


API Tags:
Return:  User friendly project name.
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
GetRepositoryRoot  [line 81]

  string GetRepositoryRoot( )

Returns the URL of the repository for the main frame.

Returns the URL of the repository for the main frame.


API Tags:
Return:  URL of repository. Any protocol (http://, svn://, etc.) is supported.
Note: public function GetRepositoryRootDir is deprecated and removed from SwcConfig interface in SWC v1.1.0. Please use GetRepositoryRoot instead.
Access:  public


[ Top ]
GetRepositoryRootDir  [line 92]

  string GetRepositoryRootDir( )

Returns the absolute path of the repository in the local file system.

Returns the absolute path of the repository in the local file system.


API Tags:
Return:  Absolute path of the repository.
Access:  public
See:  SwcConfig::GetRepositoryRoot
Deprecated:  v1.1.0 Use GetRepositroyRoot() instead to configure the repository root.

Information Tags:
Since:  v1.0.0

[ Top ]
GetWebspaceRoot  [line 171]

  string GetWebspaceRoot( )

Returns the HTTP URL for the workspace where the project is checked out.

Returns the HTTP URL for the workspace where the project is checked out. Used by SVN.


API Tags:
Return:  URL of Webspace.
Access:  public
See:  SwcConfig::GetWebspaceRootDir
Deprecated:  v1.1.0 Use GetWebspaceRootDir instead to configure webspace.

Information Tags:
Since:  v1.0.0

[ Top ]
GetWebspaceRootDir  [line 183]

  string GetWebspaceRootDir( )

Returns the absolute path of the workspace directory in the local file system.

Returns the absolute path of the workspace directory in the local file system.


API Tags:
Return:  Absolute path of the workspace.
Note: public function GetWebspaceRoot is deprecated and removed from SwcConfig interface in SWC v1.1.0. Please use GetWebspaceRootDir instead.
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
GetWebSvnUrl  [line 216]

  void GetWebSvnUrl( )

Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.

Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.


API Tags:
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]

Documentation generated on Fri, 03 Nov 2006 18:45:00 +0100 by phpDocumentor 1.3.0RC6
for sTEFANs POWERED BY eBC.bz