Class: SwcConfigAdapter

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

Class SwcConfigAdapter

Class Overview

This abstract class provides default implementations of configuration methods that usually do not change. from this class instead of the the interface minimizes the number of methods that needs to be implemented.

This abstract class provides default implementations of configuration methods that usually do not change. Deriving from this class instead of the the interface minimizes the number of methods that needs to be implemented.

Located in /swc/inc/config.inc.php [line 264]

Author(s):

Stefan Schraml

API Tags:

Abstract:

Information Tags:

Since:

v1.1.0

Methods

[ Top ]

Direct descendents

Child Class	Description
TestProject1Config	This class implements a sample configuration for Test Project 1.
TestProject1StandaloneConfig	This class implements a sample configuration for Test Project 1.

[ Top ]

Method Summary

array	GetBranchDirs()	Returns subdirectories which contains directories for branches.
int	GetMaxBranchDirDepth()	Returns the maximum depth of directories that should be considered as branch directory underneath GetBranchDirs() hierarchy.
int	GetMaxTagDirDepth()	Returns the maximum depth of directories that should be considered as tag directory underneath GetTagDirs() hierarchy.
string	GetSpaceballDir()	Returns the directory for packed (release) archives called spaceballs.
string	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.
string	GetSvnPassword()	Returns the password of the SVN user which should be used for repository access.
string	GetSvnUser()	Returns the SVN user which should be used for repository access.
array	GetTagDirs()	Returns subdirectories which contains directories for tags.
string	GetTrunkDir()	Returns subdirectoy which contains repository trunk.
void	GetWebSvnUrl()	Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.
void	IsSvnCommandBarEnabled()	Returns true if SVN command bar may be shown, false otherwise.

[ Top ]

Methods

GetBranchDirs [line 292]

array GetBranchDirs(
)

Returns subdirectories which contains directories for branches.

Returns subdirectories which contains directories for branches.

API Tags:

Return:	or string (Array of) repository directory that contains branches.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetMaxBranchDirDepth [line 304]

int GetMaxBranchDirDepth(
)

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

Returns the maximum depth of directories that should be considered as branch directory underneath GetBranchDirs() hierarchy. E.g. if this is set to 2 than GetBranchDirs()/dir1/dir2 is considered as tag directory while GetBranchDirs()/dir1/dir2/dir3 is not.

API Tags:

Return:	Maximal path depth for branch directories.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetMaxTagDirDepth [line 283]

int GetMaxTagDirDepth(
)

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

Returns the maximum depth of directories that should be considered as tag directory underneath GetTagDirs() hierarchy. E.g. if this is set to 2 than GetTagDirs()/dir1/dir2 is considered as tag directory while GetTagDirs()/dir1/dir2/dir3 is not.

API Tags:

Return:	Maximal path depth for tag directories.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetSpaceballDir [line 360]

string GetSpaceballDir(
)

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

Returns the directory for packed (release) archives called spaceballs. Spaceballs archives are usually created for a dedicated revision. Note PHP needs write access granted on this directory.

API Tags:

Return:	Path for archive directory.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetSpaceballUrl [line 379]

string 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.

Returns the HTTP URL for packed (release) archives. The URL should point to the directory returned by GetSpaceballDir(). The default implementation 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. If this implementation does not fit concrete requirments, this function must be overwritten within the concrete project configuration.

API Tags:

Return:	URL for spaceball directory.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetSvnPassword [line 331]

string GetSvnPassword(
)

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

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

API Tags:

Return:	Password of SVN user.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetSvnUser [line 322]

string GetSvnUser(
)

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

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

API Tags:

Return:	SVN user.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetTagDirs [line 271]

array GetTagDirs(
)

Returns subdirectories which contains directories for tags.

Returns subdirectories which contains directories for tags.

API Tags:

Return:	or string (Array of) repository directory that contains tags.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetTrunkDir [line 313]

string GetTrunkDir(
)

Returns subdirectoy which contains repository trunk.

Returns subdirectoy which contains repository trunk.

API Tags:

Return:	Repository directory that contains main developement.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetWebSvnUrl [line 339]

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.1.0

Redefined in descendants as:

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

[ Top ]

IsSvnCommandBarEnabled [line 349]

void IsSvnCommandBarEnabled(
)

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

Returns true if SVN command bar may be shown, false otherwise. This setting overrides corresponding user setting in order to protect the system agaist malicious commands.

API Tags:

Access:

public

Information Tags:

Since:

v1.1.0

[ Top ]

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

	Subversion Web Contol (SWC) Inc

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