Quotes Class Reference

Quotes management (storage and access). More...

#include <quotes.h>

Inheritance diagram for Quotes:

Plugin

List of all members.

Public Member Functions

 Quotes (BotKernel *)
 Constructor.
void addQuote (string, string)
 Add a quote.
string getQuote (unsigned int)
 Return a quote.
string getRandomQuote ()
 Return a random quote.
vector< string > searchQuote (string)
 Search quotes according to a pattern.
bool delQuote (unsigned int)
 Delete a quote.
string getLastQuote ()
 Return last inserted quote.
string quoteInfos (unsigned int)
 Return informations aboute a quote.

Private Member Functions

unsigned int getNbChilds (TiXmlNode *)
 Return nodes's child's number.

Private Attributes

TiXmlDocument * doc
 Represent the xml document.
TiXmlNode * root
 Represent documents's root.
unsigned int nbQuotes
 Quotes number.


Detailed Description

Quotes management (storage and access).

This plugin stores quotes in a XML file and give access to them

Definition at line 50 of file quotes.h.


Constructor & Destructor Documentation

Quotes::Quotes ( BotKernel b  ) 


Member Function Documentation

void Quotes::addQuote ( string  host,
string  quote 
)

Add a quote.

Add a quote in the XML tree

Parameters:
host Quoter's host
quote Quote's text

Definition at line 88 of file quotes.cpp.

References doc, nbQuotes, and root.

Referenced by addQuote().

bool Quotes::delQuote ( unsigned int  index  ) 

Delete a quote.

Delete a quote

Parameters:
index Quote index (start at 1)
Returns:
True if deleted, else false

Definition at line 182 of file quotes.cpp.

References doc, nbQuotes, and root.

Referenced by delQuote().

string Quotes::getLastQuote (  ) 

Return last inserted quote.

Return last inserted quote

Returns:
last inserted quote text

Definition at line 201 of file quotes.cpp.

References getQuote(), and nbQuotes.

Referenced by lastQuote().

unsigned int Quotes::getNbChilds ( TiXmlNode *  node  )  [private]

Return nodes's child's number.

Return child number for a node

Parameters:
node Node that we want child's number
Returns:
Node's child number

Definition at line 66 of file quotes.cpp.

Referenced by Quotes().

string Quotes::getQuote ( unsigned int  index  ) 

Return a quote.

Return a quote

Parameters:
index Quote's index (start at 1)
Returns:
Quote's text

Definition at line 109 of file quotes.cpp.

References doc, Tools::intToStr(), and nbQuotes.

Referenced by getLastQuote(), getRandomQuote(), and quote().

string Quotes::getRandomQuote (  ) 

Return a random quote.

Return a random quote

Returns:
Random quote text

Definition at line 130 of file quotes.cpp.

References getQuote(), nbQuotes, and Tools::random().

Referenced by quote().

string Quotes::quoteInfos ( unsigned int  index  ) 

Return informations aboute a quote.

Return informations (date en quoter) about a quote

Parameters:
index Quote index (start at 1)
Returns:
Quote's informations

Definition at line 211 of file quotes.cpp.

References doc.

Referenced by quoteInfos().

vector< string > Quotes::searchQuote ( string  pattern  ) 

Search quotes according to a pattern.

Return quotes a quote matching to a given pattern an quotes numbers matching too

Parameters:
pattern Pattern used for search
Returns:
A quote and all quotes numbers matching

Definition at line 145 of file quotes.cpp.

References doc, Tools::intToStr(), nbQuotes, Tools::random(), and Tools::to_lower().

Referenced by searchQuote().


Member Data Documentation

TiXmlDocument* Quotes::doc [private]

Represent the xml document.

Definition at line 54 of file quotes.h.

Referenced by addQuote(), delQuote(), getQuote(), quoteInfos(), Quotes(), and searchQuote().

unsigned int Quotes::nbQuotes [private]

Quotes number.

Definition at line 58 of file quotes.h.

Referenced by addQuote(), delQuote(), getLastQuote(), getQuote(), getRandomQuote(), Quotes(), and searchQuote().

TiXmlNode* Quotes::root [private]

Represent documents's root.

Definition at line 56 of file quotes.h.

Referenced by addQuote(), delQuote(), and Quotes().


The documentation for this class was generated from the following files:

Generated on Sun Aug 16 15:28:56 2009 for trustyRC by  doxygen 1.5.8