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

Class: SwcUserSettings

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

Class SwcUserSettings

Property Summary
mixed   $instance   The single instance.
mixed   $settings   Settings array.

[ Top ]
Method Summary
SwcUserSettings   __construct()   Singleton c'tor.
array   &GetIndexArray()   Returns an array that provides mapping of index. of this array is numeric and the value is the index for the internal array.
SwcUserSettings   GetInstance()   Returns the single instance of this class.
int   GetProjectFrameHeight()   Provides the height in pixel for the project frame.
int   GetProjectFrameWidth()   Provides the width in pixel for the project frame.
boolean   IsAutoUpdate()   Determines whether the webspace should automatically be updated if it is outdated.
boolean   IsMinimizeControlBar()   Determines whether the top control bar should be minimized.
boolean   IsPinProjectPage()   Determines whether the project page should always be shown, regardles of the current action.
boolean   IsSeparateResultWindow()   Determines whether command execution result should be opened within a separate browser window.
boolean   IsSvnCommandBarVisible()   Determines whether SVN command bar is visible.
boolean   IsSvnSwitchBarVisible()   Determines whether SVN switch bar is visible.
boolean   ProcessSettings()   Processes the user settings.
void   RestoreSettings()   Restores the user settings from the cookie.
boolean   ScanArrayForSettings()   Scans the given array for user settings.
void   SetAutoUpdate()   Sets whether the webspace should automatically be updated if it is outdated.
void   SetMinimizeControlBar()   Sets whether the top control bar should be minimized.
void   SetPinProjectPage()   Sets whether the project page should always be shown.
void   SetProjectFrameHeight()   Sets the height in pixel for the project frame.
void   SetProjectFrameWidth()   Sets the width in pixel for the project frame.
boolean   SetSeparateResultWindow()   Determines whether command execution result should be opened within a separate browser window.
void   SetSvnCommandBarVisible()   Sets SVN command bar to visible or invisible.
void   SetSvnSwitchBarVisible()   Sets SVN switch bar to visible or invisible.
void   StoreSettings()   Stores the user settings within a cookie.
void   __clone()   Does nothing else as prevent from beeing cloned.

[ Top ]
Properties
mixed   $instance = NULL [line 57]

The single instance.

The single instance.

API Tags:
Access:  private

Information Tags:
Since:  v1.0.0

[ Top ]
mixed   $settings = NULL [line 63]

Settings array.

Settings array.

API Tags:
Access:  private

Information Tags:
Since:  v1.0.0

[ Top ]
Methods
Constructor __construct  [line 364]

  SwcUserSettings __construct( )

Singleton c'tor.

Singleton c'tor. Initializes user settings with default values.


API Tags:
Access:  private

Information Tags:
Since:  v1.0.0

[ Top ]
GetIndexArray  [line 344]

  array &GetIndexArray( )

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:
Since:  v1.0.0

[ Top ]
GetInstance  [line 71]

  SwcUserSettings GetInstance( )

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:
Since:  v1.0.0

[ Top ]
GetProjectFrameHeight  [line 193]

  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:
Since:  v1.0.0

[ Top ]
GetProjectFrameWidth  [line 173]

  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:
Since:  v1.0.0

[ Top ]
IsAutoUpdate  [line 127]

  boolean IsAutoUpdate( )

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:
Since:  v1.0.0

[ Top ]
IsMinimizeControlBar  [line 84]

  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:
Since:  v1.0.0

[ Top ]
IsPinProjectPage  [line 105]

  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:
Since:  v1.0.0

[ Top ]
IsSeparateResultWindow  [line 163]

  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:
Since:  v1.0.0

[ Top ]
IsSvnCommandBarVisible  [line 224]

  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:
Since:  v1.0.0

[ Top ]
IsSvnSwitchBarVisible  [line 245]

  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:
Since:  v1.0.0

[ Top ]
ProcessSettings  [line 265]

  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:
Since:  v1.0.0

[ Top ]
RestoreSettings  [line 316]

  void RestoreSettings( )

Restores the user settings from the cookie.

Restores the user settings from the cookie.


API Tags:
Access:  private

Information Tags:
Since:  v1.0.0

[ Top ]
ScanArrayForSettings  [line 279]

  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:
Since:  v1.0.0

[ Top ]
SetAutoUpdate  [line 139]

  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:
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
SetMinimizeControlBar  [line 94]

  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:
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
SetPinProjectPage  [line 115]

  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:
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
SetProjectFrameHeight  [line 203]

  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:
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
SetProjectFrameWidth  [line 183]

  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:
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
SetSeparateResultWindow  [line 151]

  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:
   $enable: 

API Tags:
Return:  True if command execution result should be opened within a separate browser window.
Access:  public

Information Tags:
Since:  v1.0.0

[ Top ]
SetSvnCommandBarVisible  [line 214]

  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:
Since:  v1.0.0

[ Top ]
SetSvnSwitchBarVisible  [line 235]

  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:
Since:  v1.0.0

[ Top ]
StoreSettings  [line 295]

  void StoreSettings( )

Stores the user settings within a cookie.

Stores the user settings within a cookie.


API Tags:
Access:  private

Information Tags:
Since:  v1.0.0

[ Top ]
__clone  [line 383]

  void __clone( )

Does nothing else as prevent from beeing cloned.

Does nothing else as prevent from beeing cloned.


API Tags:
Access:  public

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