Docs For Class SwcConfig

Methods

GetBranchDirs [line 145]

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

[ Top ]

GetMainFrame [line 109]

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 ]

GetMaxBranchDirDepth [line 155]

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

[ Top ]

GetMaxTagDirDepth [line 138]

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

[ Top ]

GetProjectName [line 102]

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

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

Information Tags:

Since:

v1.0.0

[ Top ]

GetSpaceballDir [line 211]

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

string GetSpaceballUrl(
)

Returns the HTTP URL for packed (release) archives. URL should point to the directory returned by GetSpaceballDir().

Returns the HTTP URL for packed (release) archives. The URL should point to the directory returned by GetSpaceballDir().

API Tags:

Return:	URL for spaceball directory.
Access:	public

Information Tags:

Since:

v1.1.0

[ Top ]

GetSvnPassword [line 187]

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

[ Top ]

GetSvnUser [line 180]

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

[ Top ]

GetTagDirs [line 128]

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

[ Top ]

GetTrunkDir [line 162]

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

[ Top ]

GetWebspaceRootDir [line 173]

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

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

Return:	URL for WebSVN view for this project.
Access:	public

Information Tags:

Since:

v1.0.0

[ Top ]

IsSvnCommandBarEnabled [line 202]

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

[ Top ]

Interface: SwcConfig

Interface SwcConfig

	Subversion Web Contol (SWC) Inc

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