phpDocumentor TestlinkAPI
[ class tree: TestlinkAPI ] [ index: TestlinkAPI ] [ all elements ]
TestlinkAPI
Packages:
TestlinkAPI

Files:
api.const.inc.php
APIErrors.php
APIKey.php
clientSample.php
clientSample.php
clientSample2.php
xmlrpc.php

Classes:
APIKey
TestlinkXMLRPCServer

Class: TestlinkXMLRPCServer

Source Location: /xmlrpc.php

Class TestlinkXMLRPCServer

Class Overview
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail

The entry class for serving XML-RPC Requests

See examples for additional detail

Located in /xmlrpc.php [line 64] 

IXR_Server
   |
   --TestlinkXMLRPCServer
Author(s): API Tags:
Example:  python client sample
Example:  php client sample
Example:  ruby client sample
Example:  java client sample

Information Tags:
Version:  1.0
Since:  Class available since Release 1.8.0

Properties

Methods
[ Top ]
Constant Summary
Class Overview | Constants Summary | Constants Detail | Property Summary | Properties Detail | Method Summary | Methods Detail
BUILD_GUESS_DEFAULT_MODE  
OFF  
ON  

[ Top ]
Property Summary
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail
static mixed   $assignedToParamName   string for parameter names are all defined statically
static mixed   $automatedParamName   string for parameter names are all defined statically
static mixed   $buildIDParamName   string for parameter names are all defined statically
static mixed   $buildNameParamName   string for parameter names are all defined statically
static mixed   $buildNotesParamName   string for parameter names are all defined statically
static mixed   $customFieldNameParamName   string for parameter names are all defined statically
static mixed   $deepParamName   string for parameter names are all defined statically
static mixed   $devKeyParamName   string for parameter names are all defined statically
static mixed   $executedParamName   string for parameter names are all defined statically
static mixed   $executeStatusParamName   string for parameter names are all defined statically
static mixed   $guessParamName   string for parameter names are all defined statically
static mixed   $keywordIDParamName   string for parameter names are all defined statically
static mixed   $noteParamName   string for parameter names are all defined statically
static mixed   $statusParamName   string for parameter names are all defined statically
static mixed   $testCaseExternalIDParamName   string for parameter names are all defined statically
static mixed   $testCaseIDParamName   string for parameter names are all defined statically
static mixed   $testCaseNameParamName   string for parameter names are all defined statically
static mixed   $testCasePrefixParamName   string for parameter names are all defined statically
static mixed   $testModeParamName   string for parameter names are all defined statically
static mixed   $testPlanIDParamName   string for parameter names are all defined statically
static mixed   $testProjectIDParamName   string for parameter names are all defined statically
static mixed   $testProjectNameParamName   string for parameter names are all defined statically
static mixed   $testSuiteIDParamName   string for parameter names are all defined statically
static mixed   $testSuiteNameParamName   string for parameter names are all defined statically
static mixed   $timeStampParamName   string for parameter names are all defined statically
static mixed   $validStatusList   An array containing strings for valid statuses
static mixed   $version  

