SwcUserSettings __construct(
)
|
|
Singleton c'tor.
Singleton c'tor. Initializes user settings with default values.
API Tags:
Information Tags:
Returns an array that provides mapping of index. of this array is numeric and the value is the index for the internal array.
Returns an array that provides mapping of index. The key of this array is numeric and the value is the index for the internal array.
API Tags:
Return: | Key map. |
Access: | private |
Information Tags:
Returns the single instance of this class.
Returns the single instance of this class.
API Tags:
Return: | Single instance of this class. |
Access: | public |
Information Tags:
int GetProjectFrameHeight(
)
|
|
Provides the height in pixel for the project frame.
Provides the height in pixel for the project frame.
API Tags:
Return: | Frame height in pixel. |
Access: | public |
Information Tags:
int GetProjectFrameWidth(
)
|
|
Provides the width in pixel for the project frame.
Provides the width in pixel for the project frame.
API Tags:
Return: | Frame width in pixel. |
Access: | public |
Information Tags:
Determines whether the webspace should automatically be updated if it is outdated.
Determines whether the webspace should automatically be updated if it is outdated.
API Tags:
Return: | True if the webspace should automatically be updated. |
Access: | public |
Information Tags:
boolean IsMinimizeControlBar(
)
|
|
Determines whether the top control bar should be minimized.
Determines whether the top control bar should be minimized.
API Tags:
Return: | True if the control bar schould be minimized. |
Access: | public |
Information Tags:
boolean IsPinProjectPage(
)
|
|
Determines whether the project page should always be shown, regardles of the current action.
Determines whether the project page should always be shown, regardles of the current action.
API Tags:
Return: | True if the project page should always be shown. |
Access: | public |
Information Tags:
boolean IsSeparateResultWindow(
)
|
|
Determines whether command execution result should be opened within a separate browser window.
Determines whether command execution result should be opened within a separate browser window.
API Tags:
Return: | True if command execution result should be opened within a separate browser window. |
Access: | public |
Information Tags:
boolean IsSvnCommandBarVisible(
)
|
|
Determines whether SVN command bar is visible.
Determines whether SVN command bar is visible.
API Tags:
Return: | True if SVN command bar is visible. |
Information Tags:
boolean IsSvnSwitchBarVisible(
)
|
|
Determines whether SVN switch bar is visible.
Determines whether SVN switch bar is visible.
API Tags:
Return: | True if SVN switch bar is visible. |
Information Tags:
boolean ProcessSettings(
)
|
|
Processes the user settings.
Processes the user settings. This basically means, that the function scans $_GET and $_POST (preferred) for changes in the settings, stores the changes and restores the user settings.
Important: Because user settings are stored via cookies, it is important that this function is invoked before any HTML or whitespace is printed!
API Tags:
Return: | True if a user setting has been changed within $_POST or $_GET, false otherwise. |
Access: | public |
Information Tags:
Restores the user settings from the cookie.
Restores the user settings from the cookie.
API Tags:
Information Tags:
boolean ScanArrayForSettings(
&$array, array
$array
)
|
|
Scans the given array for user settings.
Scans the given array for user settings.
Parameters:
array |
$array: |
Array to scan. |
|
&$array: |
|
API Tags:
Return: | True if changed settings are found. |
Access: | private |
Information Tags:
void SetAutoUpdate(
boolean
$enable
)
|
|
Sets whether the webspace should automatically be updated if it is outdated.
Sets whether the webspace should automatically be updated if it is outdated.
Parameters:
boolean |
$enable: |
True if the webspace should automatically be updated. |
API Tags:
Information Tags:
void SetMinimizeControlBar(
boolean
$minimize
)
|
|
Sets whether the top control bar should be minimized.
Sets whether the top control bar should be minimized.
Parameters:
boolean |
$minimize: |
True if the control bar schould be minimized. |
API Tags:
Information Tags:
void SetPinProjectPage(
boolean
$pin
)
|
|
Sets whether the project page should always be shown.
Sets whether the project page should always be shown.
Parameters:
boolean |
$pin: |
True if project page should always be shown. |
API Tags:
Information Tags:
void SetProjectFrameHeight(
$height, int
$width
)
|
|
Sets the height in pixel for the project frame.
Sets the height in pixel for the project frame.
Parameters:
int |
$width: |
Frame height in pixel. |
|
$height: |
|
API Tags:
Information Tags:
void SetProjectFrameWidth(
int
$width
)
|
|
Sets the width in pixel for the project frame.
Sets the width in pixel for the project frame.
Parameters:
int |
$width: |
Frame width in pixel. |
API Tags:
Information Tags:
boolean SetSeparateResultWindow(
$enable
)
|
|
Determines whether command execution result should be opened within a separate browser window.
Determines whether command execution result should be opened within a separate browser window.
Parameters:
API Tags:
Return: | True if command execution result should be opened within a separate browser window. |
Access: | public |
Information Tags:
void SetSvnCommandBarVisible(
$visible, boolean
$enable
)
|
|
Sets SVN command bar to visible or invisible.
Sets SVN command bar to visible or invisible.
Parameters:
boolean |
$enable: |
True if SVN command bar should be visible. |
|
$visible: |
|
Information Tags:
void SetSvnSwitchBarVisible(
$visible, boolean
$enable
)
|
|
Sets SVN switch bar to visible or invisible.
Sets SVN switch bar to visible or invisible.
Parameters:
boolean |
$enable: |
True if SVN switch bar should be visible. |
|
$visible: |
|
Information Tags:
Stores the user settings within a cookie.
Stores the user settings within a cookie.
API Tags:
Information Tags:
Does nothing else as prevent from beeing cloned.
Does nothing else as prevent from beeing cloned.
API Tags:
Information Tags: