Class: requirement_spec_mgr
Source Location: /requirement_spec_mgr.class.php
Class requirement_spec_mgr
Inherited Properties, Constants, and Methods
Method Summary
| array |
get_coverage() |
get analyse based on requirements and test specification |
Methods
requirement_spec_mgr requirement_spec_mgr(
&$db
)
|
|
Parameters:
void check_title(
$title, [
$tproject_id = null], [
$parent_id = null], [
$id = null], [
$case_analysis = self::CASE_SENSITIVE]
)
|
|
Parameters:
|
|
$title: |
|
|
|
$tproject_id: |
|
|
|
$parent_id: |
|
|
|
$id: |
|
|
|
$case_analysis: |
|
void create(
$tproject_id,
$parent_id,
$title,
$scope,
$countReq,
$user_id, [
$type = 'n'], [
$node_order = null]
)
|
|
Parameters:
|
|
$tproject_id: |
|
|
|
$parent_id: |
|
|
|
$title: |
|
|
|
$scope: |
|
|
|
$countReq: |
|
|
|
$user_id: |
|
|
|
$type: |
|
|
|
$node_order: |
|
void createFromXML(
$xml,
$tproject_id,
$parent_id,
$author_id
)
|
|
Parameters:
|
|
$xml: |
|
|
|
$tproject_id: |
|
|
|
$parent_id: |
|
|
|
$author_id: |
|
void customFieldValuesAsXML(
$id:
$id, $tproject_id:
$tproject_id
)
|
|
customFieldValuesAsXML
Parameters:
|
$id: |
$id: |
requirement spec id |
|
$tproject_id: |
$tproject_id: |
test project id |
delete_deep()
Delete Req Specification, removing all children (other Req. Spec and Requirements)
Parameters:
void exportReqSpecToXML(
$id,
$tproject_id, [
$optExport = array()]
)
|
|
exportReqSpecToXML
create XML string with following req spec data - basic data (title, scope)
- custom fields values
- children: can be other req spec or requirements (tree leaves)
Developed using exportTestSuiteDataToXML() as model
Parameters:
|
|
$id: |
|
|
|
$tproject_id: |
|
|
|
$optExport: |
|
getReqTree
Example of returned value ( is a recursive one ) ( [childNodes] => Array ([0] => Array ( [id] => 216 [parent_id] => 179 [node_type_id] => 6 [node_order] => 0 [node_table] => req_specs [name] => SUB-R [childNodes] => Array ([0] => Array ( [id] => 181 [parent_id] => 216 [node_type_id] => 7 [node_order] => 0 [node_table] => requirements [name] => Gamma Ray Emissions [childNodes] => ) [1] => Array ( [id] => 182 [parent_id] => 216 [node_type_id] => 7 [node_order] => 0 [node_table] => requirements [name] => Coriolis Effet [childNodes] => ) ) ) [1] => Array ( [id] => 217 [parent_id] => 179 [node_type_id] => 6 [node_order] => 0 [node_table] => req_specs [name] => SUB-R2 [childNodes] => Array ...
Parameters:
void get_all_in_testproject(
$tproject_id, [
$order_by = " ORDER BY title"]
)
|
|
Parameters:
void get_by_title(
$title, [
$tproject_id = null], [
$parent_id = null], [
$case_analysis = self::CASE_SENSITIVE]
)
|
|
Parameters:
|
|
$title: |
|
|
|
$tproject_id: |
|
|
|
$parent_id: |
|
|
|
$case_analysis: |
|
array get_coverage(
$id, integer
$srs_id
)
|
|
get analyse based on requirements and test specification
Parameters:
API Tags:
| Return: | Coverage in three internal arrays: covered, uncovered, nottestable REQ |
Information Tags:
void get_export_file_types(
)
|
|
void get_import_file_types(
)
|
|
void get_linked_cfields(
$id, [
$tproject_id = null]
)
|
|
Parameters:
array get_metrics(
$id, integer
$srs_id
)
|
|
get requirement coverage metrics
Parameters:
API Tags:
Information Tags:
void get_requirements(
$id, [
$range = 'all'], [
$testcase_id = null], [
$order_by = " ORDER BY NH.node_order,title,req_doc_id"]
)
|
|
Parameters:
|
|
$id: |
|
|
|
$range: |
|
|
|
$testcase_id: |
|
|
|
$order_by: |
|
void get_requirements_count(
$id, [
$range = 'all'], [
$testcase_id = null]
)
|
|
Parameters:
|
|
$id: |
|
|
|
$range: |
|
|
|
$testcase_id: |
|
void html_table_of_custom_field_inputs(
$id, [
$tproject_id = null], [
$parent_id = null], [
$name_suffix = '']
)
|
|
Parameters:
|
|
$id: |
|
|
|
$tproject_id: |
|
|
|
$parent_id: |
|
|
|
$name_suffix: |
|
void html_table_of_custom_field_values(
$id,
$tproject_id
)
|
|
Parameters:
void set_order(
$map_id_order
)
|
|
Parameters:
void update(
$id,
$title,
$scope,
$countReq,
$user_id, [
$type = TL_REQ_STATUS_NOT_TESTABLE]
)
|
|
Parameters:
|
|
$id: |
|
|
|
$title: |
|
|
|
$scope: |
|
|
|
$countReq: |
|
|
|
$user_id: |
|
|
|
$type: |
|
void values_to_db(
$hash,
$node_id, [
$cf_map = null], [
$hash_type = null]
)
|
|
Parameters:
|
|
$hash: |
|
|
|
$node_id: |
|
|
|
$cf_map: |
|
|
|
$hash_type: |
|
void xmlToMapReqSpec(
$xml_item, [
$level = 0]
)
|
|
xmlToMapReqSpec
Parameters:
void xmlToReqSpec(
$source, object
$source:
)
|
|
xmlToReqSpec
Parameters:
|
object |
$source:: |
$source->type: possible values 'string', 'file' $source->value: depends of $source->type 'string' => xml string 'file' => path name of XML file |
|
|
$source: |
|
|
|