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

Class: cfield_mgr

Source Location: /cfield_mgr.class.php

Class cfield_mgr

Class Overview
Descendants
Child Class Description
exec_cfield_mgr TestLink Open Source Project - http://testlink.sourceforge.net/

[ Top ]
Property Summary
mixed   $application_areas  
mixed   $builds_table  
mixed   $cfield_design_values_table  
mixed   $cfield_execution_values_table  
mixed   $cfield_node_types_table  
mixed   $cfield_testplan_design_values_table  
mixed   $cfield_testprojects_table  
mixed   $custom_fields_table  
mixed   $custom_field_types  
mixed   $db  
mixed   $enable_on_cfg  
mixed   $executions_table  
mixed   $execution_bugs_table  
mixed   $max_length_possible_values  
mixed   $max_length_value  
mixed   $name_prefix  
mixed   $nodes_hierarchy_table  
mixed   $node_types  
mixed   $node_types_table  
mixed   $object_table  
mixed   $possible_values_cfg  
mixed   $show_on_cfg  
mixed   $sizes  
mixed   $tcversions_table  
mixed   $tree_manager  
mixed   $users_table  

[ Top ]
Method Summary
cfield_mgr   cfield_mgr()  
void   build_cfield_radio()  
void   create()  
void   delete()  
void   design_values_to_db()  
void   execution_values_to_db()  
void   exportValueAsXML()   exportValueAsXML generate XML with custom field name, and custom field value useful on export to XML method for items that can have custom fields, example: test cases, test suites, req specification, etc.
void   getXMLServerParams()   function: getXMLServerParams
void   get_all()  
void   get_allowed_nodes()  
void   get_application_areas()  
void   get_available_item_type()  
void   get_available_types()  
void   get_by_id()  
void   get_by_name()  
void   get_enable_on_cfg()  
void   get_linked_cfields_at_design()  
void   get_linked_cfields_at_execution()  
void   get_linked_cfields_at_testplan_design()  
void   get_linked_to_testproject()  
void   get_name_prefix()  
void   get_possible_values_cfg()  
void   get_show_on_cfg()  
void   helper_get_tab_index()  
void   helper_get_tab_index_value()  
void   is_used()  
void   link_to_testproject()  
void   name_is_unique()  
void   remove_all_design_values_from_node()  
void   set_active_for_testproject()  
void   set_display_order()  
void   string_custom_field_input()  
void   string_custom_field_value()  
void   string_input_radio()  
void   string_input_string()  
void   testplan_design_values_to_db()  
void   unlink_from_testproject()  
void   update()  
void   whoIsUsingMe()  
void   _build_cfield()  
void   _get_ui_mgtm_cfg_for_node_type()  

[ Top ]
Properties
mixed   $application_areas = array('execution','design','testplan_design') [line 122]

[ Top ]
mixed   $builds_table = "builds" [line 90]

[ Top ]
mixed   $cfield_design_values_table = "cfield_design_values" [line 95]

[ Top ]
mixed   $cfield_execution_values_table = "cfield_execution_values" [line 96]

[ Top ]
mixed   $cfield_node_types_table = "cfield_node_types" [line 99]

[ Top ]
mixed   $cfield_testplan_design_values_table = "cfield_testplan_design_values" [line 97]

[ Top ]
mixed   $cfield_testprojects_table = 'cfield_testprojects' [line 98]

[ Top ]
mixed   $custom_fields_table = "custom_fields" [line 94]

[ Top ]
mixed   $custom_field_types = array(0=>'string',
1=>'numeric',
2=>'float',
4=>'email',
5=>'checkbox',
6=>'list',
7=>'multiselection list',
8=>'date',
9=>'radio',
10=>'datetime',
20=>'text area',
500=>'script',
501=>'server')
[line 133]

[ Top ]
mixed   $db [line 83]

Redefined in descendants as:

[ Top ]
mixed   $enable_on_cfg = array('execution' => array('testsuite' => 0,
'testplan' => 0,
'testcase' => 1,
'requirement_spec' => 0,
'requirement' => 0),'design'=>array('testsuite'=>1,'testplan'=>1,'testcase'=>1,'requirement_spec'=>0,'requirement'=>0),'testplan_design'=>array('testsuite'=>1,'testplan'=>0,'testcase'=>1,'requirement_spec'=>0,'requirement'=>0))
[line 184]

[ Top ]
mixed   $executions_table = 'executions' [line 102]

[ Top ]
mixed   $execution_bugs_table = "execution_bugs" [line 101]

[ Top ]
mixed   $max_length_possible_values = 255 [line 237]

[ Top ]
mixed   $max_length_value = 255 [line 231]

[ Top ]
mixed   $name_prefix = 'custom_field_' [line 223]

[ Top ]
mixed   $nodes_hierarchy_table = "nodes_hierarchy" [line 105]

