Class: TestlinkXMLRPCServer

Source Location: /xmlrpc.class.php

Class TestlinkXMLRPCServer

Class Overview

The entry class for serving XML-RPC Requests

See examples for additional detail

IXR_Server
   |
   --TestlinkXMLRPCServer

Author(s):

Asiel Brumfield <asielb@users.sourceforge.net>

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 ]

Descendants

Child Class	Description
SampleXMLRPCServer	The entry class for serving XML-RPC Requests

[ Top ]

Constant Summary

BUILD_GUESS_DEFAULT_MODE
OFF
ON
SET_ERROR

[ Top ]

Property Summary

static mixed	$actionOnDuplicatedNameParamName	string for parameter names are all defined statically
static mixed	$activeParamName	string for parameter names are all defined statically
static mixed	$assignedToParamName	string for parameter names are all defined statically
static mixed	$authorLoginParamName	string for parameter names are all defined statically
static mixed	$automatedParamName	string for parameter names are all defined statically
static mixed	$bugIDParamName	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	$checkDuplicatedNameParamName	string for parameter names are all defined statically
static mixed	$contentParamName	string for parameter names are all defined statically
static mixed	$customFieldNameParamName	string for parameter names are all defined statically
static mixed	$customFieldsParamName	string for parameter names are all defined statically
static mixed	$deepParamName	string for parameter names are all defined statically
static mixed	$descriptionParamName	string for parameter names are all defined statically
static mixed	$detailsParamName	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	$executionIDParamName	string for parameter names are all defined statically
static mixed	$executionOrderParamName	string for parameter names are all defined statically
static mixed	$executionTypeParamName	string for parameter names are all defined statically
static mixed	$expectedResultsParamName	string for parameter names are all defined statically
static mixed	$fileNameParamName	string for parameter names are all defined statically
static mixed	$fileTypeParamName	string for parameter names are all defined statically
static mixed	$foreignKeyIdParamName	string for parameter names are all defined statically
static mixed	$foreignKeyTableNameParamName	string for parameter names are all defined statically
static mixed	$getStepsInfoParamName	string for parameter names are all defined statically
static mixed	$guessParamName	string for parameter names are all defined statically
static mixed	$importanceParamName	string for parameter names are all defined statically
static mixed	$internalIDParamName	string for parameter names are all defined statically
static mixed	$keywordIDParamName	string for parameter names are all defined statically
static mixed	$keywordNameParamName	string for parameter names are all defined statically
static mixed	$nodeIDParamName	string for parameter names are all defined statically
static mixed	$noteParamName	string for parameter names are all defined statically
static mixed	$optionsParamName	string for parameter names are all defined statically
static mixed	$orderParamName	string for parameter names are all defined statically
static mixed	$overwriteParamName	string for parameter names are all defined statically
static mixed	$parentIDParamName	string for parameter names are all defined statically
static mixed	$platformIDParamName	string for parameter names are all defined statically
static mixed	$platformNameParamName	string for parameter names are all defined statically
static mixed	$preconditionsParamName	string for parameter names are all defined statically
static mixed	$publicParamName	string for parameter names are all defined statically
static mixed	$requirementsParamName	string for parameter names are all defined statically
static mixed	$statusParamName	string for parameter names are all defined statically
static mixed	$stepsParamName	string for parameter names are all defined statically
static mixed	$summaryParamName	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	$testCasePathNameParamName	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	$testPlanNameParamName	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	$titleParamName	string for parameter names are all defined statically
static mixed	$urgencyParamName	string for parameter names are all defined statically
static mixed	$userParamName	string for parameter names are all defined statically
static mixed	$version
static mixed	$versionNumberParamName	string for parameter names are all defined statically
mixed	$args	array where all the args are stored for requests
mixed	$authenticated	boolean to allow a method to invoke another method and avoid double auth
mixed	$codeStatus
mixed	$dbObj	The DB object used throughout the class
mixed	$devKey	The api key being used to make a request
mixed	$errors	array where error codes and messages are stored
mixed	$reqMgr
mixed	$reqSpecMgr
mixed	$statusCode	An array containing strings for valid statuses
mixed	$tables
mixed	$tcaseMgr
mixed	$tcVersionID	_checkTCIDAndTPIDValid()
mixed	$testMode	Whether the server will run in a testing mode
mixed	$tplanMgr
mixed	$tprojectMgr
mixed	$user	UserObject associated with the userID
mixed	$userID	userID associated with the devKey provided
mixed	$versionNumber

[ Top ]

Method Summary

