blueshoes php application framework and cms            javascript_plugins
[ class tree: javascript_plugins ] [ index: javascript_plugins ] [ all elements ]

Class: Bs_InstantHelpClient

Source Location: /plugins/instanthelp/Bs_InstantHelpClient.class.js.php

Class Overview


Bs_InstantHelpClient class for jsrs (javascript remote scripting)


Author(s):

  • andrej at arn dot li

Copyright:

  • blueshoes.org

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 16]
Bs_InstantHelpClient class for jsrs (javascript remote scripting)

dependencies: /_bsJavascript/plugins/jsrs/JsrsCore.lib.js




Tags:

copyright:  blueshoes.org
author:  andrej at arn dot li


[ Top ]


Class Variables

$dbSettingName =  ''

[line 50]

if you don't want to use the global db as defined in the global.conf then you can specify a name here. make sure that the settings for this db connection are set in the global.conf, even if the connection is not open.

example: $APP['db']['mysql_life']... (so dbSettingName is mysql_life)




Tags:

var:  dbSettingName
access:  public

Type:   string


[ Top ]

$language =  ''

[line 29]


Type:   mixed


[ Top ]

$objectName =  ''

[line 22]

the name that this instance uses. this is a bit unusual, but we need it here.



Tags:

var:  objectName

Type:   string


[ Top ]

$serverUrl =  '/_bsToolbox/instanthelp/communicator.php'

[line 58]

the file on the server that will be called.

it may not have a query string. if you need one, recode some things here.




Tags:

var:  serverUrl
access:  public

Type:   string


[ Top ]

$textMode =  'html'

[line 37]

if the help text should be treated as plain text or html.

one of 'text' or 'html' (default).




Tags:

var:  textMode
access:  public

Type:   string


[ Top ]

$_issuedCalls = array()

[line 28]

vector with the elements

dictName, strKey, lang, htmlElementId



Type:   mixed


[ Top ]



Class Methods


method getText [line 83]

void getText( string dictName, string strKey, string lang, string htmlElementId)

starts a 'fetch text' request.



Tags:

access:  public


Parameters:

string   dictName   dictName (The dictionary name)
string   strKey   strKey (The "name" of the help text)
string   lang   lang (The language like "en". We could have texts in different langs.)
string   htmlElementId   htmlElementId (The element id in the html code where the help text gets automatically assigned to. Alternatively it can be a function name that gets called. Example: "alert()" (with brackets, no params).)

[ Top ]

method init [line 69]

void init( string objectName, string 1, string 2, string 3, string 4)

inits the object.



Parameters:

string   1   formName (name of the form)
string   2   firstnameId (id of the firstname field)
string   3   lastnameId (id of the lastname field)
string   4   sexId (id of the sex (gender) field)
string   objectName   objectName (name of this object, eg 'ih'.)

[ Top ]


Documentation generated on Mon, 29 Dec 2003 22:18:24 +0100 by phpDocumentor 1.2.3