3 如何加载一个Ctools插件
作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com
在module文件中，还有一个函数field_validation_ctools_plugin_api，这个前面已经讲过了，field_validation.default_field_validation_rules.inc文件和前面所讲的一样。我把UI部分独立了出来，前期只实现了基于Ctools的导出UI，这个足够了，代码和前面的类似，所不同的是，plugins\export_ui下面field_validation_export_ui.inc文件的代码更简单一些，这里纯粹是为了测试我的想法是不是行得通，所以省去了很多功能。
最后，我们看看插件的调用，下面的代码用来加载一个字段验证器：
ctools_include('plugins');
$plugin = ctools_get_plugins('field_validation', 'validator', $rule->validator);
$class = ctools_plugin_get_class($plugin, 'handler');
if(empty($class)){
continue;
}
if (!is_subclass_of($rule->validator, 'field_validation_validator')) {
drupal_set_message(t("Plugin '@validator' should extends 'field_validation_validator'.", array('@validator' => $rule->validator)));
continue;
}
下面的代码，实例化字段验证器，验证。
$validator = new $class($entity_type, $entity, $field, $instance, $langcode, $items, $delta, $item, $rule, $errors);
$break = $validator->validate();
Drupal版本:
3.1 2.0-Beta1版的改进
作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com
在完成了2.0 alpha1以后，我花了将近一个星期的时间，写出来了2.0beta1。改进之处有，对于field_validation_validator，在构造函数里面，增加了value这个参数，并为所有的参数设置了默认值，这是一个小的改进。此外，还增加了成员函数set_error、get_default_settings、token_help。
Drupal版本:
3.2 set_error
作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com
其中set_error使得错误消息的设置更加简单，一句话就能将错误消息设置好了，通常使用这样的代码设置错误消息：
$this->set_error($token);
token_help则是用来在错误消息里面支持占位符（令牌）替换模式的，就是用户在自定义错误消息里面，可以输入可用的占位符，这些占位符最后被替换为相应的变量值。这个技术在Views里面经常遇到，在Field validation的问题列表中，也有相应的功能支持请求。我们来看一下set_error这个函数的代码：
public function set_error($tokens = array()) {
$error_element = $this->get_error_element();
$error_message = $this->get_error_message();
$tokens += array(
'[entity-type]' => $this->rule->entity_type,
'[bundle]' => $this->rule->bundle,
'[field-name]' => $this->instance['label'],
'[value]' => $this->value,
);
$error_message = strtr($error_message, $tokens);
form_set_error($error_element, check_plain($error_message));
}
这里的占位符机制，使用的是strtr，而不是Drupal核心的token系统，因为我们的这个占位符机制比较简单，直接使用strtr就满足我们的需求了。
get_default_settings是用来获取默认设置的，在编辑验证规则的时候，会用到，这是一个帮助函数。
Drupal版本:
3.3 field_validation_export_ui.inc
作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com
对于UI模块，我们将原来自己编写的UI部分代码也搬了过来，同时也完善了Ctools 导出UI里面的逻辑，为其加上了AJAX效果。里面有段代码需要学习一下：
if (!empty($default_validator)) {
$plugin = ctools_get_plugins('field_validation', 'validator', $default_validator);
$class = ctools_plugin_get_class($plugin, 'handler');
$validator_class = new $class();
$validator_class->settings_form($form, $form_state);
$output = '<p>' . t('The following tokens are available for error message.' . '</p>');
$token_help = $validator_class->token_help();
if (!empty($token_help)) {
$items = array();
foreach ($token_help as $key => $value) {
$items[] = $key . ' == ' . $value;
}
$output .= theme('item_list',
array(
'items' => $items,
));
}
$form['token_help'] = array(
'#type' => 'fieldset',
'#title' => t('Replacement patterns'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#value' => $output,
'#id' => 'error-message-token-help',
'#prefix' => '<div>',
'#suffix' => '</div>',
'#weight' => 6,
);
}
占位符的描述部分的代码是从views模块里面搬过来的。这里面值得学习的是如何获取插件：
$plugin = ctools_get_plugins('field_validation', 'validator', $default_validator);
从插件里面获取类：
$class = ctools_plugin_get_class($plugin, 'handler');
实例化类，调用成员函数settings_form：
$validator_class = new $class();
$validator_class->settings_form($form, $form_state);
这些代码和module文件中的加载插件对象的代码类似，只不过这里调用了settings_form。我前面讲的，为构造函数的参数设置默认值，主要就是为了方便这里的调用。
其它的改进，就是添加了所有的插件，很多插件都作了改进；除此以外，还编写了一些插件，为了模块升级的需要，都放在了field_validation_deprecated模块里面。这里给出一个插件的代码，这是field_validation_numeric2_validator的代码：
<?php
/**
* @file
* Field validation numeric validator.
*
*/
$plugin = array(
'label' => t('Numeric values'),
'description' => t('Verifies that user-entered values are numeric, with the option to specify min and / or max values.'),
'handler' => array(
'class' => 'field_validation_numeric2_validator',
),
);
class field_validation_numeric2_validator extends field_validation_validator {
/**
* Validate field.
*/
public function validate() {
$settings = $this->rule->settings;
if ($this->value != '') {
$flag = TRUE;
if (!is_numeric($this->value)) {
$flag = FALSE;
}
else{
if (isset($settings['min']) && $settings['min'] != '' && $this->value < $settings['min']) {
$flag = FALSE;
}
if (isset($settings['max']) && $settings['max'] != '' && $this->value > $settings['max']) {
$flag = FALSE;
}
}
if (!$flag) {
$token = array(
'[min]' => isset($settings['min']) ? $settings['min'] : '',
'[max]' => isset($settings['max']) ? $settings['max'] : '',
);
$this->set_error($token);
}
}
}
/**
* Provide settings option
*/
function settings_form(&$form, &$form_state) {
$default_settings = $this->get_default_settings($form, $form_state);
//print debug($default_settings);
$form['settings']['min'] = array(
'#title' => t('Minimum value'),
'#description' => t("Optionally specify the minimum value to validate the user-entered numeric value against."),
'#type' => 'textfield',
'#default_value' => isset($default_settings['min']) ? $default_settings['min'] : '',
);
$form['settings']['max'] = array(
'#title' => t('Maximum value'),
'#description' => t("Optionally specify the maximum value to validate the user-entered numeric value against."),
'#type' => 'textfield',
'#default_value' => isset($default_settings['max']) ? $default_settings['max'] : '',
);
}
/**
* Provide token help info for error message.
*/
public function token_help() {
$token_help = parent::token_help();
$token_help += array(
'[min]' => t('Minimum value'),
'[max]' => t('Maximum value'),
);
return $token_help;
}
}
这是Beta1里面包含的所有可用的插件：