TestlinkXMLRPCServer	__construct()	Constructor sets up the IXR_Server and db connection
string	about()	Gives basic information about the API
void	addTestCaseToTestPlan()	Add a test case version to a test plan
void	assignRequirements()	Assign Requirements to a test case we can assign multiple requirements.
boolean	authenticate()	authenticates a user based on the devKey provided
boolean	checkBuildID()	Helper method to see if the buildID provided is valid for testplan
true	checkDevKey()	check if Developer Key exists.
boolean	checkExecutionID()	Helper method to see if an execution id exists on DB no checks regarding other data like test case , test plam, build, etc are done
boolean	checkForeignKey()	<p>Checks if the given foreign key is valid. What this method basically does is query the database looking for the foreign key id in the foreign key table.</p>
boolean	checkGuess()	Helper method to see if the guess is set
boolean	checkPlatformIdentity()	Helper method to see if the platform identity provided is valid This is the only method that should be called directly to check platform identity
void	checkReqSpecQuality()
boolean	checkStatus()	Helper method to see if the status provided is valid
map	checkTestCaseAncestry()	checks if a test case belongs to test project
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	checkTestCaseVersionNumber()	checks if test case version number is a valid.
map	checkTestCaseVersionNumberAncestry()	checks if a test case version number is defined for a test case
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
boolean	checkTestSuiteName()	test suite name provided is valid
boolean	checkUploadAttachmentRequest()	<p>Checks if the attachment parameters are valid. It checks if the file_name parameter is set, if the content is set and if the file type is set. If the file type is not set, then it uses application/octet-stream.
file	createAttachmentTempFile()	<p>Creates a temporary file and writes the attachment content into this file.</p>
mixed	createBuild()	Creates a new build for a specific test plan
mixed	createTestCase()	createTestCase
mixed	createTestPlan()	create a test plan
mixed	createTestProject()	create a test project
mixed	createTestSuite()	create a test suite
mixed	deleteExecution()	delete an execution
true	doesUserExist()
if	getBuildsForTestPlan()	Gets a list of builds within a test plan
array	getFirstLevelTestSuitesForTestProject()	get set of test suites AT TOP LEVEL of tree on a Test Project
mixed	getFullPath()	Gets full path from the given node till the top using nodes_hierarchy_table
string	getKeywordSet()	getKeywordSet()
mixed	getLastExecutionResult()	Gets the result of LAST EXECUTION for a particular testcase on a test plan, but WITHOUT checking for a particular build
mixed	getLatestBuildForTestPlan()	Gets the latest build by choosing the maximum build id 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	getTestCase()	get test case specification using external ir internal id
mixed	getTestCaseAttachments()	Gets attachments for specified test case.
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	getTestPlanByName()	Gets info about target test project
mixed	getTestPlanPlatforms()	Returns the list of platforms associated to a given test plan
mixed	getTestProjectByName()	Gets info about target test project
mixed	getTestSuiteByID()	Return a TestSuite by ID
mixed	getTestSuitesForTestPlan()	List test suites within a test plan alphabetically
mixed	getTestSuitesForTestSuite()	get list of TestSuites which are DIRECT children of a given TestSuite
map	getTotalsForTestPlan()	Gets the summarized results grouped by platform.
string	getValidKeywordSet()
string	getValidKeywordSetById()	getValidKeywordSetById()
string	getValidKeywordSetByName()	getValidKeywordSetByName()
boolean	isAttachmentEnabled()	<p>Checks if the attachments feature is enabled in TestLink configuration.</p>
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
mixed	uploadAttachment()	Uploads an attachment for specified table. You must specify the table that the attachment is connected (nodes_hierarchy, builds, etc) and the foreign key id in this table.
mixed	uploadExecutionAttachment()	Uploads an attachment for an execution.
mixed	uploadRequirementAttachment()	Uploads an attachment for a Requirement.
mixed	uploadRequirementSpecificationAttachment()	Uploads an attachment for a Requirement Specification.
mixed	uploadTestCaseAttachment()	Uploads an attachment for a Test Case.
mixed	uploadTestProjectAttachment()	Uploads an attachment for a Test Project.
mixed	uploadTestSuiteAttachment()	Uploads an attachment for a Test Suite.
boolean	userHasRight()	checks if a user has requested right on test project, test plan pair.
boolean	_checkCreateBuildRequest()	Run all the necessary checks to see if the createBuild request is valid
void	_checkCreateTestProjectRequest()	_checkCreateTestProjectRequest
boolean	_checkGetBuildRequest()	Run all the necessary checks to see if the createBuild request is valid
boolean	_checkGetTestCaseCustomFieldDesignValueRequest()	Run all the necessary checks to see if GetTestCaseCustomFieldDesignValueRequest() can be accepted.
boolean	_checkGetTestCasesForTestPlanRequest()	Run all the necessary checks to see if a GetTestCasesForTestPlanRequest() can be accepted.
boolean	_checkTCIDAndTPIDValid()	Helper method to See if the tcid and tplanid are valid together
void	_connectToDB()	connect to the db and set up the db object
map	_getBugsForExecutionId()	get bugs linked to an execution ID
void	_getLatestBuildForTestPlan()	_getLatestBuildForTestPlan
void	_insertCustomFieldExecValues()
boolean	_insertExecutionBug()	Insert record into execution_bugs table
int	_insertResultToDB()	Adds the result to the database
boolean	_isAutomatedPresent()	Helper method to see if automated is given as one of the arguments
boolean	_isBuildIDPresent()	Helper method to see if a buildID is given as one of the arguments
boolean	_isBuildNamePresent()	Helper method to see if a buildname is given as one of the arguments
boolean	_isBuildNotePresent()	Helper method to see if build notes are given as one of the arguments
boolean	_isDeepPresent()	Helper method to see if the deep param is given as one of the arguments
boolean	_isDevKeyPresent()	Helper method to see if a devKey is given as one of the arguments
boolean	_isDevKeyValid()	Helper method to see if a devKey is valid
boolean	_isGuessPresent()	Helper method to see if the guess param is given as one of the arguments
boolean	_isNotePresent()	Helper method to see if a note is given as one of the arguments
boolean	_isParamPresent()	Helper method to see if a param is present
boolean	_isStatusPresent()	Helper method to see if the status param is given as one of the arguments
boolean	_isStatusValid()	Helper method to see if the status provided is valid
boolean	_isTestCaseExternalIDPresent()	Helper method to see if a testcasename is given as one of the arguments
boolean	_isTestCaseIDPresent()	Helper method to see if a tcid is given as one of the arguments
boolean	_isTestCaseIDValid()	Helper method to see if the tcid provided is valid
boolean	_isTestCaseNamePresent()	Helper method to see if a testcasename is given as one of the arguments
boolean	_isTestModePresent()	Helper method to see if testMode is given as one of the arguments
boolean	_isTestPlanIDPresent()	Helper method to see if a tplanid is given as one of the arguments
boolean	_isTestProjectIDPresent()	Helper method to see if a TestProjectID is given as one of the arguments
boolean	_isTestSuiteIDPresent()	Helper method to see if testsuiteid is given as one of the arguments
boolean	_isTestSuiteNamePresent()	Helper method to see if the testsuitename param is given as one of the arguments
boolean	_isTimeStampPresent()	Helper method to see if a timestamp is given as one of the arguments
boolean	_runChecks()	Run a set of functions
void	_setArgs()
void	_setBuildID()	Set the BuildID from one place
boolean	_setBuildID2Latest()	Set Build Id to latest build id (if test plan has builds)
boolean	_setTCVersion()	Helper method to set the tcVersion
void	_setTestCaseID()	Set test case internal ID
mixed	_updateResult()	update result of LASTE execution

[ Top ]

Properties

