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

Procedural File: utils.inc.php

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

Page Details

This file provides some basic service routines.

This file provides some basic service routines.

Since:  v1.0.0
Filesource:  Source Code for this file
Version:  v1.1.0
License:  GNU Lesser General Public License
Copyright:  Copyright 2006 by sTEFANs
Author:  Stefan Schraml
Includes
require_once ('var.inc.php') [line 37]

Common definitions

Common definitions

[ Top ]


Functions
CreateSystemFriendlyString  [line 187]

string CreateSystemFriendlyString( string $text  )

Creates a string from given parameter that can savely be used for paths, repository names, etc.

Creates a string from given parameter that can savely be used for paths, repository names, etc. The transformed text contains only small letters from a to z and digits from 0 to 9, other characters are changed to underscores.

Parameters:
string   $text:  String to be converted.

API Tags:
Return:  Transformed text

Information Tags:
Since:  v1.1.0

[ Top ]
GetAllConfigs  [line 111]

array GetAllConfigs( )

Returns an array of all available SwcConfigs.

Returns an array of all available SwcConfigs.


API Tags:
Return:  of SwcConfig All available configs of the current SwcConfigFactory or an empty array if no further configs are given.
See:  GetConfigFactory()
See:  SwcConfigFactory
See:  SwcConfig

Information Tags:
Since:  v1.0.0

[ Top ]
GetConfigFactory  [line 53]

SwcConfigFactory GetConfigFactory( )

Returns the SwcConfigFactory that should be used.

Returns the SwcConfigFactory that should be used. The config factory is placed within the file applied as config argument to swc URL. If SWC is invoked without argument, STD_CONFIG_FILE is used instead. The SwcConfigFactoryas provided by GetSwcConfigFactory of the used file is returned.


API Tags:
Return:  Config factory.
See:  SwcConfig
See:  SwcConfigFactory
See:  GetSwcConfigFactory()

Information Tags:
Since:  v1.0.0

[ Top ]
GetSelectedConfig  [line 80]

SwcConfig GetSelectedConfig( )

Returns the active SwcConfig.

Returns the active SwcConfig. The active config is either retrieved by the current applied SwcConfigFactory. If more than one SwcConfig is found, the selected config is determined by project name given in $_SESSION[IDX_SEL_PROJECT].


API Tags:
Return:  Configuration of the active project or NULL if no config was found.
See:  GetConfigFactory()
See:  SwcConfigFactory
See:  SwcConfig

Information Tags:
Since:  v1.0.0

[ Top ]
IsWebspaceCheckedOut  [line 139]

boolean IsWebspaceCheckedOut( )

Determines whether the webspace for the selected config is already checked aout and available.

Determines whether the webspace for the selected config is already checked aout and available. If no config is applied (GetSelectedConfig returns NULL) also false is returned.


API Tags:
Return:  True if the webspace is availble, false otherwise.
See:  SwcConfig
See:  GetSelectedConfig()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintDebugArray  [line 160]

void PrintDebugArray( array $array, [string $name = ""]  )

HTML friendly debug output of an array.

HTML friendly debug output of an array.

Parameters:
array   $array:  Array to print
string   $name:  Name of the array, also printed.

Information Tags:
Since:  v1.0.0

[ Top ]


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