phpDocumentor Testlink
[ class tree: Testlink ] [ index: Testlink ] [ all elements ]

Class: tlKeyword

Source Location: /keyword.class.php

Class tlKeyword

Property Summary
mixed   $allowDuplicateKeywords  
mixed   $name  
mixed   $notes  
mixed   $testprojectID  

[ Top ]
Method Summary
static void   checkKeywordName()   Checks a keyword against syntactic rules
static void   doesKeywordExist()   checks if a keyword already exists in the database
static void   getAll()  
static void   getByID()  
static void   getByIDs()  
tlKeyword   __construct()  
void   __destruct()  
void   checkDetails()  
void   deleteFromDB()  
void   getFormatDescriptionForCSV()  
void   getFormatDescriptionForXML()   gets the format descriptor for XML
void   getInfo()  
void   initialize()  
void   readFromCSV()  
void   readFromDB()  
void   readFromSimpleXML()  
void   readFromXML()  
void   writeToCSV()  
void   writeToDB()  
void   writeToXML()  
void   _clean()  

[ Top ]
Properties
mixed   $allowDuplicateKeywords [line 30]
API Tags:
Access:  protected


[ Top ]
mixed   $name [line 21]
API Tags:
Access:  public


[ Top ]
mixed   $notes [line 24]
API Tags:
Access:  public


[ Top ]
mixed   $testprojectID [line 27]
API Tags:
Access:  public


[ Top ]
Methods
static method checkKeywordName  [line 178]

  static void checkKeywordName( $name  )

Checks a keyword against syntactic rules

Parameters:
   $name: 

API Tags:
Access:  public


[ Top ]
static method doesKeywordExist  [line 196]

  static void doesKeywordExist( &$db, $name, $tprojectID, $kwID  )

checks if a keyword already exists in the database

Parameters:
   &$db: 
   $name: 
   $tprojectID: 
   $kwID: 

API Tags:
Access:  public


[ Top ]
static method getAll  [line 157]

  static void getAll( &$db, [ $whereClause = null], [ $column = null], [ $orderBy = null], [ $detailLevel = self::TLOBJ_O_GET_DETAIL_FULL]  )

Parameters:
   &$db: 
   $whereClause: 
   $column: 
   $orderBy: 
   $detailLevel: 

API Tags:
Access:  public


[ Top ]
static method getByID  [line 147]

  static void getByID( &$db, $id, [ $detailLevel = self::TLOBJ_O_GET_DETAIL_FULL]  )

Parameters:
   &$db: 
   $id: 
   $detailLevel: 

API Tags:
Access:  public


[ Top ]
static method getByIDs  [line 152]

  static void getByIDs( &$db, $ids, [ $detailLevel = self::TLOBJ_O_GET_DETAIL_FULL]  )

Parameters:
   &$db: 
   $ids: 
   $detailLevel: 

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 48]

  tlKeyword __construct( [ $dbID = null]  )

Parameters:
   $dbID: 


Redefinition of:
tlDBObject::__construct()

[ Top ]
Destructor __destruct  [line 54]

  void __destruct( )



Redefinition of:
tlObject::__destruct()

[ Top ]
checkDetails  [line 116]

  void checkDetails( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
deleteFromDB  [line 130]

  void deleteFromDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
getFormatDescriptionForCSV  [line 259]

  void getFormatDescriptionForCSV( )


API Tags:
Access:  public


Implementation of:
iSerializationToCSV::getFormatDescriptionForCSV()

[ Top ]
getFormatDescriptionForXML  [line 217]

  void getFormatDescriptionForXML( )

gets the format descriptor for XML


API Tags:
Access:  public


Implementation of:
iSerializationToXML::getFormatDescriptionForXML()

[ Top ]
getInfo  [line 164]

  void getInfo( )


API Tags:
Access:  public


[ Top ]
initialize  [line 60]

  void initialize( $testprojectID, $name, $notes  )

Parameters:
   $testprojectID: 
   $name: 
   $notes: 


[ Top ]
readFromCSV  [line 272]

  void readFromCSV( $csv, [ $delimiter = ';']  )

Parameters:
   $csv: 
   $delimiter: 

API Tags:
Access:  public


Implementation of:
iSerializationToCSV::readFromCSV()

[ Top ]
readFromDB  [line 67]

  void readFromDB( &$db, [ $options = self::TLOBJ_O_SEARCH_BY_ID]  )

Parameters:
   &$db: 
   $options: 

API Tags:
Access:  public


[ Top ]
readFromSimpleXML  [line 238]

  void readFromSimpleXML( $keyword  )

Parameters:
   $keyword: 

API Tags:
Access:  public


Implementation of:
iSerializationToXML::readFromSimpleXML()

[ Top ]
readFromXML  [line 233]

  void readFromXML( $xml  )

Parameters:
   $xml: 

API Tags:
Access:  public


Implementation of:
iSerializationToXML::readFromXML()

[ Top ]
writeToCSV  [line 263]

  void writeToCSV( &$csv, [ $delimiter = ';']  )

Parameters:
   &$csv: 
   $delimiter: 

API Tags:
Access:  public


Implementation of:
iSerializationToCSV::writeToCSV()

[ Top ]
writeToDB  [line 88]

  void writeToDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
writeToXML  [line 222]

  void writeToXML( &$xml, [ $bNoHeader = false]  )

Parameters:
   &$xml: 
   $bNoHeader: 

API Tags:
Access:  public


Implementation of:
iSerializationToXML::writeToXML()

[ Top ]
_clean  [line 39]

  void _clean( [ $options = self::TLOBJ_O_SEARCH_BY_ID]  )

Parameters:
   $options: 

API Tags:
Access:  protected


Redefinition of:
tlObject::_clean()

[ Top ]
Constants
E_DBERROR = -8 [line 36]

[ Top ]
E_NAMEALREADYEXISTS = -4 [line 35]

[ Top ]
E_NAMELENGTH = -2 [line 34]

[ Top ]
E_NAMENOTALLOWED = -1 [line 33]

[ Top ]
E_WRONGFORMAT = -16 [line 37]

[ Top ]

Documentation generated on Fri, 03 Apr 2009 14:13:47 +0200 by phpDocumentor 1.4.1