static mixed $actionOnDuplicatedNameParamName = "actiononduplicatedname" [line 107]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $activeParamName = "active" [line 108]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $assignedToParamName = "assignedto" [line 109]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $authorLoginParamName = "authorlogin" [line 111]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $automatedParamName = "automated" [line 110]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $bugIDParamName = "bugid" [line 113]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $buildIDParamName = "buildid" [line 114]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $buildNameParamName = "buildname" [line 115]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $buildNotesParamName = "buildnotes" [line 116]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $checkDuplicatedNameParamName = "checkduplicatedname" [line 118]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $contentParamName = "content" [line 119]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $customFieldNameParamName = "customfieldname" [line 120]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $customFieldsParamName = "customfields" [line 121]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $deepParamName = "deep" [line 123]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $descriptionParamName = "description" [line 124]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $detailsParamName = "details" [line 125]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $devKeyParamName = "devKey" [line 126]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $executedParamName = "executed" [line 130]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $executeStatusParamName = "executestatus" [line 131]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $executionIDParamName = "executionid" [line 128]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $executionOrderParamName = "executionorder" [line 129]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $executionTypeParamName = "executiontype" [line 132]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $expectedResultsParamName = "expectedresults" [line 133]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $fileNameParamName = "filename" [line 135]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $fileTypeParamName = "filetype" [line 136]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $foreignKeyIdParamName = "fkid" [line 137]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $foreignKeyTableNameParamName = "fktable" [line 138]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $getStepsInfoParamName = "getstepsinfo" [line 141]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $guessParamName = "guess" [line 140]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $importanceParamName = "importance" [line 142]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $internalIDParamName = "internalid" [line 143]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $keywordIDParamName = "keywordid" [line 144]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $keywordNameParamName = "keywords" [line 145]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $nodeIDParamName = "nodeid" [line 147]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $noteParamName = "notes" [line 148]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $optionsParamName = "options" [line 150]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $orderParamName = "order" [line 151]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $overwriteParamName = "overwrite" [line 152]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $parentIDParamName = "parentid" [line 153]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $platformIDParamName = "platformid" [line 155]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $platformNameParamName = "platformname" [line 154]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $preconditionsParamName = "preconditions" [line 156]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $publicParamName = "public" [line 157]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $requirementsParamName = "requirements" [line 159]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $statusParamName = "status" [line 162]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $stepsParamName = "steps" [line 163]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $summaryParamName = "summary" [line 161]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testCaseExternalIDParamName = "testcaseexternalid" [line 166]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testCaseIDParamName = "testcaseid" [line 165]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testCaseNameParamName = "testcasename" [line 167]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testCasePathNameParamName = "testcasepathname" [line 168]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testCasePrefixParamName = "testcaseprefix" [line 169]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testModeParamName = "testmode" [line 170]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testPlanIDParamName = "testplanid" [line 171]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testPlanNameParamName = "testplanname" [line 172]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testProjectIDParamName = "testprojectid" [line 173]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testProjectNameParamName = "testprojectname" [line 174]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testSuiteIDParamName = "testsuiteid" [line 175]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $testSuiteNameParamName = "testsuitename" [line 176]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $timeStampParamName = "timestamp" [line 177]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $titleParamName = "title" [line 178]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $urgencyParamName = "urgency" [line 181]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $userParamName = "user" [line 182]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

static mixed $version = "1.0" [line 52]

API Tags:

Access:

public

[ Top ]

static mixed $versionNumberParamName = "version" [line 185]

string for parameter names are all defined statically

PLEASE define in DICTIONARY ORDER

API Tags:

Access:

public

[ Top ]

mixed $args = null [line 84]

array where all the args are stored for requests

API Tags:

Access:

protected

[ Top ]

mixed $authenticated = false [line 93]

boolean to allow a method to invoke another method and avoid double auth

API Tags:

Access:

protected

[ Top ]

mixed $codeStatus [line 199]

API Tags:

Access:

public

[ Top ]

mixed $dbObj = null [line 65]

The DB object used throughout the class

API Tags:

Access:

protected

[ Top ]

mixed $devKey = null [line 90]

The api key being used to make a request

API Tags:

Access:

protected

[ Top ]

mixed $errors = array() [line 87]

array where error codes and messages are stored

API Tags:

Access:

protected

[ Top ]

mixed $reqMgr = null [line 72]

API Tags:

Access:

protected

[ Top ]

mixed $reqSpecMgr = null [line 71]

API Tags:

Access:

protected

[ Top ]

mixed $statusCode [line 198]

An array containing strings for valid statuses

Will be initialized using user configuration via config_get()

API Tags:

Access:

public

[ Top ]

mixed $tables = null [line 66]

API Tags:

Access:

protected

[ Top ]

mixed $tcaseMgr = null [line 68]

API Tags:

Access:

protected

[ Top ]

mixed $tcVersionID = null [line 98]

_checkTCIDAndTPIDValid()

API Tags:

Access:

protected

[ Top ]

mixed $testMode = false [line 75]

Whether the server will run in a testing mode

API Tags:

Access:

protected

[ Top ]

mixed $tplanMgr = null [line 70]

API Tags:

Access:

protected

[ Top ]

mixed $tprojectMgr = null [line 69]

API Tags:

Access:

protected

[ Top ]

mixed $user = null [line 81]

UserObject associated with the userID

API Tags:

Access:

protected

[ Top ]

mixed $userID = null [line 78]

userID associated with the devKey provided

API Tags:

Access:

protected

[ Top ]

mixed $versionNumber = null [line 99]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 205]

TestlinkXMLRPCServer __construct(
[
$callbacks = array()] 
)

Constructor sets up the IXR_Server and db connection

Parameters:

$callbacks:

API Tags:

Access:

public

Redefined in descendants as:

SampleXMLRPCServer::__construct()

[ Top ]

about [line 1379]

string about(
struct
$args 
)

Gives basic information about the API

Parameters:

struct

$args:

not used

API Tags:

Access:

public

[ Top ]

addTestCaseToTestPlan [line 2672]

void addTestCaseToTestPlan(
args['testprojectid']
$args, args['testplanid']
1, args['testcaseexternalid']
2, args['version']
3, args['platformid']
4, args['executionorder']
5, args['urgency']
6 
)

Add a test case version to a test plan

Parameters:

args['testplanid']	1:
args['testcaseexternalid']	2:
args['version']	3:
args['platformid']	4:	- OPTIONAL Only if test plan has no platforms
args['executionorder']	5:	- OPTIONAL
args['urgency']	6:	- OPTIONAL
args['testprojectid']	$args:

API Tags:

