Class: HotwordsLib

Source Location: d:\website\PhpDocumentor\/hotwords/hotword_lib.php

Class Overview

BitBase
   |
   --HotwordsLib

Author(s):

Version:

$Header: /cvsroot/bitweaver/_bit_hotwords/hotword_lib.php,v 1.8 2007/01/06 09:46:15 squareing Exp $

Methods

Inherited Variables

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mSuccess

Inherited Methods

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::debug(): Switch debug level in database
BitBase::display(): This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb(): Return pointer to current Database
BitBase::getField(): Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid(): Determines if there is a valide database connection
BitBase::prepGetList(): Prepares parameters with default values for any getList function
BitBase::setDatabase(): Sets database mechanism for the instance
BitBase::verifyId(): Determines if any given variable exists and is a number

Class Details

[line 11]

Tags:

version:

$Header: /cvsroot/bitweaver/_bit_hotwords/hotword_lib.php,v 1.8 2007/01/06 09:46:15 squareing Exp $

[ Top ]

Class Methods

constructor HotwordsLib [line 12]

HotwordsLib HotwordsLib(
)

[ Top ]

method add_hotword [line 54]

void add_hotword(
word
$word, url
$url)

Add hotword

Parameters:

word	$word	Word to be replaced by link
url	$url	Url to be used with that word

[ Top ]

method get_hotwords [line 101]

Array get_hotwords(
)

Get hotwords

Tags:

return:

of hotwords

[ Top ]

method list_hotwords [line 21]

Data list_hotwords(
[
$offset = 0], [
$max_records = -1], [
$sort_mode = 'word_desc'], [
$find = ''])

List hotwords

Tags:

return:

array of hotwords [data] is the actual array of words [cant] is a count of the number of entries in [data]

Parameters:

	$offset
	$max_records
	$sort_mode
	$find

[ Top ]

method remove_hotword [line 70]

void remove_hotword(
word
$word)

Remove hotword

Parameters:

word

$word

Word to be removed

[ Top ]

method replace_hotwords [line 82]

String replace_hotwords(
line
$line, words
$words)

Replace hotword

Tags:

return:

with hotword link

Parameters:

line	$line	Text to be modified by adding links
words	$words	Words to be replaced by links

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:41:11 +0000 by phpDocumentor 1.3.0