You are here

1.4 实现导出UI插件

admin 的头像
Submitted by admin on 星期日, 2015-09-20 07:13

作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com

再往下,就是在field_validation\plugins\export_ui里面创建field_validation_export_ui.inc文件,这里的代码有点长:

/**

 * Define this Export UI plugin.

 */

$plugin = array(

  'schema' => 'field_validation_rule',

  'access' => 'administer site configuration',

  'menu' => array(

    'menu item' => 'field_validation',

    'menu prefix' => 'admin/structure',

    'menu title' => 'Field Validation',

    'menu description' => 'Administer Field Validation rules.',

  ),

 

  'title singular' => t('rule'),

  'title plural' => t('rules'),

  'title singular proper' => t('Field Validation rule'),

  'title plural proper' => t('Field Validation rules'),

 

  'form' => array(

    'settings' => 'field_validation_ctools_export_ui_form',

    'validate' => 'field_validation_ctools_export_ui_form_validate',

    'submit' => 'field_validation_ctools_export_ui_form_submit',

  ),

);

 

/**

 * Define the add/edit form of validation rule.

 */

function field_validation_ctools_export_ui_form(&$form, &$form_state) {

  ctools_include('export');

  $rule = $form_state['item'];

  $default_rulename = isset($rule->rulename) ? $rule->rulename : '';

  $default_entity_type = isset($rule->entity_type) ? $rule->entity_type : '';

  $default_bundle = isset($rule->bundle) ? $rule->bundle : '';

  $default_field_name = isset($rule->field_name) ? $rule->field_name : '';

  $default_col = isset($rule->col) ? $rule->col : '';

  $default_validator = isset($rule->validator) ? $rule->validator : '';

  $default_data = isset($rule->data) ? $rule->data : '';

  $default_error_message = isset($rule->error_message) ? $rule->error_message : '';

  //print debug($form_state);

  

  $default_rulename = isset($form_state['values']['rulename']) ? $form_state['values']['rulename'] : $default_rulename;

  $default_entity_type = isset($form_state['values']['entity_type']) ? $form_state['values']['entity_type'] : $default_entity_type;

  $default_bundle = isset($form_state['values']['bundle']) ? $form_state['values']['bundle'] : $default_bundle;

  $default_field_name = isset($form_state['values']['field_name']) ? $form_state['values']['field_name'] : $default_field_name;

  $default_col = isset($form_state['values']['col']) ? $form_state['values']['col'] : $default_col;

  $default_validator = isset($form_state['values']['validator']) ? $form_state['values']['validator'] : $default_validator;

  $default_data = isset($form_state['values']['data']) ? $form_state['values']['data'] : $default_data;

  $default_error_message = isset($form_state['values']['error_message']) ? $form_state['values']['error_message'] : $default_error_message;

  //print debug($rule);

  

  $form['rulename'] = array(

    '#type' => 'textfield',

    '#title' => t('Rule name'),

    '#default_value' => $default_rulename,

    '#required' => TRUE,

    '#size' => 60,

    '#maxlength' => 255,

   // '#weight' => 1,

  );

 

  $entity_type_options = array(

    '' => 'Choose an entity type',

  );

  $entity_types = entity_get_info();

  foreach ($entity_types as $key => $entity_type) {

    $entity_type_options[$key] = $entity_type['label'];  

  }

  $form['entity_type'] = array(

    '#type' => 'select', 

'#options' => $entity_type_options,

'#title' => t('Entity type'),

    '#default_value' => $default_entity_type,

    '#required' => TRUE,

    '#ajax' => array(      

      'callback' => 'field_validation_entity_type_callback',      

      'wrapper' => 'validation-rule-wrapper-div',      

      'method' => 'replace',      

      'effect' => 'fade',    

    ),

  );

 

 

  $bundle_options = array(

    '' => 'Choose a bundle',

  );

 // print debug($entity_types['node']);

  $bundles = !empty($entity_types[$default_entity_type]['bundles']) ? $entity_types[$default_entity_type]['bundles'] : array();

 // $bundles = !empty($entity_types['node']['bundles']) ? $entity_types['node']['bundles'] : array();

 // print debug($default_entity_type);

  foreach ($bundles as $key => $bundle) {

    $bundle_options[$key] = $bundle['label'];  

  }

  $form['bundle'] = array(

    '#type' => 'select',

'#options' => $bundle_options,

'#title' => t('Bundle name'),

    '#default_value' => $default_bundle,

    '#required' => TRUE,

    '#prefix' => '<div id="bundle-wrapper-div">',

    '#suffix' => '</div>',

    '#ajax' => array(      

      'callback' => 'field_validation_bundle_callback',      

      'wrapper' => 'validation-rule-wrapper-div',      

      'method' => 'replace',      

      'effect' => 'fade',    

    ),

  );

  

  $field_name_options = array(

    '' => 'Choose a field',

  );

  $instances = array();

  if(!empty($default_entity_type) && !empty($default_bundle)){

    $instances = field_info_instances($default_entity_type, $default_bundle);

  }

  //$instances = field_info_instances('node', 'article');

 

  foreach ($instances as $key => $instance) {

    $field_name_options[$key] = $instance['label'];  

  }

  if(!in_array($default_field_name, array_keys($field_name_options))){

    $default_field_name = '';

  }

  $form['field_name'] = array(

    '#type' => 'select',

'#options' => $field_name_options,

    '#title' => t('Field name'),

    '#default_value' => $default_field_name,

    '#required' => TRUE,

    '#prefix' => '<div id="field-name-wrapper-div">',

    '#suffix' => '</div>',

    '#ajax' => array(      

      'callback' => 'field_validation_field_name_callback',      

      'wrapper' => 'col-wrapper-div',      

      'method' => 'replace',      

      'effect' => 'fade',    

    ),

  ); 

  $field = field_info_field($default_field_name);

  //print debug($field);

  $col_options = array(

    '' => t('Choose a column'),

  );

  $columns = !empty($field['columns']) ? $field['columns'] : array();

  foreach ($columns as $key => $column) {

    $col_options[$key] = $key;  

  }

  if(!in_array($default_col, array_keys($col_options))){

    $default_col = '';

  }  

  $form['col'] = array(

    '#type' => 'select',

'#options' => $col_options,

    '#title' => t('Column'),

    '#description' => t('A column defined in the hook_field_schema() of this field.'),

    '#default_value' => $default_col,

    '#required' => TRUE,

    '#weight' => 2,

    '#prefix' => '<div id="col-wrapper-div">',

    '#suffix' => '</div>',

  );

 

  $validator_options = array(

    '' => 'Choose a validator',

  );

  $validators = field_validation_get_validators();

  foreach ($validators as $validator_key => $validator_info) {

    $validator_options[$validator_key] = $validator_info['name'];

  }

  $form['validator'] = array(

    '#type' => 'select',

'#options' => $validator_options,

    '#title' => t('Validator'),

    '#description' => t('A column defined in the hook_field_schema() of this field.'),

    '#default_value' => $default_validator,

    '#required' => TRUE,

    '#weight' => 3,

    '#ajax' => array(      

      'callback' => 'field_validation_validator_callback',      

      'wrapper' => 'data-wrapper-div',      

      'method' => 'replace',      

      'effect' => 'fade',    

    ),

  );

  

  $form['data'] = array(

    '#type' => 'textfield',

    '#title' => t('Config Data'),

    '#required' => FALSE,

    '#size' => 60,

    '#maxlength' => 255,

    '#default_value' => $default_data,

    '#weight' => 4,

    '#prefix' => '<div id="data-wrapper-div">',

    '#suffix' => '</div>',

  );

  //$rule_validator = $validators[$default_validator];

  if (isset($validators[$default_validator]['custom_data']) && is_array($validators[$default_validator]['custom_data'])) {

    $required = isset($validators[$default_validator]['custom_data']['required']) ? $validators[$default_validator]['custom_data']['required'] : TRUE;

$form['data']['#title'] = isset($validators[$default_validator]['custom_data']['label']) ? $validators[$default_validator]['custom_data']['label'] : t('Config Data');

$form['data']['#description'] = isset($validators[$default_validator]['custom_data']['description']) ? $validators[$default_validator]['custom_data']['description'] : t('Config Data');

$form['data']['#required'] = ($required !== FALSE) ? TRUE : FALSE;

  }

  

  $form['error_message'] = array(

    '#type' => 'textfield',

    '#title' => t('Custom error message'),

    '#description' => t("Specify an error message that should be displayed when user input doesn't pass validation"),

    '#required' => TRUE,

    '#size' => 60,

    '#maxlength' => 255,

    '#default_value' => $default_error_message,

    '#weight' => 5,

  );

   $form['#prefix'] = '<div id="validation-rule-wrapper-div">';

   $form['#suffix'] = '</div>';

 

}

 