[ Top ]
mixed   $node_types = array('testsuite',
'testplan',
'testcase',
'requirement_spec',
'requirement')
[line 171]

[ Top ]
mixed   $node_types_table = "node_types" [line 106]

[ Top ]
mixed   $object_table = "custom_fields" [line 93]

[ Top ]
mixed   $possible_values_cfg = array('string' => 0,
'numeric'=> 0,
'float'=> 0,
'email'=> 0,
'checkbox' => 1,
'list' => 1,
'multiselection list' => 1,
'date' => 0,
'radio' => 1,
'datetime' =>0,
'text area' => 0,
'script'=> 0,
'server' => 0)
[line 151]

[ Top ]
mixed   $show_on_cfg = array('execution'=>array('testsuite' => 1,
'testplan' => 1,
'testcase' => 1,
'requirement_spec' => 0,
'requirement' => 0 ),'design'=>array('testsuite'=>1,'testplan'=>1,'testcase'=>1,'requirement_spec'=>0,'requirement'=>0),'testplan_design'=>array('testsuite'=>1,'testplan'=>1,'testcase'=>1,'requirement_spec'=>0,'requirement'=>0))
[line 203]

[ Top ]
mixed   $sizes = null [line 225]

[ Top ]
mixed   $tcversions_table = 'tcversions' [line 103]

[ Top ]
mixed   $tree_manager [line 84]

[ Top ]
mixed   $users_table = "users" [line 89]

[ Top ]
Methods
Constructor cfield_mgr  [line 243]

  cfield_mgr cfield_mgr( &$db  )

Parameters:
   &$db: 


[ Top ]
build_cfield_radio  [line 2088]

  void build_cfield_radio( $custom_field_value  )

Parameters:
   $custom_field_value: 


[ Top ]
create  [line 1083]

  void create( $cf  )

Parameters:
   $cf: 


[ Top ]
delete  [line 1176]

  void delete( $id  )

Parameters:
   $id: 


[ Top ]
design_values_to_db  [line 740]

  void design_values_to_db( $hash, $node_id, [ $cf_map = null], [ $hash_type = null]  )

Parameters:
   $hash: 
   $node_id: 
   $cf_map: 
   $hash_type: 


[ Top ]
execution_values_to_db  [line 1478]

  void execution_values_to_db( $hash, $node_id, $execution_id, $testplan_id, [ $cf_map = null]  )

Parameters:
   $hash: 
   $node_id: 
   $execution_id: 
   $testplan_id: 
   $cf_map: 


[ Top ]
exportValueAsXML  [line 2153]

  void exportValueAsXML( $cfMap, map $cfMap:  )

exportValueAsXML generate XML with custom field name, and custom field value useful on export to XML method for items that can have custom fields, example: test cases, test suites, req specification, etc.

Parameters:
map   $cfMap::  key: custom file ID, value: map with at least keys 'name', 'value'
   $cfMap: 


[ Top ]
getXMLServerParams  [line 1775]

  void getXMLServerParams( $node_id  )

function: getXMLServerParams

Parameters:
   $node_id: 


[ Top ]
get_all  [line 839]

  void get_all( [ $id2exclude = null]  )

Parameters:
   $id2exclude: 


[ Top ]
get_allowed_nodes  [line 310]

  void get_allowed_nodes( )



[ Top ]
get_application_areas  [line 272]

  void get_application_areas( )



[ Top ]
get_available_item_type  [line 1049]

  void get_available_item_type( $id  )

Parameters:
   $id: 


[ Top ]
get_available_types  [line 285]

  void get_available_types( )



[ Top ]
get_by_id  [line 1030]

  void get_by_id( $id  )

Parameters:
   $id: 


[ Top ]
get_by_name  [line 1008]

  void get_by_name( $name  )

Parameters:
   $name: 


[ Top ]
get_enable_on_cfg  [line 332]

  void get_enable_on_cfg( $ui_mode  )

Parameters:
   $ui_mode: 


[ Top ]
get_linked_cfields_at_design  [line 463]

  void get_linked_cfields_at_design( $tproject_id, $enabled, [ $filters = null], [ $node_type = null], [ $node_id = null], [ $access_key = 'id']  )

Parameters:
   $tproject_id: 
   $enabled: 
   $filters: 
   $node_type: 
   $node_id: 
   $access_key: 


[ Top ]
get_linked_cfields_at_execution  [line 1368]

  void get_linked_cfields_at_execution( $tproject_id, $enabled, [ $node_type = null], [ $node_id = null], [ $execution_id = null], [ $testplan_id = null], [ $access_key = 'id']  )

Parameters:
   $tproject_id: 
   $enabled: 
   $node_type: 
   $node_id: 
   $execution_id: 
   $testplan_id: 
   $access_key: 