Access:

public

[ Top ]

assignRequirements [line 2962]

void assignRequirements(
struct
$args, string
$args["devKey"], int
$args["testcaseexternalid"], int
$args["testprojectid"], string
$args["requirements"] 
)

Assign Requirements to a test case we can assign multiple requirements.

Requirements can belong to different Requirement Spec

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testcaseexternalid"]:
int	$args["testprojectid"]:
string	$args["requirements"]:	array(array('req_spec' => 1,'requirements' => array(2,4)), array('req_spec' => 3,'requirements' => array(22,42))

API Tags:

Access:

public

[ Top ]

authenticate [line 378]

boolean authenticate(
[string
$messagePrefix = ''] 
)

authenticates a user based on the devKey provided

This is the only method that should really be used directly to authenticate

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkBuildID [line 654]

boolean checkBuildID(

$msg_prefix 
)

Helper method to see if the buildID provided is valid for testplan

if build id has not been provided on call, we can use build name if has been provided.

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

Parameters:

$msg_prefix:

API Tags:

Access:

protected

[ Top ]

checkDevKey [line 4179]

true checkDevKey(
struct
$args, string
$args["devKey"] 
)

check if Developer Key exists.

Parameters:

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

API Tags:

Return:	if everything OK, otherwise error structure
Access:	public

[ Top ]

checkExecutionID [line 3804]

boolean checkExecutionID(
[
$messagePrefix = ''], [
$setError = false] 
)

Helper method to see if an execution id exists on DB no checks regarding other data like test case , test plam, build, etc are done

Parameters:

	$messagePrefix:
	$setError:

API Tags:

Access:

protected

[ Top ]

checkForeignKey [line 4509]

boolean checkForeignKey(
[
$msg_prefix = ''] 
)

Checks if the given foreign key is valid. What this method basically does is query the database looking for the foreign key id in the foreign key table.

Parameters:

$msg_prefix:

API Tags:

Return:	true if the given foreign key exists, false otherwise.
Access:	protected

Information Tags:

Since:

1.9beta6

[ Top ]

checkGuess [line 634]

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 ]

checkPlatformIdentity [line 3846]

boolean checkPlatformIdentity(
int
$tplanID, [map
$platformInfo = null], [string
$messagePrefix = ''] 
)

Helper method to see if the platform identity provided is valid This is the only method that should be called directly to check platform identity

If everything OK, platform id is setted.

Parameters:

int	$tplanID:	Test Plan ID
map	$platformInfo:	key: platform ID
string	$messagePrefix:	used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkReqSpecQuality [line 3058]

void checkReqSpecQuality(
)

API Tags:

Access:

protected

[ Top ]

checkStatus [line 467]

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 ]

checkTestCaseAncestry [line 3026]

map checkTestCaseAncestry(
[string
$messagePrefix = ''] 
)

checks if a test case belongs to test project

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Return:	with following keys boolean map['status_ok'] string map['error_msg'] int map['error_code']
Access:	protected

[ Top ]

checkTestCaseID [line 495]

boolean checkTestCaseID(
[string
$messagePrefix = ''] 
)

Helper method to see if the tcid provided is valid

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

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkTestCaseIdentity [line 2142]

boolean checkTestCaseIdentity(
[string
$messagePrefix = ''] 
)

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.

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkTestCaseName [line 439]

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 ]

checkTestCaseVersionNumber [line 2631]

boolean checkTestCaseVersionNumber(
)

checks if test case version number is a valid.

Checks is is positive intenger

API Tags:

Access:

protected

[ Top ]

checkTestCaseVersionNumberAncestry [line 4607]

map checkTestCaseVersionNumberAncestry(
[string
$messagePrefix = ''] 
)

checks if a test case version number is defined for a test case

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Return:	with following keys boolean map['status_ok'] string map['error_msg'] int map['error_code']
Access:	protected

[ Top ]

checkTestPlanID [line 525]

boolean checkTestPlanID(
[string
$messagePrefix = ''] 
)

Helper method to see if the tplanid provided is valid

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

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkTestProjectID [line 572]

boolean checkTestProjectID(
[string
$messagePrefix = ''] 
)

Helper method to see if the TestProjectID provided is valid

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

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkTestSuiteID [line 604]

boolean checkTestSuiteID(
[string
$messagePrefix = ''] 
)

Helper method to see if the TestSuiteID provided is valid

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

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkTestSuiteName [line 3363]

boolean checkTestSuiteName(
[string
$messagePrefix = ''] 
)

test suite name provided is valid

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

checkUploadAttachmentRequest [line 4542]

boolean checkUploadAttachmentRequest(
[
$msg_prefix = ''] 
)

Checks if the attachment parameters are valid. It checks if the file_name parameter is set, if the content is set and if the file type is set. If the file type is not set, then it uses application/octet-stream.

This default content type refers to binary files.

Parameters:

$msg_prefix:

API Tags:

Return:	true if the file name and the content are set
Access:	protected

Information Tags:

Since:

1.9beta6

[ Top ]

createAttachmentTempFile [line 4579]

file createAttachmentTempFile(
)

Creates a temporary file and writes the attachment content into this file.

Before writing to the file it Base64 decodes the file content.

API Tags:

Return:	handler
Access:	protected

Information Tags:

Since:

1.9beta6

[ Top ]

createBuild [line 1399]

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 1866]

mixed createTestCase(
struct
$args, string
$args["devKey"], string
$args["testcasename"], int
$args["testsuiteid"]:, int
$args["testprojectid"]:, string
$args["authorlogin"]:, string
$args["summary"], string
$args["steps"], string
$args["preconditions"], string
$args["importance"], string
$args["execution"], string
$args["order'], string
$args["internalid"], string
$args["checkduplicatedname"], string
$args["actiononduplicatedname"] 
)

createTestCase

Parameters:

struct	$args:
string	$args["devKey"]:
string	$args["testcasename"]:
int	$args["testsuiteid"]::	test case parent test suite id
int	$args["testprojectid"]::	test case parent test suite id
string	$args["authorlogin"]::	to set test case author
string	$args["summary"]:
string	$args["steps"]:
string	$args["preconditions"]:	- optional
string	$args["importance"]:	- optional - see const.inc.php for domain
string	$args["execution"]:	- optional - see ... for domain
string	$args["order']:	- optional
string	$args["internalid"]:	- optional - do not use
string	$args["checkduplicatedname"]:	- optional
string	$args["actiononduplicatedname"]:	- optional

API Tags:

Access:

public

[ Top ]

createTestPlan [line 3564]

mixed createTestPlan(
struct
$args, string
$args["devKey"], int
$args["testplanname"], int
$args["testprojectname"], string
$args["notes"],, string
$args["active"],, string
$args["public"], 
)

create a test plan

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testplanname"]:
int	$args["testprojectname"]:
string	$args["notes"],:	optional
string	$args["active"],:	optional default value 1
string	$args["public"],:	optional default value 1

API Tags:

Access:

public

[ Top ]

createTestProject [line 1587]

mixed createTestProject(
struct
$args, string
$args["devKey"], string
$args["testprojectname"], string
$args["testcaseprefix"], string
$args["notes"], map
$args["options"], int
$args["active"], int
$args["public"] 
)

create a test project

Parameters:

struct	$args:
string	$args["devKey"]:
string	$args["testprojectname"]:
string	$args["testcaseprefix"]:
string	$args["notes"]:	OPTIONAL
map	$args["options"]:	OPTIONAL ALL int treated as boolean keys requirementsEnabled,testPriorityEnabled,automationEnabled,inventoryEnabled
int	$args["active"]:	OPTIONAL
int	$args["public"]:	OPTIONAL

API Tags:

Access:

public

[ Top ]

createTestSuite [line 3268]

mixed createTestSuite(
struct
$args, string
$args["devKey"], int
$args["testprojectid"], string
$args["testsuitename"], string
$args["details"], int
$args["parentid"], int
$args["order"], int
$args["checkduplicatedname"], int
$args["actiononduplicatedname"] 
)

create a test suite

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testprojectid"]:
string	$args["testsuitename"]:
string	$args["details"]:
int	$args["parentid"]:	optional, if do not provided means test suite must be top level.
int	$args["order"]:	optional. Order inside parent container
int	$args["checkduplicatedname"]:	optional, default true. will check if there are siblings with same name.
int	$args["actiononduplicatedname"]:	optional applicable only if $args["checkduplicatedname"]=true what to do if already a sibling exists with same name.

API Tags:

Access:

public

[ Top ]

deleteExecution [line 3758]

mixed deleteExecution(
struct
$args, string
$args["devKey"], int
$args["executionid"] 
)

delete an execution

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["executionid"]:

API Tags:

Return:	[status] => true/false of success [id] => result id or error code [message] => optional message for error message string
Access:	public

[ Top ]

doesUserExist [line 4153]

true doesUserExist(
struct
$args, string
$args["devKey"], int
$args["user"] 
)

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["user"]:	user name

API Tags:

Return:	if everything OK, otherwise error structure
Access:	public

[ Top ]

getBuildsForTestPlan [line 1518]

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

Gets a list of builds within a test plan

Parameters:

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

API Tags:

Return:	no errors no build present => null array of builds
Access:	public

[ Top ]

getFirstLevelTestSuitesForTestProject [line 2924]

array getFirstLevelTestSuitesForTestProject(
args['testprojectid']
$args 
)

get set of test suites AT TOP LEVEL of tree on a Test Project

Parameters:

args['testprojectid']

$args:

API Tags:

Access:

public

[ Top ]

getFullPath [line 3655]

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

Gets full path from the given node till the top using nodes_hierarchy_table

Parameters:

struct	$args:
string	$args["devKey"]:
mixed	$args["nodeID"]:	can be just a single node or an array of INTERNAL (DB) ID

API Tags:

Access:

public

[ Top ]

getKeywordSet [line 2516]

string getKeywordSet(
int
$tproject_id 
)

getKeywordSet()

Parameters:

int

$tproject_id:

tproject_id

API Tags:

Return:	that represent a list of keyword id (comma is character separator)
Access:	protected

[ Top ]

getLastExecutionResult [line 1248]

mixed getLastExecutionResult(
struct
$args, string
$args["devKey"], int
$args["tplanid"], int
$args["testcaseid"]:, int
$args["testcaseexternalid"]: 
)

Gets the result of LAST EXECUTION for a particular testcase on a test plan, but WITHOUT checking for a particular build

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["tplanid"]:
int	$args["testcaseid"]::	optional, if does not is present testcaseexternalid must be present
int	$args["testcaseexternalid"]::	optional, if does not is present testcaseid must be present

API Tags:

Return:

if execution found, array with these keys: id (execution id),build_id,tester_id,execution_ts, status,testplan_id,tcversion_id,tcversion_number, execution_type,notes.

if test case has not been execute, array('id' => -1)

Access:

public

[ Top ]

getLatestBuildForTestPlan [line 1164]

mixed getLatestBuildForTestPlan(
struct
$args, string
$args["devKey"], int
$args["tplanid"] 
)

Gets the latest build by choosing the maximum build id for a specific test plan

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["tplanid"]:

API Tags:

Access:

public

[ Top ]

getProjects [line 1454]

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 1478]

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 ]

getTestCase [line 3505]

mixed getTestCase(
struct
$args, string
$args["devKey"], int
$args["testcaseid"]:, int
$args["testcaseexternalid"]:, int
$args["version"]: 
)

get test case specification using external ir internal id

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testcaseid"]::	optional, if does not is present testcaseexternalid must be present
int	$args["testcaseexternalid"]::	optional, if does not is present testcaseid must be present
int	$args["version"]::	optional, if does not is present max version number will be retuned

API Tags:

Access:

public

[ Top ]

getTestCaseAttachments [line 3213]

mixed getTestCaseAttachments(
struct
$args, string
$args["devKey"], int
$args["testcaseid"]:, int
$args["testcaseexternalid"]: 
)

Gets attachments for specified test case.

The attachment file content is Base64 encoded. To save the file to disk in client, Base64 decode the content and write file in binary mode.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["testcaseid"]::	optional, if does not is present testcaseexternalid must be present
int	$args["testcaseexternalid"]::	optional, if does not is present testcaseid must be present

API Tags:

Access:

public

[ Top ]

getTestCaseCustomFieldDesignValue [line 2344]

mixed getTestCaseCustomFieldDesignValue(
struct
$args, string
$args["devKey"]:, string
$args["testcaseexternalid"]:, string
$args["version"]:, string
$args["testprojectid"]:, string
$args["customfieldname"]:, string
$args["details"] 
)

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.
string	$args["testcaseexternalid"]::
string	$args["version"]::	version number
string	$args["testprojectid"]::
string	$args["customfieldname"]::	custom field name
string	$args["details"]:	optional, changes output information null or 'value' => just value 'full' => a map with all custom field definition plus value and internal test case id 'simple' => value plus custom field name, label, and type (as code).

API Tags:

Access:

public

[ Top ]

getTestCaseIDByName [line 1785]

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

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
string	$args["testprojectname"]:	- optional
string	$args["testcasepathname"]:	- optional Full test case path name, starts with test project name pieces separator -> :: -> default value of getByPathName()

API Tags:

Access:

public

[ Top ]

getTestCasesForTestPlan [line 2226]

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

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 mutual exclusive with $args["keywords"]
int	$args["keywords"]:	- optional mutual exclusive with $args["keywordid"]
boolean	$args["executed"]:	- optional
int	$args["$assignedto"]:	- optional
string	$args["executestatus"]:	- optional
array	$args["executiontype"]:	- optional
array	$args["getstepinfo"]:	- optional - default false

API Tags:

Access:

public

[ Top ]

getTestCasesForTestSuite [line 1728]

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

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)
boolean	$args["details"]:	- optional (default is simple) use full if you want to get summary,steps & expected_results

API Tags:

Access:

public

[ Top ]

getTestPlanByName [line 3435]

mixed getTestPlanByName(
struct
$args, string
$args["devKey"], string
$args["testprojectname"], string
$args["testplanname"] 
)

Gets info about target test project

Parameters:

struct	$args:
string	$args["devKey"]:
string	$args["testprojectname"]:
string	$args["testplanname"]:

API Tags:

Access:

public

[ Top ]

getTestPlanPlatforms [line 4071]

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

Returns the list of platforms associated to a given test plan

Parameters:

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

API Tags:

Access:

public

[ Top ]

getTestProjectByName [line 3395]

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

Gets info about target test project

Parameters:

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

API Tags:

Access:

public

[ Top ]

getTestSuiteByID [line 4003]

mixed getTestSuiteByID(
struct
$args, string
$args["devKey"], int
$args["testsuiteid"] 
)

Return a TestSuite by ID

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testsuiteid"]:

API Tags:

Access:

public

[ Top ]

getTestSuitesForTestPlan [line 1551]

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 ]

getTestSuitesForTestSuite [line 4041]

mixed getTestSuitesForTestSuite(
struct
$args, string
$args["devKey"], int
$args["testsuiteid"] 
)

get list of TestSuites which are DIRECT children of a given TestSuite

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testsuiteid"]:

API Tags:

Access:

public

[ Top ]

getTotalsForTestPlan [line 4121]

map getTotalsForTestPlan(
struct
$args, string
$args["devKey"], int
$args["tplanid"] 
)

Gets the summarized results grouped by platform.

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["tplanid"]:	test plan id

API Tags:

Return:

where every element has:

'type' => 'platform' 'total_tc => ZZ 'details' => array ( 'passed' => array( 'qty' => X) 'failed' => array( 'qty' => Y) 'blocked' => array( 'qty' => U) ....)

See:

testplan:getStatusTotalsByPlatform()

Access:

public

[ Top ]

getValidKeywordSet [line 2562]

string getValidKeywordSet(
$tproject_id
$tproject_id, $keywords
$keywords, $byName
$byName 
)

Parameters:

$tproject_id	$tproject_id:	the testprojectID the keywords belong
$keywords	$keywords:	array of keywords or keywordIDs
$byName	$byName:	set this to true if $keywords is an array of keywords, false if it's an array of keywordIDs

API Tags:

Return:	that represent a list of keyword id (comma is character separator)
Access:	protected

[ Top ]

getValidKeywordSetById [line 2617]

string getValidKeywordSetById(
int
$tproject_id, $keywords
$keywords 
)

getValidKeywordSetById()

Parameters:

int	$tproject_id:
$keywords	$keywords:	array of keywords ID

API Tags:

Return:	that represent a list of keyword id (comma is character separator)
Access:	protected

[ Top ]

getValidKeywordSetByName [line 2550]

string getValidKeywordSetByName(
int
$tproject_id, $keywords
$keywords 
)

getValidKeywordSetByName()

Parameters:

int	$tproject_id:
$keywords	$keywords:	array of keywords names

API Tags:

Return:	that represent a list of keyword id (comma is character separator)
Access:	protected

[ Top ]

isAttachmentEnabled [line 4489]

boolean isAttachmentEnabled(
[
$msg_prefix = ''] 
)

Checks if the attachments feature is enabled in TestLink configuration.

Parameters:

$msg_prefix:

API Tags:

Return:	true if attachments feature is enabled in TestLink configuration, false otherwise.
Access:	protected

Information Tags:

Since:

1.9beta6

[ Top ]

repeat [line 1365]

string repeat(
struct
$args 
)

Repeats a message back

Parameters:

struct

$args:

should contain $args['str'] parameter

API Tags:

Access:

public

[ Top ]

reportTCResult [line 2024]

mixed reportTCResult(
struct
$args, string
$args["devKey"], int
$args["testcaseid"]:, int
$args["testcaseexternalid"]:, int
$args["testplanid"], string
$args["status"], int
$args["buildid"], int
$args["buildname"], string
$args["notes"], bool
$args["guess"], string
$args["bugid"], string
$args["platformid"], string
$args["platformname"], string
$args["customfields"], boolean
$args["overwrite"] 
)