/**

 * Validation handler for the validation rule add/edit form.

 */

function field_validation_ctools_export_ui_form_validate($form, &$form_state) {

$values = $form_state['values'];

}

 

/**

 * Submit handler for the preset edit form.

 */

function field_validation_ctools_export_ui_form_submit($form, &$form_state) {

$values = $form_state['values'];

}

 

function field_validation_entity_type_callback($form,&$form_state){

  return $form;

}

 

function field_validation_bundle_callback($form,&$form_state){

  return $form;

}

 

function field_validation_field_name_callback($form,&$form_state){

  return $form['col'];

}

 

function field_validation_validator_callback($form,&$form_state){

  return $form['data'];

}

最上面的plugin,这是Ctools插件的常用定义方法,代码是从别的地方复制过来的,我只是改了一下名字而已,把对应的改为Field validation

field_validation_ctools_export_ui_form,就是一个普通的表单,我在里面使用了AJAX技术。这个表单是用来在admin/structure/field_validation这个管理界面,添加/编辑验证规则使用的。这样在RC1版里面,我们提供了两种方式,来添加验证规则,一种是原来编写的admin.inc里面的,一种就是这种基于Ctools的方式。在这个表单里面使用Drupal自带的AJAXCtools早期的版本是不支持的,我写这个功能的时候,恰好支持了这个特性。

