settings.js

Summary
settings.js
Settings
Variables
ngsCookieMaxLenMaximal data length in one cookie.
ngSettingsApplication settings.
Properties
StorageURLURL where settings are saved.
StorageExpiresStorage cookies expiration time (in seconds).
DelayedSaveTimeout (in ms) after the changes are saved.
Methods
SetSets setting.
GetGets setting.
BeginUpdateStarts updating settings.
EndUpdateEnds settings update.
IsValidNameChecks if given name is a valid setting name.
ClearClears all settings.
LoadSends settings load request to the server.
SaveSaves settings into cookies.
Events
OnEncodeSetting
OnSetSetting
OnGetSetting
OnSettingsSaving
OnSettingsSaved
OnSettingsLoaded

Settings

Variables

ngsCookieMaxLen

var ngsCookieMaxLen

Maximal data length in one cookie.  Default: 4050

ngSettings

Application settings.

This class is used for storing settings into cookies.

Syntax

new ngSettings (string id [, string storageurl])

Parameters

idunique ID of settings class
storageurlURL where settings are saved
Summary
Properties
StorageURLURL where settings are saved.
StorageExpiresStorage cookies expiration time (in seconds).
DelayedSaveTimeout (in ms) after the changes are saved.
Methods
SetSets setting.
GetGets setting.
BeginUpdateStarts updating settings.
EndUpdateEnds settings update.
IsValidNameChecks if given name is a valid setting name.
ClearClears all settings.
LoadSends settings load request to the server.
SaveSaves settings into cookies.
Events
OnEncodeSetting
OnSetSetting
OnGetSetting
OnSettingsSaving
OnSettingsSaved
OnSettingsLoaded

Properties

StorageURL

this.StorageURL

URL where settings are saved.

Default value: ngApp.AppPath + ‘settings/’

StorageExpires

this.StorageExpires

Storage cookies expiration time (in seconds).

Default value: 10 years

DelayedSave

this.DelayedSave

Timeout (in ms) after the changes are saved.  If 0 (zero) the changes are saved immediatelly.

Default value: 200

Methods

Set

Sets setting.

Syntax

void Set (string name, mixed value)

Parameters

namesetting name
valuesetting value

Returns

-

Get

Gets setting.

Syntax

mixed Get (string name)

Parameters

namesetting name

Returns

Value of setting.

BeginUpdate

Starts updating settings.  Any changes are saved after the EndUpdate function is called.

Syntax

void BeginUpdate ()

Returns

-

EndUpdate

Ends settings update.

Syntax

void BeginUpdate ()

Returns

-

IsValidName

Checks if given name is a valid setting name.

Syntax

bool IsValidName (string name)

Parameters

namesetting name

Returns

TRUE if name is a valid setting name.

Clear

Clears all settings.

Syntax

void Clear ()

Returns

-

Load

Sends settings load request to the server.

Syntax

void Load ()

Returns

-

Save

Saves settings into cookies.

Syntax

void Save ()

Returns

-

Events

OnEncodeSetting

OnSetSetting

OnGetSetting

OnSettingsSaving

OnSettingsSaved

OnSettingsLoaded

var ngsCookieMaxLen
Maximal data length in one cookie.
this.StorageURL
URL where settings are saved.
this.StorageExpires
Storage cookies expiration time (in seconds).
this.DelayedSave
Timeout (in ms) after the changes are saved.
Close