function computed_field_field_settings in Computed Field 6
Same name and namespace in other branches
- 5 computed_field.module \computed_field_field_settings()
Implementation of cck hook_field_settings()
File
- ./
computed_field.module, line 22
Code
function computed_field_field_settings($op, $field) {
switch ($op) {
case 'form':
$form = array();
$compute_func = 'computed_field_' . $field['field_name'] . '_compute';
$display_func = 'computed_field_' . $field['field_name'] . '_display';
// these next 3 have been moved from widget to field, so they copy default values from widget
$form['code'] = array(
'#type' => 'textarea',
'#rows' => 15,
'#title' => t('Computed Code'),
'#description' => '<p>' . t('The variables available to your code are: ') . '<code>&$node, $field, and &$node_field</code>' . t('. To set the value of the field, set ') . '<code>$node_field[0][\'value\']</code>.' . '</p><p>' . t('Here\'s a simple example which sets the computed field\'s value to the value of the sum of the number fields field_a and field_b: ') . '<code>$node_field[0][\'value\'] = $node->field_a[0][\'value\'] + $node->field_b[0][\'value\'];</code>. ' . '</p><p>' . t('Alternately, this code can be supplied by your own custom function named @compute_func($node, $field, $node_field). Any code entered above will be ignored if the function is defined.', array(
'@compute_func' => $compute_func,
)) . '</p>',
'#default_value' => !empty($field['code']) ? $field['code'] : '$node_field[0][\'value\'] = "";',
'#access' => !function_exists($compute_func),
);
if (function_exists($compute_func)) {
$form['compute_func'] = array(
'#type' => 'item',
'#value' => t('This field is computed using @compute_func().', array(
'@compute_func' => $compute_func,
)),
);
}
$form['display_format'] = array(
'#type' => 'textarea',
'#title' => t('Display Format'),
'#description' => '<p>' . t('This code should assign a string to the $display variable, which will be printed as the value of the field.') . '</p><p>' . t('The stored value of the field is in $node_field_item[\'value\']. The node is available at $node') . '</p><p>' . t('Note: this code has no effect if you use the "Computed Value" formatter option.') . '</p><p>' . t('Alternately, this code can be supplied by your own custom function named @display_func($field, $element, $node). Any code entered above will be ignored if the function is defined.', array(
'@display_func' => $display_func,
)) . '</p>',
'#default_value' => !empty($field['display_format']) ? $field['display_format'] : '$display = $node_field_item[\'value\'];',
'#access' => !function_exists($display_func),
);
if (function_exists($display_func)) {
$form['display_func'] = array(
'#type' => 'item',
'#value' => t('This field is computed using @display_func().', array(
'@display_func' => $display_func,
)),
);
}
$form['store'] = array(
'#type' => 'checkbox',
'#title' => t('Store using the database settings below (required for Views use)'),
'#default_value' => is_numeric($field['store']) ? $field['store'] : 1,
);
$form['database'] = array(
'#type' => 'fieldset',
'#title' => t('Database Storage Settings'),
);
$form['database']['data_type'] = array(
'#type' => 'radios',
'#title' => t('Data Type'),
'#description' => t('The SQL datatype to store this field in.'),
'#default_value' => !empty($field['data_type']) ? $field['data_type'] : 'varchar',
'#options' => array(
'varchar' => 'varchar',
'text' => 'text',
'longtext' => 'longtext',
'int' => 'int',
'float' => 'float',
'numeric' => 'decimal',
),
'#required' => FALSE,
);
$form['database']['data_length'] = array(
'#type' => 'textfield',
'#title' => t('Data Length (varchar/text only)'),
'#description' => t('<strong>Only</strong> valid for <strong>varchar</strong> or <strong>text</strong> fields. The length of the field stored in the database.'),
'#default_value' => !empty($field['data_length']) ? $field['data_length'] : NULL,
'#required' => FALSE,
);
$form['database']['data_size'] = array(
'#type' => 'select',
'#title' => t('Data Size (int/float)'),
'#description' => t('<strong>Only</strong> valid for <strong>int</strong> or <strong>float</strong> fields. The size of the field stored in the database.'),
'#default_value' => !empty($field['data_size']) ? $field['data_size'] : 'normal',
'#options' => array(
'tiny' => 'tiny',
'small' => 'small',
'medium' => 'medium',
'normal' => 'normal',
'big' => 'big',
),
'#required' => FALSE,
);
$form['database']['data_precision'] = array(
'#type' => 'select',
'#title' => t('Decimal Precision (decimal)'),
'#description' => t('<strong>Only</strong> valid for <strong>decimal</strong> fields. The total number of digits to store in the database, including those to the right of the decimal.'),
'#options' => drupal_map_assoc(range(10, 32)),
'#default_value' => !empty($field['data_precision']) ? $field['data_precision'] : 10,
'#required' => FALSE,
);
$form['database']['data_scale'] = array(
'#type' => 'select',
'#title' => t('Decimal Scale (decimal)'),
'#description' => t('<strong>Only</strong> valid for <strong>decimal</strong> fields. The number of digits to the right of the decimal. '),
'#options' => drupal_map_assoc(range(0, 10)),
'#default_value' => !empty($field['data_scale']) ? $field['data_scale'] : 2,
'#required' => FALSE,
);
$form['database']['data_default'] = array(
'#type' => 'textfield',
'#title' => t('Default Value'),
'#default_value' => $field['data_default'],
'#required' => FALSE,
);
$form['database']['data_not_NULL'] = array(
'#type' => 'checkbox',
'#title' => t('Not NULL'),
'#default_value' => is_numeric($field['data_not_NULL']) ? $field['data_not_NULL'] : FALSE,
);
$form['database']['data_sortable'] = array(
'#type' => 'checkbox',
'#title' => t('Sortable in Views'),
'#default_value' => is_numeric($field['data_sortable']) ? $field['data_sortable'] : TRUE,
);
return $form;
case 'validate':
if ($field['store']) {
if (empty($field['data_type'])) {
form_set_error('data_type', t('To store this field in the database, please specify a data type.'));
}
if (($field['data_type'] == 'text' || $field['data_type'] == 'varchar') && empty($field['data_length'])) {
form_set_error('data_length', t('To store this field in the database, please specify the data length.'));
}
}
break;
case 'save':
return array(
'code',
'display_format',
'store',
'data_type',
'data_length',
'data_size',
'data_precision',
'data_scale',
'data_not_NULL',
'data_default',
'data_sortable',
);
case 'database columns':
if (!is_numeric($field['store'])) {
// Initial field creation! - CCK initially creates the field in the DB before the user is given a chance to configure it.
// Thus we don't know any of the field's data settings for this initial creation. Yet, if we don't set something, CCK will
// return SQL errors when trying to "migrate" the data column after configuration (in several senarios). So, we'll
// give CCK our most basic "default" data column to work with. After the user configures the field, it will be updated by
// CCK to match their chosen field data settings.
$columns = array(
'value' => array(
'type' => 'varchar',
'length' => '32',
),
);
}
elseif ($field['store']) {
// User has decided to store values in the DB, so we'll gather up information on their chosen data type.
$columns = array(
'value' => array(),
);
if ($field['data_type'] == 'longtext') {
$columns['value']['type'] = 'text';
$columns['value']['size'] = 'big';
}
else {
$columns['value']['type'] = isset($field['data_type']) ? $field['data_type'] : 'varchar';
}
// 'text' and 'varchar' fields get length settings
if ($field['data_type'] == 'text' || $field['data_type'] == 'varchar') {
$columns['value']['length'] = isset($field['data_length']) ? $field['data_length'] : 32;
}
// 'int' and 'float' fields get size settings
if ($field['data_type'] == 'int' || $field['data_type'] == 'float') {
$columns['value']['size'] = isset($field['data_size']) ? $field['data_size'] : 'normal';
}
// 'decimal' fields get precision and scale settings
if ($field['data_type'] == 'numeric') {
$columns['value']['precision'] = isset($field['data_precision']) ? $field['data_precision'] : 10;
$columns['value']['scale'] = isset($field['data_scale']) ? $field['data_scale'] : 2;
}
// Add 'not null' settings
$columns['value']['not null'] = isset($field['data_not_NULL']) ? $field['data_not_NULL'] : TRUE;
// Allow Views sorting if set
$columns['value']['sortable'] = isset($field['data_sortable']) ? $field['data_sortable'] : FALSE;
// Add default values if set
if ($field['data_default'] != '') {
$columns['value']['default'] = $field['data_default'];
}
}
else {
// User has chosen NOT to store values in the DB for their field, yet CCK is NOT comfortable having a field without a data
// column. Without a column, SQL errors will pop up on multi-value fields and other field modification senarios. (Such as the
// user later choosing to store the field in the DB.) To avoid SQL errors we'll create a small dummy field for CCK that is
// never populated with data.
$columns = array(
'value' => array(
'type' => 'int',
'size' => 'tiny',
),
);
}
return $columns;
case 'filters':
return array(
'default' => array(
'name' => t('Default'),
'operator' => 'views_handler_operator_gtlt',
),
);
case 'callbacks':
return array(
'view' => CONTENT_CALLBACK_CUSTOM,
);
case 'views data':
$allowed_values = content_allowed_values($field);
if (count($allowed_values)) {
$data = content_views_field_views_data($field);
$db_info = content_database_info($field);
$table_alias = content_views_tablename($field);
// Swap the filter handler to the 'in' operator.
$data[$table_alias][$field['field_name'] . '_value']['filter']['handler'] = 'content_handler_filter_many_to_one';
return $data;
}
}
}