[ Top ]
Method Summary
Class Overview | Property Summary | Properties Detail | Constants Summary | Constants Detail | Method Summary | Methods Detail
string   about()   Gives basic information about the API
boolean   authenticate()   authenticates a user based on the devKey provided
TestlinkXMLRPCServer   __construct()   Constructor sets up the IXR_Server and db connection
boolean   checkBuildID()   Helper method to see if the buildID provided is valid
boolean   checkGuess()   Helper method to see if the guess is set
boolean   checkStatus()   Helper method to see if the status provided is valid
boolean   checkTestCaseID()   Helper method to see if the tcid provided is valid
boolean   checkTestCaseIdentity()   Helper method to see if the testcase identity provided is valid Identity can be specified in one of these modes:
boolean   checkTestCaseName()   Helper method to see if the testcasename provided is valid
boolean   checkTestPlanID()   Helper method to see if the tplanid provided is valid
boolean   checkTestProjectID()   Helper method to see if the TestProjectID provided is valid
boolean   checkTestSuiteID()   Helper method to see if the TestSuiteID provided is valid
mixed   createBuild()   Creates a new build for a specific test plan
void   createTestCase()   Create a new test case
void   createTestProject()  
mixed   getBuildsForTestPlan()   Gets a list of active builds within a test plan
int   getLatestBuildForTestPlan()   Gets the latest build by date for a specific test plan
mixed   getProjects()   Gets a list of all projects
mixed   getProjectTestPlans()   Gets a list of test plans within a project
mixed   getTestCaseCustomFieldDesignValue()   Gets value of a Custom Field with scope='design' for a given Test case
mixed   getTestCaseIDByName()   Find a test case by its name
mixed   getTestCasesForTestPlan()   getTestCasesForTestPlan List test cases linked to a test plan
mixed   getTestCasesForTestSuite()   List test cases within a test suite
mixed   getTestSuitesForTestPlan()   List test suites within a test plan alphabetically
string   repeat()   Repeats a message back
mixed   reportTCResult()   Reports a result for a single test case
string   sayHello()   Lets you see if the server is up and running
boolean   setTestMode()   turn on/off testMode
void   updateTestCase()   Update an existing test case
void   UserHasRight()  

[ Top ]
Properties
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail
static mixed   $assignedToParamName = "assignedto" [line 136]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $automatedParamName = "automated" [line 132]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $buildIDParamName = "buildid" [line 124]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $buildNameParamName = "buildname" [line 130]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $buildNotesParamName = "buildnotes" [line 131]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $customFieldNameParamName = "customfieldname" [line 141]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $deepParamName = "deep" [line 128]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $devKeyParamName = "devKey" [line 117]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $executedParamName = "executed" [line 135]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $executeStatusParamName = "executestatus" [line 137]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $guessParamName = "guess" [line 127]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $keywordIDParamName = "keywordid" [line 134]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $noteParamName = "notes" [line 125]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $statusParamName = "status" [line 123]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCaseExternalIDParamName = "testcaseexternalid" [line 119]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCaseIDParamName = "testcaseid" [line 118]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCaseNameParamName = "testcasename" [line 133]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCasePrefixParamName = "testcaseprefix" [line 140]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testModeParamName = "testmode" [line 129]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testPlanIDParamName = "testplanid" [line 120]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testProjectIDParamName = "testprojectid" [line 121]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testProjectNameParamName = "testprojectname" [line 139]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testSuiteIDParamName = "testsuiteid" [line 122]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testSuiteNameParamName = "testsuitename" [line 138]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $timeStampParamName = "timestamp" [line 126]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $validStatusList = array("p", "f", "b") [line 150]

An array containing strings for valid statuses

API Tags:
Access:  public


[ Top ]
static mixed   $version = "1.0 Beta 3" [line 66]
API Tags:
Access:  public


[ Top ]
Methods
Class Overview | Property Summary | Properties Detail | Constants Summary | Constants Detail | Method Summary | Methods Detail
about  [line 1230]

  string about( struct $args  )

Gives basic information about the API

Parameters:
struct   $args:  not used

API Tags:
Access:  public


[ Top ]
authenticate  [line 264]

  boolean authenticate( )

authenticates a user based on the devKey provided

This is the only method that should really be used directly to authenticate
API Tags:
Access:  protected


[ Top ]
Constructor __construct  [line 156]

  TestlinkXMLRPCServer __construct( )

Constructor sets up the IXR_Server and db connection


API Tags:
Access:  public


[ Top ]
checkBuildID  [line 504]

  boolean checkBuildID( )

Helper method to see if the buildID provided is valid

This is the only method that should be called directly to check the buildID
API Tags:
Access:  protected


[ Top ]
checkGuess  [line 490]

  boolean checkGuess( )

Helper method to see if the guess is set

This is the only method that should be called directly to check the guess param

Guessing is set to true by default
API Tags:
Access:  protected


[ Top ]
checkStatus  [line 337]

  boolean checkStatus( )

Helper method to see if the status provided is valid

This is the only method that should be called directly to check the status
API Tags:
Access:  protected


[ Top ]
checkTestCaseID  [line 361]

  boolean checkTestCaseID( )

Helper method to see if the tcid provided is valid

This is the only method that should be called directly to check the tcid
API Tags:
Access:  protected


[ Top ]
checkTestCaseIdentity  [line 1677]

  boolean checkTestCaseIdentity( )

Helper method to see if the testcase identity provided is valid Identity can be specified in one of these modes:

test case internal id test case external id (PREFIX-NNNN)

This is the only method that should be called directly to check test case identoty

If everything OK, test case internal ID is setted.
API Tags:
Access:  protected


[ Top ]
checkTestCaseName  [line 309]

  boolean checkTestCaseName( )

Helper method to see if the testcasename provided is valid

This is the only method that should be called directly to check the testcasename
API Tags:
Access:  protected


[ Top ]
checkTestPlanID  [line 385]

  boolean checkTestPlanID( )

Helper method to see if the tplanid provided is valid

This is the only method that should be called directly to check the tplanid
API Tags:
Access:  protected


[ Top ]
checkTestProjectID  [line 431]

  boolean checkTestProjectID( )

Helper method to see if the TestProjectID provided is valid

This is the only method that should be called directly to check the TestProjectID
API Tags:
Access:  protected


[ Top ]
checkTestSuiteID  [line 460]

  boolean checkTestSuiteID( )

Helper method to see if the TestSuiteID provided is valid

This is the only method that should be called directly to check the TestSuiteID
API Tags:
Access:  protected


[ Top ]
createBuild  [line 1250]

  mixed createBuild( struct $args, string $args["devKey"], int $args["testplanid"], string $args["buildname"];, string $args["buildnotes"];  )

Creates a new build for a specific test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 
string   $args["buildname"];: 
string   $args["buildnotes"];: 

API Tags:
Access:  public


[ Top ]
createTestCase  [line 1578]

  void createTestCase( $args  )

Create a new test case

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
createTestProject  [line 1406]

  void createTestProject( $args  )

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
getBuildsForTestPlan  [line 1356]

  mixed getBuildsForTestPlan( struct $args, string $args["devKey"], int $args["testplanid"]  )

Gets a list of active builds within a test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 

API Tags:
Access:  public


[ Top ]
getLatestBuildForTestPlan  [line 1103]

  int getLatestBuildForTestPlan( $tplan_id, int $tplanid  )

Gets the latest build by date for a specific test plan

Parameters:
int   $tplanid: 
   $tplan_id: 

API Tags:
Access:  protected


[ Top ]
getProjects  [line 1298]

  mixed getProjects( struct $args, string $args["devKey"]  )

Gets a list of all projects

Parameters:
struct   $args: 
string   $args["devKey"]: 

API Tags:
Access:  public


[ Top ]
getProjectTestPlans  [line 1329]

  mixed getProjectTestPlans( struct $args, string $args["devKey"], int $args["testprojectid"]  )

Gets a list of test plans within a project

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testprojectid"]: 

API Tags:
Access:  public


[ Top ]
getTestCaseCustomFieldDesignValue  [line 1843]

  mixed getTestCaseCustomFieldDesignValue( struct $args, string $args["devKey"]:  )

Gets value of a Custom Field with scope='design' for a given Test case

Parameters:
struct   $args: 
string   $args["devKey"]::  used to check if operation can be done. if devKey is not valid => abort.

API Tags:
Access:  public


[ Top ]
getTestCaseIDByName  [line 1540]

  mixed getTestCaseIDByName( struct $args, string $args["devKey"], string $args["testcasename"], string $args["testsuitename"]  )