[ Top ]
get_linked_cfields_at_testplan_design  [line 1976]

  void get_linked_cfields_at_testplan_design( $tproject_id, $enabled, [ $node_type = null], [ $node_id = null], [ $link_id = null], [ $testplan_id = null]  )

Parameters:
   $tproject_id: 
   $enabled: 
   $node_type: 
   $node_id: 
   $link_id: 
   $testplan_id: 


[ Top ]
get_linked_to_testproject  [line 871]

  void get_linked_to_testproject( $tproject_id, [ $active = null]  )

Parameters:
   $tproject_id: 
   $active: 


[ Top ]
get_name_prefix  [line 295]

  void get_name_prefix( )



[ Top ]
get_possible_values_cfg  [line 387]

  void get_possible_values_cfg( )



[ Top ]
get_show_on_cfg  [line 340]

  void get_show_on_cfg( $ui_mode  )

Parameters:
   $ui_mode: 


[ Top ]
helper_get_tab_index  [line 1759]

  void helper_get_tab_index( )



[ Top ]
helper_get_tab_index_value  [line 1751]

  void helper_get_tab_index_value( )



[ Top ]
is_used  [line 1199]

  void is_used( $id  )

Parameters:
   $id: 


[ Top ]
link_to_testproject  [line 905]

  void link_to_testproject( $tproject_id, $cfield_ids  )

Parameters:
   $tproject_id: 
   $cfield_ids: 


[ Top ]
name_is_unique  [line 1242]

  void name_is_unique( $id, $name  )

Parameters:
   $id: 
   $name: 


[ Top ]
remove_all_design_values_from_node  [line 811]

  void remove_all_design_values_from_node( $node_id  )

Parameters:
   $node_id: 


[ Top ]
set_active_for_testproject  [line 939]

  void set_active_for_testproject( $tproject_id, $cfield_ids, $active_val  )

Parameters:
   $tproject_id: 
   $cfield_ids: 
   $active_val: 


[ Top ]
set_display_order  [line 1727]

  void set_display_order( $tproject_id, $map_field_id_display_order  )

Parameters:
   $tproject_id: 
   $map_field_id_display_order: 


[ Top ]
string_custom_field_input  [line 553]

  void string_custom_field_input( $p_field_def, [ $name_suffix = ''], [ $field_size = 0]  )

Parameters:
   $p_field_def: 
   $name_suffix: 
   $field_size: 


[ Top ]
string_custom_field_value  [line 1264]

  void string_custom_field_value( $p_field_def, $p_node_id, [ $p_value_field = 'value']  )

Parameters:
   $p_field_def: 
   $p_node_id: 
   $p_value_field: 


[ Top ]
string_input_radio  [line 2056]

  void string_input_radio( $p_field_def, $p_input_name, $p_custom_field_value  )

Parameters:
   $p_field_def: 
   $p_input_name: 
   $p_custom_field_value: 


[ Top ]
string_input_string  [line 2125]

  void string_input_string( $p_field_def, $p_input_name, $p_custom_field_value, $p_size  )

Parameters:
   $p_field_def: 
   $p_input_name: 
   $p_custom_field_value: 
   $p_size: 


[ Top ]
testplan_design_values_to_db  [line 1875]

  void testplan_design_values_to_db( $hash, $node_id, $link_id, [ $cf_map = null], [ $hash_type = null]  )

Parameters:
   $hash: 
   $node_id: 
   $link_id: 
   $cf_map: 
   $hash_type: 


[ Top ]
unlink_from_testproject  [line 973]

  void unlink_from_testproject( $tproject_id, $cfield_ids  )

Parameters:
   $tproject_id: 
   $cfield_ids: 


[ Top ]
update  [line 1140]

  void update( $cf  )

Parameters:
   $cf: 


[ Top ]
whoIsUsingMe  [line 1220]

  void whoIsUsingMe( $id  )

Parameters:
   $id: 


[ Top ]
_build_cfield  [line 1552]

  void _build_cfield( $hash, $cf_map  )

Parameters:
   $hash: 
   $cf_map: 


[ Top ]
_get_ui_mgtm_cfg_for_node_type  [line 360]

  void _get_ui_mgtm_cfg_for_node_type( $map_node_id_cfg  )

Parameters:
   $map_node_id_cfg: 


[ Top ]
Constants
CF_ENABLED = 1 [line 78]

[ Top ]
DEFAULT_INPUT_SIZE = 50 [line 71]

[ Top ]
DISABLED = 0 [line 80]

[ Top ]
ENABLED = 1 [line 79]

[ Top ]
MULTISELECTIONLIST_WINDOW_SIZE = 5 [line 72]

[ Top ]
TEXTAREA_DEFAULT_COLS = 40 [line 75]

[ Top ]
TEXTAREA_DEFAULT_ROWS = 6 [line 76]

[ Top ]

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