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

Class: results

Source Location: /results.class.php

Class results

Class Overview

Located in /results.class.php [line 50]



		
				Author(s):
		
  • kevinlevy This class is encapsulates most functionality necessary to query the database for results to publish in reports. It returns data structures to the gui layer in a manner that are easy to display in smarty templates.
Information Tags:

Properties

Methods

[ Top ]
Property Summary
mixed   $export_file_types  
mixed   $import_file_types  

[ Top ]
Method Summary
results   results()   $builds_to_query = 'a' will query all build, $builds_to_query = -1 will prevent
void   buildBugString()   TO-DO - figure out what file to include so i don't have
array   getAggregateBuildResults()   returns total / pass / fail / blocked / not run results for each build id
array   getAggregateKeywordResults()   returns total / pass / fail / blocked / not run results for each keyword id
array   getAggregateMap()  
array   getAggregateOwnerResults()   returns total / pass / fail / blocked / not run results for each owner id
void   getAllSuites()   return map of suite id to suite name pairs of all suites
array   getFlatArray()   single-dimension array
void   getLinkedTCVersions()  
array   getMapOfLastResult()  
array   getMapOfSuiteSummary()  
array   getPrioritizedResults()   Function returns prioritized test result counter
array   getPrioritizedTestCases()   Function returns prioritized test case counter (in Test Plan)
array   getSuiteList()   TO-DO: rename this method to getExecutionsMap()
array   getSuiteStructure()   returns array which describes suite hierachy
string   getTCLink()   Function
void   getTopLevelSuites()   return map of suite id to suite name pairs of top level suites
array   getTotalsForPlan()  
void   get_export_file_types()  
void   get_import_file_types()  
void   memory_status()  
void   removeEmptySuites()  

[ Top ]
Properties
mixed   $export_file_types = array("XML" => "XML") [line 187]

[ Top ]
mixed   $import_file_types = array("XML" => "XML") [line 186]

[ Top ]
Methods
Constructor results  [line 204]

  results results( &$db, &$tplan_mgr, $tproject_info, $tplan_info, [ $suitesSelected = 'all'], [ $builds_to_query = -1], [ $lastResult = 'a'], [ $latest_results = 1], [ $keywordId = 0], [ $owner = null], [ $startTime = null], [ $endTime = null], [ $executor = null], [ $search_notes_string = null], [ $linkExecutionBuild = null], [ &$suiteStructure = null], [ &$flatArray = null], [ &$linked_tcversions = null]  )

$builds_to_query = 'a' will query all build, $builds_to_query = -1 will prevent

most logic in constructor from executing/ executions table from being queried if keyword = 0, search by keyword would not be performed

Parameters:
   &$db: 
   &$tplan_mgr: 
   $tproject_info: 
   $tplan_info: 
   $suitesSelected: 
   $builds_to_query: 
   $lastResult: 
   $latest_results: 
   $keywordId: 
   $owner: 
   $startTime: 
   $endTime: 
   $executor: 
   $search_notes_string: 
   $linkExecutionBuild: 
   &$suiteStructure: 
   &$flatArray: 
   &$linked_tcversions: 

API Tags:
Access:  public

Information Tags:
Author:  

kevinlevy

rev : 20090327 - amitkhullar - added parameter $latest_results to get the latest results only. 20071013 - franciscom - changes to fix MSSQL problems $startTime = "0000-00-00 00:00:00" -> null $endTime = "9999-01-01 00:00:00" -> null

20070916 - franciscom - interface changes


[ Top ]
buildBugString  [line 1185]

  void buildBugString( &$db, $execID  )

TO-DO - figure out what file to include so i don't have

to redefine this builds bug information for execution id written by Andreas, being implemented again by KL

Parameters:
   &$db: 
   $execID: 


[ Top ]
getAggregateBuildResults  [line 536]

  array getAggregateBuildResults( )

returns total / pass / fail / blocked / not run results for each build id


API Tags:
Access:  public


[ Top ]
getAggregateKeywordResults  [line 519]

  array getAggregateKeywordResults( )

returns total / pass / fail / blocked / not run results for each keyword id


API Tags:
Access:  public


[ Top ]
getAggregateMap  [line 578]

  array getAggregateMap( )


API Tags:
Access:  public


[ Top ]
getAggregateOwnerResults  [line 528]

  array getAggregateOwnerResults( )

returns total / pass / fail / blocked / not run results for each owner id

unassigned test cases show up under owner id = -1


API Tags:
Access:  public


[ Top ]
getAllSuites  [line 1207]

  void getAllSuites( )

return map of suite id to suite name pairs of all suites


API Tags:
Access:  public


[ Top ]
getFlatArray  [line 594]

  array getFlatArray( )

single-dimension array

with pattern level, suite name, suite id


API Tags:
Access:  public


[ Top ]
getLinkedTCVersions  [line 557]

  void getLinkedTCVersions( )


API Tags:
Access:  public


[ Top ]
getMapOfLastResult  [line 571]

  array getMapOfLastResult( )


API Tags:
Access:  public


[ Top ]
getMapOfSuiteSummary  [line 564]

  array getMapOfSuiteSummary( )


API Tags:
Access:  public


[ Top ]
getPrioritizedResults  [line 1390]

  array getPrioritizedResults( [timestamp $milestoneDate = null]  )

Function returns prioritized test result counter

Parameters:
timestamp   $milestoneDate:  - optional milestone deadline

API Tags:
Return:  with three priority counters
Access:  public


[ Top ]
getPrioritizedTestCases  [line 1440]

  array getPrioritizedTestCases( )

Function returns prioritized test case counter (in Test Plan)


API Tags:
Return:  with three priority counters
Access:  public


[ Top ]
getSuiteList  [line 545]

  array getSuiteList( )

TO-DO: rename this method to getExecutionsMap()

(resultsTC.php is 1 file (may not be only file) that references this method)


API Tags:
Access:  public


[ Top ]
getSuiteStructure  [line 553]

  array getSuiteStructure( )

returns array which describes suite hierachy


API Tags:
Access:  public


[ Top ]
getTCLink  [line 1370]

  string getTCLink( $rights, $tcID, $tcExternalID, $tcversionID, $title, $buildID  )

Function

Parameters:
   $rights: 
   $tcID: 
   $tcExternalID: 
   $tcversionID: 
   $title: 
   $buildID: 

API Tags:
Return:  Link of Test ID + Title


[ Top ]
getTopLevelSuites  [line 1227]

  void getTopLevelSuites( )

return map of suite id to suite name pairs of top level suites

iterates over top level suites and adds up totals using data from mapOfAggregate


API Tags:
Access:  public


[ Top ]
getTotalsForPlan  [line 585]

  array getTotalsForPlan( )


API Tags:
Access:  public


[ Top ]
get_export_file_types  [line 316]

  void get_export_file_types( )



[ Top ]
get_import_file_types  [line 329]

  void get_import_file_types( )



[ Top ]
memory_status  [line 1481]

  void memory_status( $pclass, $pfile, $pfunction, $pline  )

Parameters:
   $pclass: 
   $pfile: 
   $pfunction: 
   $pline: 


[ Top ]
removeEmptySuites  [line 1498]

  void removeEmptySuites( &$node, $hash_id_descr, [ $tck_map = null], [ $tplan_tcases = null], [ $assignedTo = 0]  )

Parameters:
   &$node: 
   $hash_id_descr: 
   $tck_map: 
   $tplan_tcases: 
   $assignedTo: 


[ Top ]

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