Difference between revisions of "Sf finds"

From ARK
Jump to: navigation, search
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
These are some notes describing the sf_finds.
 
−
 
 
===Description===
 
===Description===
 +
This is a [[subforms|subform]] that originally was set up to add attributes to items. It also used to provide 'add to list' functionality. In addition, it also used to provide a set boolean mechanism so that users can actively state that attribute x was NOT true.
  
−
sf_assemblage can be used for displaying and editing attributes that have numbers chained to them. As an example, this could be used for recording the numbers of a certain type of seed in a sample, or for attaching total numbers of findtypes.
+
''This form is deprecated and has been superceded by [[sf_attr_bytype]]. Please do not configure any new subforms using sf_finds''
−
 
 
−
===Usage===
 
−
 
 
−
This form should normally be used in conjunction with [[sf_attr_bytype]]. The attribute gets added to the item and then sf_assemblage will offer you the chance to add one or more numbers to that attribute.
 
−
 
 
−
===Set-Up===
 
−
 
 
−
sf_assemblage needs a number of different 'op' variables set in the sf_conf and also it will need some custom validation set up (to allow for the chains).
 
−
 
 
−
===Examples===
 
−
 
 
−
In this example, sf_assemblage is being used to chain coordinates to a projection system that is attached to the item.
 
  
−
====the sf_conf====
+
===Additional Fields===
 +
This form does not require any additional fields.
  
−
  $conf_mcd_coords =
+
===Example Configuration===
 +
<pre>
 +
$conf_mcd_botanictypes =
 
     array(
 
     array(
 
         'view_state' => 'max',
 
         'view_state' => 'max',
 
         'edit_state' => 'view',
 
         'edit_state' => 'view',
 +
        'sf_title' => 'botanictype', //appears in the titlebar of the subform (mk nname)
 +
        'sf_html_id' => 'smp_botanictypes', //the form id tag (must be unique)
 
         'sf_nav_type' => 'full',
 
         'sf_nav_type' => 'full',
−
        'sf_title' => 'coordinates', //appears in the titlebar of the subform (mk nname)
+
         'script' => 'php/subforms/sf_finds.php',
−
        'sf_html_id' => 'fst_cd_coordinates', //the form id tag (must be unique)
+
         'op_label' => 'space',
−
         'script' => 'php/subforms/sf_assemblage.php',
 
−
        'op_assemblage_type' => 'projection',
 
−
         'op_label' => 'save',
 
 
         'op_input' => 'save',
 
         'op_input' => 'save',
 
         'fields' => array(
 
         'fields' => array(
−
             $conf_field_easting,
+
             $conf_field_botanictype
−
            $conf_field_northing
 
 
         )
 
         )
−
  );
+
);
−
 
+
</pre>
−
As you can see here this is a normal sf_conf setup except:
 
−
 
 
−
*'op_assemblage_type' - this is the type of attribute (in cor_lut_attribute) that the fields will be chained to.
 
−
 
 
−
====the fields====
 
−
 
 
−
The fields that are sent to this form - are the numbers (or in fact txt) that you want to chain to the attribute. They will need some custom validation rules setup to ensure that the add routine works correctly.
 
−
 
 
−
  //set up some custom validation for the coordinate chains
 
−
$vd_chainkey =
 
−
    array(
 
−
      'rq_func' => 'reqManual',
 
−
      'vd_func' => 'chkSet',
 
−
      'var_name' => 'itemkey',
 
−
      'force_var' => 'cor_tbl_attribute',
 
−
);
 
−
$vd_chainval =
 
−
    array(
 
−
      'rq_func' => 'reqMulti',
 
−
      'vd_func' => 'chkSet',
 
−
      'var_name' => 'itemval',
 
−
      'lv_name' => 'itemval',
 
−
      'var_locn' => 'request',
 
−
);
 
−
$conf_field_easting =
 
−
    array(
 
−
        'dataclass' => 'number',
 
−
        'classtype' => 'easting',
 
−
        'alias_tbl' => 'cor_lut_numbertype',
 
−
        'alias_col' => 'numbertype',
 
−
        'alias_src_key' => 'easting',
 
−
        'alias_type' => '1',
 
−
        'editable' => TRUE,
 
−
        'field_op_hidden' => FALSE,
 
−
        'add_validation' => $number_add_validation,
 
−
        'edt_validation' => $number_edt_validation
 
−
);
 
−
$conf_field_northing =
 
−
    array(
 
−
        'dataclass' => 'number',
 
−
        'classtype' => 'northing',
 
−
        'alias_tbl' => 'cor_lut_numbertype',
 
−
        'alias_col' => 'numbertype',
 
−
        'alias_src_key' => 'northing',
 
−
        'alias_type' => '1',
 
−
        'editable' => TRUE,
 
−
        'field_op_hidden' => FALSE,
 
−
        'add_validation' => $number_add_validation,
 
−
        'edt_validation' => $number_edt_validation
 
−
);
 
−
//add in the custom validation
 
−
$conf_field_easting['add_validation'][] = $vd_chainkey;
 
−
$conf_field_easting['add_validation'][] = $vd_chainval;
 
−
$conf_field_northing['add_validation'][] = $vd_chainkey;
 
−
$conf_field_northing['add_validation'][] = $vd_chainval;
 
  
 
[[category: Administrator]]
 
[[category: Administrator]]

Latest revision as of 23:33, 2 March 2011

Description

This is a subform that originally was set up to add attributes to items. It also used to provide 'add to list' functionality. In addition, it also used to provide a set boolean mechanism so that users can actively state that attribute x was NOT true.

This form is deprecated and has been superceded by sf_attr_bytype. Please do not configure any new subforms using sf_finds

Additional Fields

This form does not require any additional fields.

Example Configuration

$conf_mcd_botanictypes =
    array(
        'view_state' => 'max',
        'edit_state' => 'view',
        'sf_title' => 'botanictype', //appears in the titlebar of the subform (mk nname)
        'sf_html_id' => 'smp_botanictypes', //the form id tag (must be unique)
        'sf_nav_type' => 'full',
        'script' => 'php/subforms/sf_finds.php',
        'op_label' => 'space',
        'op_input' => 'save',
        'fields' => array(
            $conf_field_botanictype
        )
);
Retrieved from "https://ark.lparchaeology.com/wiki/index.php?title=Sf_finds&oldid=2098"