| plugins_instanthelp

# Class: Bs_Ih_InstantHelp Source Location: /plugins/instanthelp/Bs_Ih_InstantHelp.class.php
### Class Overview
    Bs_Object
       |
       --Bs_Ih_InstantHelp
dependencies: #### Author(s): andrej arn <mailto:andrej@arn.li> #### Version: 4.3.$Revision: 1.3 $ $Date: 2003/08/19 07:56:14 $ #### Copyright: blueshoes.org | ### Methods Bs_Ih_InstantHelp createDict getHash getText loadDict setDb setText
### Inherited Variables | ### Inherited Methods #### Class: Bs_Object Bs_Object::Bs_Object() Bs_Object::getErrors() Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack. Bs_Object::getLastError() Basic error handling: Get last error string from the global Bs_Error-error stack. Bs_Object::getLastErrors() Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors(). Bs_Object::persist() Persists this object by serializing it and saving it to a file with unique name. Bs_Object::setError() Basic error handling: Push an error string on the global Bs_Error-error stack. Bs_Object::toHtml() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::toString() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::unpersist() Fetches an object that was persisted with persist()
### Class Details [line 27] dependencies: #### Tags:
copyright: | blueshoes.org
version: | 4.3.$Revision: 1.3 $ $Date: 2003/08/19 07:56:14 $
author: | andrej arn <mailto:andrej@arn.li>
[ Top ] ### Class Methods ### constructor Bs_Ih_InstantHelp [line 48]
`Bs_Ih_InstantHelp Bs_Ih_InstantHelp( )`
constructor [ Top ] ### method createDict [line 85]
`bool createDict( string $dictName)`
creates a dictionary with the given name. if successful then the currently loaded directory will be switched to this one. #### Tags:
access: | public
#### Parameters:
string | $dictName | (must be unique)
[ Top ] ### method getHash [line 134]
`array getHash( string $lang, string $dictName)`
returns a hash where key is the strKey and value the text. #### Tags:
return: | (hash)
access: | public
#### Parameters:
string | $lang |
string | $dictName |
[ Top ] ### method getText [line 106]
`string getText( string $strKey, [string $lang = NULL], [string $dictName = NULL])`
#### Tags:
todo: | implement language handling
throws: | bs_exception on error, bool FALSE if not found.
access: | public
#### Parameters:
string | $strKey |
string | $lang | (default is NULL which means 'use default'.)
string | $dictName | (default is NULL which means 'use current'. see loadDict().)
[ Top ] ### method loadDict [line 72]
`bool loadDict( string $dictName)`
loads the dictionary specified. #### Tags:
access: | public
#### Parameters:
string | $dictName |
[ Top ] ### method setDb [line 60]
`void setDb( object $dbObj)`
if you don't wanna use the global db, set one here. #### Tags:
access: | public
#### Parameters:
object | $dbObj | (pass it by ref if you can)
[ Top ] ### method setText [line 149]
`bool setText( string $strKey, [string $lang = ''])`
#### Tags:
todo: | change the default lang handling, i think.
throws: | bs_exception (todo)
access: | public
#### Parameters:
string | $strKey |
string | $lang | (default is '')
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:11:15 +0100 by phpDocumentor 1.2.3