这里面,使用了函数entity_get_info来获取所有的实体信息,返回的实体信息数组里面,也包含每个实体里面的bundle(包)信息。而获取某类实体下面的bundles信息,则采用下面的代码:

$bundles = !empty($entity_types[$default_entity_type]['bundles']) ? $entity_types[$default_entity_type]['bundles'] : array();

还有一段代码,也值得学习一下,这段代码的作用是,我们获取一个字段上面包含多少个columns,让用户选择column,而不是输入,这在RC1 里面是一个改进,我以前是不知道这种方式的:

  $field = field_info_field($default_field_name);

  $col_options = array(

    '' => t('Choose a column'),

  );

  $columns = !empty($field['columns']) ? $field['columns'] : array();

  foreach ($columns as $key => $column) {

    $col_options[$key] = $key;  

  }

有关这里的AJAX效果实现,这里就不介绍了,参看第一集的省市县三级联动。验证规则的导出功能实现以后,让我欣喜不已,不过很快发现一个小问题,就是导出验证规则的时候,将ruleid也导出来了。在Ctools的作者的帮助下,很快就修正了这个问题:

     'ruleid' => array(

       'type' => 'serial',

       'description' => 'Unique identifier of the validation rule',

       'unsigned' => TRUE,

       'not null' => TRUE,

       'no export' => TRUE,

     ),

这里面,加了一个键'no export',并将它设置为TRUE,这样就可以避免导出ruleid了。


Drupal版本: