Class: TestProject1Config

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

Class TestProject1Config

Class Overview

This class implements a sample configuration for Test Project 1.

This class implements a sample configuration for Test Project 1. Common configurations are done within class "SwcConfigAdapter" in file "inc/config.inc.php".

Located in /swc/config/std_config1.inc.php [line 54]

SwcConfigAdapter
   |
   --TestProject1Config

Author(s):

Stefan Schraml

API Tags:

See:	SwcConfig
See:	config.inc.php

Information Tags:

Since:	v1.0.0
Version:	v1.1.0

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From SwcConfigAdapter

SwcConfigAdapter::GetBranchDirs()

Returns subdirectories which contains directories for branches.

SwcConfigAdapter::GetMaxBranchDirDepth()

Returns the maximum depth of directories that should be considered as branch directory underneath GetBranchDirs() hierarchy.

SwcConfigAdapter::GetMaxTagDirDepth()

Returns the maximum depth of directories that should be considered as tag directory underneath GetTagDirs() hierarchy.

SwcConfigAdapter::GetSpaceballDir()

Returns the directory for packed (release) archives called spaceballs.

SwcConfigAdapter::GetSpaceballUrl()

Returns the HTTP URL for packed (release) archives. URL should point to the directory returned by GetSpaceballDir(). tries to match the frist part of GetMainFrame() against the later part of GetSpaceBallDir() since usually the URL for the main frame contains the common root URL that also leads to the spaceball directory URL. concrete requirments, this function must be overwritten within the concrete project configuration.

SwcConfigAdapter::GetSvnPassword()

Returns the password of the SVN user which should be used for repository access.

SwcConfigAdapter::GetSvnUser()

Returns the SVN user which should be used for repository access.

SwcConfigAdapter::GetTagDirs()

Returns subdirectories which contains directories for tags.

SwcConfigAdapter::GetTrunkDir()

Returns subdirectoy which contains repository trunk.

SwcConfigAdapter::GetWebSvnUrl()

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

SwcConfigAdapter::IsSvnCommandBarEnabled()

Returns true if SVN command bar may be shown, false otherwise.

[ 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 HTTP 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 61]

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 80]

string GetRepositoryRoot(
)

Returns the HTTP URL of the repository for the main frame.

Returns the HTTP URL of the repository for the main frame.

API Tags:

Return:	URL of repository.
Access:	public

Information Tags:

Since:

v1.0.0

[ Top ]

GetRepositoryRootDir [line 90]

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

Information Tags:

Since:

v1.0.0

[ Top ]

GetWebspaceRoot [line 169]

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 182]

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 215]

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

Redefinition of:

SwcConfigAdapter::GetWebSvnUrl(): Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.

[ Top ]

Documentation generated on Fri, 03 Nov 2006 18:44:59 +0100 by phpDocumentor 1.3.0RC6
for sTEFANs

	Subversion Web Contol (SWC) Config

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