Find a test case by its name

Searching is case sensitive. The test case will only be returned if there is a definite match. If possible also pass the string for the test suite name. No results will be returned if there are test cases with the same name that match the criteria provided.

 Parameters:
struct   $args: 
string   $args["devKey"]: 
string   $args["testcasename"]: 
string   $args["testsuitename"]:  - optional

API Tags:
Access:  public


[ Top ]
getTestCasesForTestPlan  [line 1762]

  mixed getTestCasesForTestPlan( struct $args, string $args["devKey"], int $args["testplanid"], int $args["testcaseid"], int $args["buildid"], int $args["keywordid"], boolean $args["executed"], int $args["$assignedto"], string $args["executestatus"]  )

getTestCasesForTestPlan List test cases linked to a test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 
int   $args["testcaseid"]:  - optional
int   $args["buildid"]:  - optional
int   $args["keywordid"]:  - optional
boolean   $args["executed"]:  - optional
int   $args["$assignedto"]:  - optional
string   $args["executestatus"]:  - optional

API Tags:
Access:  public


[ Top ]
getTestCasesForTestSuite  [line 1478]

  mixed getTestCasesForTestSuite( struct $args, string $args["devKey"], int $args["testsuiteid"], boolean $args["deep"]  )

List test cases within a test suite

By default test cases that are contained within child suites will be returned. Set the deep flag to false if you only want test cases in the test suite provided and no child test cases.

 Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testsuiteid"]: 
boolean   $args["deep"]:  - optional (default is true)

API Tags:
Access:  public


[ Top ]
getTestSuitesForTestPlan  [line 1388]

  mixed getTestSuitesForTestPlan( struct $args, string $args["devKey"], int $args["testplanid"]  )

List test suites within a test plan alphabetically

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 

API Tags:
Access:  public


[ Top ]
repeat  [line 1216]

  string repeat( struct $args  )

Repeats a message back

Parameters:
struct   $args:  should contain $args['str'] parameter

API Tags:
Access:  public


[ Top ]
reportTCResult  [line 1618]

  mixed reportTCResult( struct $args, string $args["devKey"], int $args["testcaseid"], int $args["testplanid"], string $args["status"], int $args["buildid"], string $args["notes"], bool $args["guess"]  )

Reports a result for a single test case

See examples for additional detail

 Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testcaseid"]: 
int   $args["testplanid"]: 
string   $args["status"]:  - status is $validStatusList
int   $args["buildid"]:  - optional
string   $args["notes"]:  - optional
bool   $args["guess"]:  - optional definiing whether to guess optinal params or require them explicitly default is true (guess by default)

API Tags:
Return:  [status] => true/false of success [id] => result id or error code [message] => optional message for error message string
Access:  public
Example:  python client sample
Example:  ruby client sample
Example:  php client sample
Example:  java client sample


[ Top ]
sayHello  [line 1204]

  string sayHello( struct $args  )

Lets you see if the server is up and running

Parameters:
struct   $args:  not used

API Tags:
Return:  "Hello!"
Access:  public


[ Top ]
setTestMode  [line 1645]

  boolean setTestMode( struct $args  )

turn on/off testMode

This method is meant primarily for testing and debugging during development

 Parameters:
struct   $args: 

API Tags:
Access:  public


[ Top ]
updateTestCase  [line 1589]

  void updateTestCase( $args  )

Update an existing test case

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
UserHasRight  [line 290]

  void UserHasRight( $roleQuestion  )

Parameters:
   $roleQuestion: 

API Tags:
Access:  protected


[ Top ]
Constants
Class Overview | Constants Summary | Constants Detail | Method Summary | Methods Detail
BUILD_GUESS_DEFAULT_MODE = OFF [line 70]

[ Top ]
OFF = false [line 68]

[ Top ]
ON = true [line 69]

[ Top ]
Documentation generated on Thu, 16 Oct 2008 13:08:51 -0600 by phpDocumentor 1.4.2