Reports a result for a single test case

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testcaseid"]::	optional, if not present testcaseexternalid must be present
int	$args["testcaseexternalid"]::	optional, if does not is present testcaseid must be present
int	$args["testplanid"]:
string	$args["status"]:	- status is $validStatusList
int	$args["buildid"]:	- optional. if not present and $args["buildname"] exists then $args["buildname"] will be checked and used if valid else build with HIGHEST ID will be used
int	$args["buildname"]:	- optional. if not present Build with higher internal ID will be used
string	$args["notes"]:	- optional
bool	$args["guess"]:	- optional defining whether to guess optinal params or require them explicitly default is true (guess by default)
string	$args["bugid"]:	- optional
string	$args["platformid"]:	- optional, if not present platformname must be present
string	$args["platformname"]:	- optional, if not present platformid must be present
string	$args["customfields"]:	- optional contains an map with key:Custom Field Name, value: value for CF. VERY IMPORTANT: value must be formatted in the way it's written to db, this is important for types like: DATE: strtotime() DATETIME: mktime() MULTISELECTION LIST / CHECKBOX / RADIO: se multipli selezione ! come separatore these custom fields must be configured to be writte during execution. If custom field do not meet condition value will not be written
boolean	$args["overwrite"]:	- optional, if present and true, then last execution for (testcase,testplan,build,platform) will be overwritten.

API Tags:

Return:	[status] => true/false of success [id] => result id or error code [message] => optional message for error message string
Access:	public

[ Top ]

sayHello [line 1353]

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 2108]

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 1955]

void updateTestCase(

$args 
)

Update an existing test case

Parameters:

$args:

API Tags:

Access:

public

[ Top ]

uploadAttachment [line 4396]

