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

Class: SampleXMLRPCServer

Source Location: /sample_extended_server/extended_server.php

Class SampleXMLRPCServer

Class Overview

The entry class for serving XML-RPC Requests

See examples for additional detail

Located in /sample_extended_server/extended_server.php [line 17]

IXR_Server
   |
   --TestlinkXMLRPCServer
      |
      --SampleXMLRPCServer
Author(s): Information Tags:
Version:  1.0

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From TestlinkXMLRPCServer

TestlinkXMLRPCServer::$actionOnDuplicatedNameParamName
TestlinkXMLRPCServer::$activeParamName
TestlinkXMLRPCServer::$args
TestlinkXMLRPCServer::$assignedToParamName
TestlinkXMLRPCServer::$authenticated
TestlinkXMLRPCServer::$authorLoginParamName
TestlinkXMLRPCServer::$automatedParamName
TestlinkXMLRPCServer::$bugIDParamName
TestlinkXMLRPCServer::$buildIDParamName
TestlinkXMLRPCServer::$buildNameParamName
TestlinkXMLRPCServer::$buildNotesParamName
TestlinkXMLRPCServer::$checkDuplicatedNameParamName
TestlinkXMLRPCServer::$codeStatus
TestlinkXMLRPCServer::$contentParamName
TestlinkXMLRPCServer::$customFieldNameParamName
TestlinkXMLRPCServer::$customFieldsParamName
TestlinkXMLRPCServer::$dbObj
TestlinkXMLRPCServer::$deepParamName
TestlinkXMLRPCServer::$descriptionParamName
TestlinkXMLRPCServer::$detailsParamName
TestlinkXMLRPCServer::$devKey
TestlinkXMLRPCServer::$devKeyParamName
TestlinkXMLRPCServer::$errors
TestlinkXMLRPCServer::$executedParamName
TestlinkXMLRPCServer::$executeStatusParamName
TestlinkXMLRPCServer::$executionIDParamName
TestlinkXMLRPCServer::$executionOrderParamName
TestlinkXMLRPCServer::$executionTypeParamName
TestlinkXMLRPCServer::$expectedResultsParamName
TestlinkXMLRPCServer::$fileNameParamName
TestlinkXMLRPCServer::$fileTypeParamName
TestlinkXMLRPCServer::$foreignKeyIdParamName
TestlinkXMLRPCServer::$foreignKeyTableNameParamName
TestlinkXMLRPCServer::$getStepsInfoParamName
TestlinkXMLRPCServer::$guessParamName
TestlinkXMLRPCServer::$importanceParamName
TestlinkXMLRPCServer::$internalIDParamName
TestlinkXMLRPCServer::$keywordIDParamName
TestlinkXMLRPCServer::$keywordNameParamName
TestlinkXMLRPCServer::$nodeIDParamName
TestlinkXMLRPCServer::$noteParamName
TestlinkXMLRPCServer::$optionsParamName
TestlinkXMLRPCServer::$orderParamName
TestlinkXMLRPCServer::$overwriteParamName
TestlinkXMLRPCServer::$parentIDParamName
TestlinkXMLRPCServer::$platformIDParamName
TestlinkXMLRPCServer::$platformNameParamName
TestlinkXMLRPCServer::$preconditionsParamName
TestlinkXMLRPCServer::$publicParamName
TestlinkXMLRPCServer::$reqMgr
TestlinkXMLRPCServer::$reqSpecMgr
TestlinkXMLRPCServer::$requirementsParamName
TestlinkXMLRPCServer::$statusCode
TestlinkXMLRPCServer::$statusParamName
TestlinkXMLRPCServer::$stepsParamName
TestlinkXMLRPCServer::$summaryParamName
TestlinkXMLRPCServer::$tables
TestlinkXMLRPCServer::$tcaseMgr
TestlinkXMLRPCServer::$tcVersionID
TestlinkXMLRPCServer::$testCaseExternalIDParamName
TestlinkXMLRPCServer::$testCaseIDParamName
TestlinkXMLRPCServer::$testCaseNameParamName
TestlinkXMLRPCServer::$testCasePathNameParamName
TestlinkXMLRPCServer::$testCasePrefixParamName
TestlinkXMLRPCServer::$testMode
TestlinkXMLRPCServer::$testModeParamName
TestlinkXMLRPCServer::$testPlanIDParamName
TestlinkXMLRPCServer::$testPlanNameParamName
TestlinkXMLRPCServer::$testProjectIDParamName
TestlinkXMLRPCServer::$testProjectNameParamName
TestlinkXMLRPCServer::$testSuiteIDParamName
TestlinkXMLRPCServer::$testSuiteNameParamName
TestlinkXMLRPCServer::$timeStampParamName
TestlinkXMLRPCServer::$titleParamName
TestlinkXMLRPCServer::$tplanMgr
TestlinkXMLRPCServer::$tprojectMgr
TestlinkXMLRPCServer::$urgencyParamName
TestlinkXMLRPCServer::$user
TestlinkXMLRPCServer::$userID
TestlinkXMLRPCServer::$userParamName
TestlinkXMLRPCServer::$version
TestlinkXMLRPCServer::$versionNumber
TestlinkXMLRPCServer::$versionNumberParamName

Inherited From TestlinkXMLRPCServer

TestlinkXMLRPCServer::__construct()
Constructor sets up the IXR_Server and db connection
TestlinkXMLRPCServer::about()
Gives basic information about the API
TestlinkXMLRPCServer::addTestCaseToTestPlan()
Add a test case version to a test plan
TestlinkXMLRPCServer::assignRequirements()
Assign Requirements to a test case we can assign multiple requirements.
TestlinkXMLRPCServer::authenticate()
authenticates a user based on the devKey provided
TestlinkXMLRPCServer::checkBuildID()
Helper method to see if the buildID provided is valid for testplan
TestlinkXMLRPCServer::checkDevKey()
check if Developer Key exists.
TestlinkXMLRPCServer::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
TestlinkXMLRPCServer::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>
TestlinkXMLRPCServer::checkGuess()
Helper method to see if the guess is set
TestlinkXMLRPCServer::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
TestlinkXMLRPCServer::checkReqSpecQuality()
TestlinkXMLRPCServer::checkStatus()
Helper method to see if the status provided is valid
TestlinkXMLRPCServer::checkTestCaseAncestry()
checks if a test case belongs to test project
TestlinkXMLRPCServer::checkTestCaseID()
Helper method to see if the tcid provided is valid
TestlinkXMLRPCServer::checkTestCaseIdentity()
Helper method to see if the testcase identity provided is valid Identity can be specified in one of these modes:
TestlinkXMLRPCServer::checkTestCaseName()
Helper method to see if the testcasename provided is valid
TestlinkXMLRPCServer::checkTestCaseVersionNumber()
checks if test case version number is a valid.
TestlinkXMLRPCServer::checkTestCaseVersionNumberAncestry()
checks if a test case version number is defined for a test case
TestlinkXMLRPCServer::checkTestPlanID()
Helper method to see if the tplanid provided is valid
TestlinkXMLRPCServer::checkTestProjectID()
Helper method to see if the TestProjectID provided is valid
TestlinkXMLRPCServer::checkTestSuiteID()
Helper method to see if the TestSuiteID provided is valid
TestlinkXMLRPCServer::checkTestSuiteName()
test suite name provided is valid
TestlinkXMLRPCServer::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.
TestlinkXMLRPCServer::createAttachmentTempFile()
<p>Creates a temporary file and writes the attachment content into this file.</p>
TestlinkXMLRPCServer::createBuild()
Creates a new build for a specific test plan
TestlinkXMLRPCServer::createTestCase()
createTestCase
TestlinkXMLRPCServer::createTestPlan()
create a test plan
TestlinkXMLRPCServer::createTestProject()
create a test project
TestlinkXMLRPCServer::createTestSuite()
create a test suite
TestlinkXMLRPCServer::deleteExecution()
delete an execution
TestlinkXMLRPCServer::doesUserExist()
TestlinkXMLRPCServer::getBuildsForTestPlan()
Gets a list of builds within a test plan
TestlinkXMLRPCServer::getFirstLevelTestSuitesForTestProject()
get set of test suites AT TOP LEVEL of tree on a Test Project
TestlinkXMLRPCServer::getFullPath()
Gets full path from the given node till the top using nodes_hierarchy_table
TestlinkXMLRPCServer::getKeywordSet()
getKeywordSet()
TestlinkXMLRPCServer::getLastExecutionResult()
Gets the result of LAST EXECUTION for a particular testcase on a test plan, but WITHOUT checking for a particular build
TestlinkXMLRPCServer::getLatestBuildForTestPlan()
Gets the latest build by choosing the maximum build id for a specific test plan
TestlinkXMLRPCServer::getProjects()
Gets a list of all projects
TestlinkXMLRPCServer::getProjectTestPlans()
Gets a list of test plans within a project
TestlinkXMLRPCServer::getTestCase()
get test case specification using external ir internal id
TestlinkXMLRPCServer::getTestCaseAttachments()
Gets attachments for specified test case.
TestlinkXMLRPCServer::getTestCaseCustomFieldDesignValue()
Gets value of a Custom Field with scope='design' for a given Test case
TestlinkXMLRPCServer::getTestCaseIDByName()
Find a test case by its name
TestlinkXMLRPCServer::getTestCasesForTestPlan()
getTestCasesForTestPlan List test cases linked to a test plan
TestlinkXMLRPCServer::getTestCasesForTestSuite()
List test cases within a test suite
TestlinkXMLRPCServer::getTestPlanByName()
Gets info about target test project
TestlinkXMLRPCServer::getTestPlanPlatforms()
Returns the list of platforms associated to a given test plan
TestlinkXMLRPCServer::getTestProjectByName()
Gets info about target test project
TestlinkXMLRPCServer::getTestSuiteByID()
Return a TestSuite by ID
TestlinkXMLRPCServer::getTestSuitesForTestPlan()
List test suites within a test plan alphabetically
TestlinkXMLRPCServer::getTestSuitesForTestSuite()
get list of TestSuites which are DIRECT children of a given TestSuite
TestlinkXMLRPCServer::getTotalsForTestPlan()
Gets the summarized results grouped by platform.
TestlinkXMLRPCServer::getValidKeywordSet()
TestlinkXMLRPCServer::getValidKeywordSetById()
getValidKeywordSetById()
TestlinkXMLRPCServer::getValidKeywordSetByName()
getValidKeywordSetByName()
TestlinkXMLRPCServer::isAttachmentEnabled()
<p>Checks if the attachments feature is enabled in TestLink configuration.</p>
TestlinkXMLRPCServer::repeat()
Repeats a message back
TestlinkXMLRPCServer::reportTCResult()
Reports a result for a single test case
TestlinkXMLRPCServer::sayHello()
Lets you see if the server is up and running
TestlinkXMLRPCServer::setTestMode()
turn on/off testMode
TestlinkXMLRPCServer::updateTestCase()
Update an existing test case
TestlinkXMLRPCServer::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.
TestlinkXMLRPCServer::uploadExecutionAttachment()
Uploads an attachment for an execution.
TestlinkXMLRPCServer::uploadRequirementAttachment()
Uploads an attachment for a Requirement.
TestlinkXMLRPCServer::uploadRequirementSpecificationAttachment()
Uploads an attachment for a Requirement Specification.
TestlinkXMLRPCServer::uploadTestCaseAttachment()
Uploads an attachment for a Test Case.
TestlinkXMLRPCServer::uploadTestProjectAttachment()
Uploads an attachment for a Test Project.
TestlinkXMLRPCServer::uploadTestSuiteAttachment()
Uploads an attachment for a Test Suite.
TestlinkXMLRPCServer::userHasRight()
checks if a user has requested right on test project, test plan pair.
TestlinkXMLRPCServer::_checkCreateBuildRequest()
Run all the necessary checks to see if the createBuild request is valid
TestlinkXMLRPCServer::_checkCreateTestProjectRequest()
_checkCreateTestProjectRequest
TestlinkXMLRPCServer::_checkGetBuildRequest()
Run all the necessary checks to see if the createBuild request is valid
TestlinkXMLRPCServer::_checkGetTestCaseCustomFieldDesignValueRequest()
Run all the necessary checks to see if GetTestCaseCustomFieldDesignValueRequest() can be accepted.
TestlinkXMLRPCServer::_checkGetTestCasesForTestPlanRequest()
Run all the necessary checks to see if a GetTestCasesForTestPlanRequest() can be accepted.
TestlinkXMLRPCServer::_checkTCIDAndTPIDValid()
Helper method to See if the tcid and tplanid are valid together
TestlinkXMLRPCServer::_connectToDB()
connect to the db and set up the db object
TestlinkXMLRPCServer::_getBugsForExecutionId()
get bugs linked to an execution ID
TestlinkXMLRPCServer::_getLatestBuildForTestPlan()
_getLatestBuildForTestPlan
TestlinkXMLRPCServer::_insertCustomFieldExecValues()
TestlinkXMLRPCServer::_insertExecutionBug()
Insert record into execution_bugs table
TestlinkXMLRPCServer::_insertResultToDB()
Adds the result to the database
TestlinkXMLRPCServer::_isAutomatedPresent()
Helper method to see if automated is given as one of the arguments
TestlinkXMLRPCServer::_isBuildIDPresent()
Helper method to see if a buildID is given as one of the arguments
TestlinkXMLRPCServer::_isBuildNamePresent()
Helper method to see if a buildname is given as one of the arguments
TestlinkXMLRPCServer::_isBuildNotePresent()
Helper method to see if build notes are given as one of the arguments
TestlinkXMLRPCServer::_isDeepPresent()
Helper method to see if the deep param is given as one of the arguments
TestlinkXMLRPCServer::_isDevKeyPresent()
Helper method to see if a devKey is given as one of the arguments
TestlinkXMLRPCServer::_isDevKeyValid()
Helper method to see if a devKey is valid
TestlinkXMLRPCServer::_isGuessPresent()
Helper method to see if the guess param is given as one of the arguments
TestlinkXMLRPCServer::_isNotePresent()
Helper method to see if a note is given as one of the arguments
TestlinkXMLRPCServer::_isParamPresent()
Helper method to see if a param is present
TestlinkXMLRPCServer::_isStatusPresent()
Helper method to see if the status param is given as one of the arguments
TestlinkXMLRPCServer::_isStatusValid()
Helper method to see if the status provided is valid
TestlinkXMLRPCServer::_isTestCaseExternalIDPresent()
Helper method to see if a testcasename is given as one of the arguments
TestlinkXMLRPCServer::_isTestCaseIDPresent()
Helper method to see if a tcid is given as one of the arguments
TestlinkXMLRPCServer::_isTestCaseIDValid()
Helper method to see if the tcid provided is valid
TestlinkXMLRPCServer::_isTestCaseNamePresent()
Helper method to see if a testcasename is given as one of the arguments
TestlinkXMLRPCServer::_isTestModePresent()
Helper method to see if testMode is given as one of the arguments
TestlinkXMLRPCServer::_isTestPlanIDPresent()
Helper method to see if a tplanid is given as one of the arguments
TestlinkXMLRPCServer::_isTestProjectIDPresent()
Helper method to see if a TestProjectID is given as one of the arguments
TestlinkXMLRPCServer::_isTestSuiteIDPresent()
Helper method to see if testsuiteid is given as one of the arguments
TestlinkXMLRPCServer::_isTestSuiteNamePresent()
Helper method to see if the testsuitename param is given as one of the arguments
TestlinkXMLRPCServer::_isTimeStampPresent()
Helper method to see if a timestamp is given as one of the arguments
TestlinkXMLRPCServer::_runChecks()
Run a set of functions
TestlinkXMLRPCServer::_setArgs()
TestlinkXMLRPCServer::_setBuildID()
Set the BuildID from one place
TestlinkXMLRPCServer::_setBuildID2Latest()
Set Build Id to latest build id (if test plan has builds)
TestlinkXMLRPCServer::_setTCVersion()
Helper method to set the tcVersion
TestlinkXMLRPCServer::_setTestCaseID()
Set test case internal ID
TestlinkXMLRPCServer::_updateResult()
update result of LASTE execution

Inherited From TestlinkXMLRPCServer

TestlinkXMLRPCServer::BUILD_GUESS_DEFAULT_MODE
TestlinkXMLRPCServer::OFF
TestlinkXMLRPCServer::ON
TestlinkXMLRPCServer::SET_ERROR

[ Top ]
Method Summary
SampleXMLRPCServer   __construct()  
void   getTestSuiteIDByName()  
void   uploadStats()  

[ Top ]
Methods
Constructor __construct  [line 18]

  SampleXMLRPCServer __construct( )


API Tags:
Access:  public


Redefinition of:
TestlinkXMLRPCServer::__construct()
Constructor sets up the IXR_Server and db connection

[ Top ]
getTestSuiteIDByName  [line 58]

  void getTestSuiteIDByName( $args  )

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
uploadStats  [line 81]

  void uploadStats( $args  )

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]

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