mixed uploadAttachment(
struct
$args, [
$messagePrefix = ''], [
$setArgs = true], string
$args["devKey"], int
$args["fkid"], string
$args["fktable"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for specified table. You must specify the table that the attachment is connected (nodes_hierarchy, builds, etc) and the foreign key id in this table.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["fkid"]:	The Attachment Foreign Key ID
string	$args["fktable"]:	The Attachment Foreign Key Table
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment
	$messagePrefix:
	$setArgs:

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the erros map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

uploadExecutionAttachment [line 4365]

mixed uploadExecutionAttachment(
struct
$args, string
$args["devKey"], int
$args["executionid"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for an execution.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["executionid"]:	execution ID
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the erros map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

uploadRequirementAttachment [line 4237]

mixed uploadRequirementAttachment(
struct
$args, string
$args["devKey"], int
$args["requirementid"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for a Requirement.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["requirementid"]:	The Requirement ID
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the erros map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

uploadRequirementSpecificationAttachment [line 4209]

mixed uploadRequirementSpecificationAttachment(
struct
$args, string
$args["devKey"], int
$args["reqspecid"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for a Requirement Specification.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["reqspecid"]:	The Requirement Specification ID
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the error map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

uploadTestCaseAttachment [line 4331]

mixed uploadTestCaseAttachment(
struct
$args, string
$args["devKey"], int
$args["testcaseid"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for a Test Case.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["testcaseid"]:	Test Case INTERNAL ID
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the erros map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

uploadTestProjectAttachment [line 4265]

mixed uploadTestProjectAttachment(
struct
$args, string
$args["devKey"], int
$args["testprojectid"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for a Test Project.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["testprojectid"]:	The Test Project ID
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the erros map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

uploadTestSuiteAttachment [line 4299]

mixed uploadTestSuiteAttachment(
struct
$args, string
$args["devKey"], int
$args["testsuiteid"], string
$args["title"], string
$args["description"], string
$args["filename"], string
$args["filetype"], string
$args["content"] 
)

Uploads an attachment for a Test Suite.

The attachment content must be Base64 encoded by the client before sending it.

Parameters:

struct	$args:
string	$args["devKey"]:	Developer key
int	$args["testsuiteid"]:	The Test Suite ID
string	$args["title"]:	(Optional) The title of the Attachment
string	$args["description"]:	(Optional) The description of the Attachment
string	$args["filename"]:	The file name of the Attachment (e.g.:notes.txt)
string	$args["filetype"]:	The file type of the Attachment (e.g.: text/plain)
string	$args["content"]:	The content (Base64 encoded) of the Attachment

API Tags:

Return:	an array containing the fk_id, fk_table, title, description, file_name, file_size and file_type. If any errors occur it returns the erros map.
Access:	public

Information Tags:

Since:

1.9beta6

[ Top ]

userHasRight [line 417]

boolean userHasRight(
string
$roleQuestion 
)

checks if a user has requested right on test project, test plan pair.

Parameters:

string

$roleQuestion:

on of the right defined in rights table

API Tags:

Access:

protected

[ Top ]

_checkCreateBuildRequest [line 1105]

boolean _checkCreateBuildRequest(
[string
$messagePrefix = ''] 
)

Run all the necessary checks to see if the createBuild request is valid

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

_checkCreateTestProjectRequest [line 1655]

void _checkCreateTestProjectRequest(

$msg_prefix 
)

_checkCreateTestProjectRequest

Parameters:

$msg_prefix:

API Tags:

Access:

protected

[ Top ]

_checkGetBuildRequest [line 1124]

boolean _checkGetBuildRequest(
)

Run all the necessary checks to see if the createBuild request is valid

API Tags:

Access:

protected

[ Top ]

_checkGetTestCaseCustomFieldDesignValueRequest [line 2440]

boolean _checkGetTestCaseCustomFieldDesignValueRequest(
[string
$messagePrefix = ''] 
)

Run all the necessary checks to see if GetTestCaseCustomFieldDesignValueRequest() can be accepted.

Custom Field exists ?
Can be used on a test case ?
Custom Field scope includes 'design' ?
is linked to testproject that owns test case ?

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

_checkGetTestCasesForTestPlanRequest [line 2304]

boolean _checkGetTestCasesForTestPlanRequest(
[string
$messagePrefix = ''] 
)

Run all the necessary checks to see if a GetTestCasesForTestPlanRequest() can be accepted.

Parameters:

string

$messagePrefix:

used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

_checkTCIDAndTPIDValid [line 1052]

boolean _checkTCIDAndTPIDValid(
[map
$platformInfo = null], [string
$messagePrefix = ''] 
)

Helper method to See if the tcid and tplanid are valid together

Parameters:

map	$platformInfo:	key: platform ID
string	$messagePrefix:	used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

_connectToDB [line 349]

void _connectToDB(
)

connect to the db and set up the db object

API Tags:

Access:

protected

[ Top ]

_getBugsForExecutionId [line 3179]

map _getBugsForExecutionId(
int
$execution_id 
)

get bugs linked to an execution ID

Parameters:

int

$execution_id:

API Tags:

Return:	indexed by bug_id
Access:	protected

[ Top ]

_getLatestBuildForTestPlan [line 1206]

void _getLatestBuildForTestPlan(
struct
$args 
)

_getLatestBuildForTestPlan

Parameters:

struct

$args:

API Tags:

Access:

protected

[ Top ]

_insertCustomFieldExecValues [line 3709]

void _insertCustomFieldExecValues(

$executionID 
)

Parameters:

$executionID:

API Tags:

Access:

protected

[ Top ]

_insertExecutionBug [line 3149]

boolean _insertExecutionBug(
int
$executionID, string
$bugID 
)

Insert record into execution_bugs table

Parameters:

int	$executionID:
string	$bugID:

API Tags:

Access:

protected

[ Top ]

_insertResultToDB [line 1300]

int _insertResultToDB(
)

Adds the result to the database

API Tags:

Access:

protected

[ Top ]

_isAutomatedPresent [line 885]

boolean _isAutomatedPresent(
)

Helper method to see if automated is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isBuildIDPresent [line 807]

boolean _isBuildIDPresent(
)

Helper method to see if a buildID is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isBuildNamePresent [line 818]

boolean _isBuildNamePresent(
)

Helper method to see if a buildname is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isBuildNotePresent [line 830]

boolean _isBuildNotePresent(
)

Helper method to see if build notes are given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isDeepPresent [line 952]

boolean _isDeepPresent(
)

Helper method to see if the deep param is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isDevKeyPresent [line 907]

boolean _isDevKeyPresent(
)

Helper method to see if a devKey is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isDevKeyValid [line 1008]

boolean _isDevKeyValid(
string
$devKey 
)

Helper method to see if a devKey is valid

Parameters:

string

$devKey:

API Tags:

Access:

protected

[ Top ]

_isGuessPresent [line 929]

boolean _isGuessPresent(
)

Helper method to see if the guess param is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isNotePresent [line 852]

boolean _isNotePresent(
)

Helper method to see if a note is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isParamPresent [line 744]

boolean _isParamPresent(
string
$pname, [string
$messagePrefix = ''], [boolean
$setError = false] 
)

Helper method to see if a param is present

Parameters:

string	$pname:	parameter name
string	$messagePrefix:	used to be prepended to error message
boolean	$setError:	default false true: add predefined error code to $this->error[]

API Tags:

Access:

protected

[ Top ]

_isStatusPresent [line 963]

boolean _isStatusPresent(
)

Helper method to see if the status param is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isStatusValid [line 761]

boolean _isStatusValid(

$status 
)

Helper method to see if the status provided is valid

Parameters:

$status:

API Tags:

Access:

protected

[ Top ]

_isTestCaseExternalIDPresent [line 783]

boolean _isTestCaseExternalIDPresent(
)

Helper method to see if a testcasename is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestCaseIDPresent [line 918]

boolean _isTestCaseIDPresent(
)

Helper method to see if a tcid is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestCaseIDValid [line 978]

boolean _isTestCaseIDValid(
struct
$tcaseid, [string
$messagePrefix = ''], [boolean
$setError = false] 
)

Helper method to see if the tcid provided is valid

Parameters:

struct	$tcaseid:
string	$messagePrefix:	used to be prepended to error message
boolean	$setError:	default false true: add predefined error code to $this->error[]

API Tags:

Access:

protected

[ Top ]

_isTestCaseNamePresent [line 772]

boolean _isTestCaseNamePresent(
)

Helper method to see if a testcasename is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestModePresent [line 896]

boolean _isTestModePresent(
)

Helper method to see if testMode is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestPlanIDPresent [line 863]

boolean _isTestPlanIDPresent(
)

Helper method to see if a tplanid is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestProjectIDPresent [line 874]

boolean _isTestProjectIDPresent(
)

Helper method to see if a TestProjectID is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestSuiteIDPresent [line 841]

boolean _isTestSuiteIDPresent(
)

Helper method to see if testsuiteid is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTestSuiteNamePresent [line 941]

boolean _isTestSuiteNamePresent(
)

Helper method to see if the testsuitename param is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_isTimeStampPresent [line 796]

boolean _isTimeStampPresent(
)

Helper method to see if a timestamp is given as one of the arguments

API Tags:

Access:

protected

[ Top ]

_runChecks [line 1140]

boolean _runChecks(
array
$checkFunctions, [string
$messagePrefix = ''] 
)

Run a set of functions

Parameters:

array	$checkFunctions:	set of function to be runned
string	$messagePrefix:	used to be prepended to error message

API Tags:

Access:

protected

[ Top ]

_setArgs [line 284]

void _setArgs(

$args 
)

Parameters:

$args:

API Tags:

Access:

protected

[ Top ]

_setBuildID [line 296]

void _setBuildID(
int
$buildID 
)

Set the BuildID from one place

Parameters:

int

$buildID:

API Tags:

Access:

protected

[ Top ]

_setBuildID2Latest [line 328]

boolean _setBuildID2Latest(
)

Set Build Id to latest build id (if test plan has builds)

API Tags:

Access:

protected

[ Top ]

_setTCVersion [line 1039]

boolean _setTCVersion(
)

Helper method to set the tcVersion

API Tags:

Access:

protected

[ Top ]

_setTestCaseID [line 317]

void _setTestCaseID(
int
$tcaseID 
)

Set test case internal ID

Parameters:

int

$tcaseID:

API Tags:

Access:

protected

[ Top ]

_updateResult [line 3942]

mixed _updateResult(
struct
$args, string
$args["devKey"], int
$args["testplanid"], int
$args["platformid"], int
$args["buildid"], int
$args["testcaseid"], string
$args["status"], string
$args["notes"] 
)

update result of LASTE execution

Parameters:

struct	$args:
string	$args["devKey"]:
int	$args["testplanid"]:
int	$args["platformid"]:
int	$args["buildid"]:
int	$args["testcaseid"]:	internal ID
string	$args["status"]:
string	$args["notes"]:

API Tags:

Access:

protected

[ Top ]

Constants

BUILD_GUESS_DEFAULT_MODE = OFF [line 57]

[ Top ]

OFF = false [line 55]

[ Top ]

ON = true [line 56]

[ Top ]

SET_ERROR = true [line 58]

[ Top ]

Documentation generated on Fri, 17 Feb 2012 16:07:49 -0500 by phpDocumentor 1.4.4

	TestlinkAPI

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