class SearchApiAlterAddAggregation in Search API 7
Search API data alteration callback that adds an URL field for all items.
Hierarchy
- class \SearchApiAbstractAlterCallback implements SearchApiAlterCallbackInterface
- class \SearchApiAlterAddAggregation
Expanded class hierarchy of SearchApiAlterAddAggregation
1 string reference to 'SearchApiAlterAddAggregation'
File
- includes/
callback_add_aggregation.inc, line 11 - Contains SearchApiAlterAddAggregation.
View source
class SearchApiAlterAddAggregation extends SearchApiAbstractAlterCallback {
/**
* The type of aggregation currently performed.
*
* Used to temporarily store the current aggregation type for use of
* SearchApiAlterAddAggregation::reduce() with array_reduce().
*
* @var string
*/
protected $reductionType;
/**
* A separator to use when the aggregation type is 'fulltext'.
*
* Used to temporarily store a string separator when the aggregation type is
* "fulltext", for use in SearchApiAlterAddAggregation::reduce() with
* array_reduce().
*
* @var string
*/
protected $fulltextReductionSeparator;
public function configurationForm() {
$form['#attached']['css'][] = drupal_get_path('module', 'search_api') . '/search_api.admin.css';
$fields = $this->index
->getFields(FALSE);
$field_options = array();
$field_properties = array();
foreach ($fields as $name => $field) {
$field_options[$name] = check_plain($field['name']);
$field_properties[$name] = array(
'#attributes' => array(
'title' => $name,
),
'#description' => check_plain($field['description']),
);
}
$additional = empty($this->options['fields']) ? array() : $this->options['fields'];
$types = $this
->getTypes();
$type_descriptions = $this
->getTypes('description');
$tmp = array();
foreach ($types as $type => $name) {
$tmp[$type] = array(
'#type' => 'item',
'#description' => $type_descriptions[$type],
);
}
$type_descriptions = $tmp;
$form['#id'] = 'edit-callbacks-search-api-alter-add-aggregation-settings';
$form['description'] = array(
'#markup' => t('<p>This data alteration lets you define additional fields that will be added to this index. ' . 'Each of these new fields will be an aggregation of one or more existing fields.</p>' . '<p>To add a new aggregated field, click the "Add new field" button and then fill out the form.</p>' . '<p>To remove a previously defined field, click the "Remove field" button.</p>' . '<p>You can also change the names or contained fields of existing aggregated fields.</p>'),
);
$form['fields']['#prefix'] = '<div id="search-api-alter-add-aggregation-field-settings">';
$form['fields']['#suffix'] = '</div>';
if (isset($this->changes)) {
$form['fields']['#prefix'] .= '<div class="messages warning">All changes in the form will not be saved until the <em>Save configuration</em> button at the form bottom is clicked.</div>';
}
foreach ($additional as $name => $field) {
$form['fields'][$name] = array(
'#type' => 'fieldset',
'#title' => $field['name'] ? $field['name'] : t('New field'),
'#collapsible' => TRUE,
'#collapsed' => (bool) $field['name'],
);
$form['fields'][$name]['name'] = array(
'#type' => 'textfield',
'#title' => t('New field name'),
'#default_value' => $field['name'],
'#required' => TRUE,
);
$form['fields'][$name]['type'] = array(
'#type' => 'select',
'#title' => t('Aggregation type'),
'#options' => $types,
'#default_value' => $field['type'],
'#required' => TRUE,
);
$form['fields'][$name]['type_descriptions'] = $type_descriptions;
$type_selector = ':input[name="callbacks[search_api_alter_add_aggregation][settings][fields][' . $name . '][type]"]';
foreach (array_keys($types) as $type) {
$form['fields'][$name]['type_descriptions'][$type]['#states']['visible'][$type_selector]['value'] = $type;
}
$form['fields'][$name]['separator'] = array(
'#type' => 'textfield',
'#title' => t('Fulltext separator'),
'#description' => t('For aggregation type "Fulltext", set the text that should be used to separate the aggregated field values. Use "\\t" for tabs and "\\n" for newline characters.'),
'#default_value' => addcslashes(isset($field['separator']) ? $field['separator'] : "\n\n", "\0..\37\\"),
'#states' => array(
'visible' => array(
$type_selector => array(
'value' => 'fulltext',
),
),
),
);
$form['fields'][$name]['fields'] = array_merge($field_properties, array(
'#type' => 'checkboxes',
'#title' => t('Contained fields'),
'#options' => $field_options,
'#default_value' => drupal_map_assoc($field['fields']),
'#attributes' => array(
'class' => array(
'search-api-alter-add-aggregation-fields',
),
),
'#required' => TRUE,
));
$form['fields'][$name]['actions'] = array(
'#type' => 'actions',
'remove' => array(
'#type' => 'submit',
'#value' => t('Remove field'),
'#submit' => array(
'_search_api_add_aggregation_field_submit',
),
'#limit_validation_errors' => array(),
'#name' => 'search_api_add_aggregation_remove_' . $name,
'#ajax' => array(
'callback' => '_search_api_add_aggregation_field_ajax',
'wrapper' => 'search-api-alter-add-aggregation-field-settings',
),
),
);
}
$form['actions']['#type'] = 'actions';
$form['actions']['add_field'] = array(
'#type' => 'submit',
'#value' => t('Add new field'),
'#submit' => array(
'_search_api_add_aggregation_field_submit',
),
'#limit_validation_errors' => array(),
'#ajax' => array(
'callback' => '_search_api_add_aggregation_field_ajax',
'wrapper' => 'search-api-alter-add-aggregation-field-settings',
),
);
return $form;
}
public function configurationFormValidate(array $form, array &$values, array &$form_state) {
unset($values['actions']);
if (empty($values['fields'])) {
return;
}
foreach ($values['fields'] as $name => $field) {
unset($values['fields'][$name]['actions']);
$fields = $values['fields'][$name]['fields'] = array_values(array_filter($field['fields']));
if ($field['name'] && !$fields) {
form_error($form['fields'][$name]['fields'], t('You have to select at least one field to aggregate. If you want to remove an aggregated field, please delete its name.'));
}
$values['fields'][$name]['separator'] = stripcslashes($field['separator']);
}
}
public function configurationFormSubmit(array $form, array &$values, array &$form_state) {
if (empty($values['fields'])) {
return array();
}
$index_fields = $this->index
->getFields(FALSE);
foreach ($values['fields'] as $name => $field) {
if (!$field['name']) {
unset($values['fields'][$name]);
}
else {
$values['fields'][$name]['description'] = $this
->fieldDescription($field, $index_fields);
}
}
$this->options = $values;
return $values;
}
public function alterItems(array &$items) {
if (!$items) {
return;
}
if (isset($this->options['fields'])) {
$types = $this
->getTypes('type');
foreach ($items as $item) {
$wrapper = $this->index
->entityWrapper($item);
foreach ($this->options['fields'] as $name => $field) {
if ($field['name']) {
$required_fields = array();
foreach ($field['fields'] as $f) {
if (!isset($required_fields[$f])) {
$required_fields[$f]['type'] = $types[$field['type']];
}
}
$fields = search_api_extract_fields($wrapper, $required_fields);
$values = array();
foreach ($fields as $f) {
if (isset($f['value'])) {
$values[] = $f['value'];
}
}
$values = $this
->flattenArray($values);
$this->reductionType = $field['type'];
$this->fulltextReductionSeparator = isset($field['separator']) ? $field['separator'] : "\n\n";
$item->{$name} = array_reduce($values, array(
$this,
'reduce',
), NULL);
if ($field['type'] == 'count' && !$item->{$name}) {
$item->{$name} = 0;
}
}
}
}
}
}
/**
* Helper method for reducing an array to a single value.
*/
public function reduce($a, $b) {
switch ($this->reductionType) {
case 'fulltext':
return isset($a) ? $a . $this->fulltextReductionSeparator . $b : $b;
case 'sum':
return $a + $b;
case 'count':
return $a + 1;
case 'max':
return isset($a) ? max($a, $b) : $b;
case 'min':
return isset($a) ? min($a, $b) : $b;
case 'first':
return isset($a) ? $a : $b;
case 'first_char':
$b = "{$b}";
if (isset($a) || $b === '') {
return $a;
}
return drupal_substr($b, 0, 1);
case 'last':
return isset($b) ? $b : $a;
case 'list':
if (!isset($a)) {
$a = array();
}
$a[] = $b;
return $a;
}
return NULL;
}
/**
* Helper method for flattening a multi-dimensional array.
*/
protected function flattenArray(array $data) {
$ret = array();
foreach ($data as $item) {
if (!isset($item)) {
continue;
}
if (is_scalar($item)) {
$ret[] = $item;
}
else {
$ret = array_merge($ret, $this
->flattenArray($item));
}
}
return $ret;
}
public function propertyInfo() {
$types = $this
->getTypes('type');
$ret = array();
if (isset($this->options['fields'])) {
foreach ($this->options['fields'] as $name => $field) {
$ret[$name] = array(
'label' => $field['name'],
'description' => empty($field['description']) ? '' : $field['description'],
'type' => $types[$field['type']],
);
}
}
return $ret;
}
/**
* Helper method for creating a field description.
*/
protected function fieldDescription(array $field, array $index_fields) {
$fields = array();
foreach ($field['fields'] as $f) {
$fields[] = isset($index_fields[$f]) ? $index_fields[$f]['name'] : $f;
}
$type = $this
->getTypes();
$type = $type[$field['type']];
return t('A @type aggregation of the following fields: @fields.', array(
'@type' => $type,
'@fields' => implode(', ', $fields),
));
}
/**
* Helper method for getting all available aggregation types.
*
* @param string $info
* (optional) One of "name", "type" or "description", to indicate what
* information should be returned for the types.
*
* @return string[]
* An associative array of aggregation type identifiers mapped to their
* names, data types or descriptions, as requested.
*/
protected function getTypes($info = 'name') {
switch ($info) {
case 'name':
return array(
'fulltext' => t('Fulltext'),
'sum' => t('Sum'),
'count' => t('Count'),
'max' => t('Maximum'),
'min' => t('Minimum'),
'first' => t('First'),
'first_char' => t('First letter'),
'last' => t('Last'),
'list' => t('List'),
);
case 'type':
return array(
'fulltext' => 'text',
'sum' => 'integer',
'count' => 'integer',
'max' => 'integer',
'min' => 'integer',
'first' => 'token',
'first_char' => 'token',
'last' => 'token',
'list' => 'list<token>',
);
case 'description':
return array(
'fulltext' => t('The Fulltext aggregation concatenates the text data of all contained fields.'),
'sum' => t('The Sum aggregation adds the values of all contained fields numerically.'),
'count' => t('The Count aggregation takes the total number of contained field values as the aggregated field value.'),
'max' => t('The Maximum aggregation computes the numerically largest contained field value.'),
'min' => t('The Minimum aggregation computes the numerically smallest contained field value.'),
'first' => t('The First aggregation will simply keep the first encountered field value. This is helpful foremost when you know that a list field will only have a single value.'),
'first_char' => t('The "First letter" aggregation uses just the first letter of the first encountered field value as the aggregated value. This can, for example, be used to build a Glossary view.'),
'last' => t('The Last aggregation will simply keep the last encountered field value.'),
'list' => t('The List aggregation collects all field values into a multi-valued field containing all values.'),
);
}
return array();
}
/**
* Submit helper callback for buttons in the callback's configuration form.
*/
public function formButtonSubmit(array $form, array &$form_state) {
$button_name = $form_state['triggering_element']['#name'];
if ($button_name == 'op') {
// Increment $i until the corresponding field is not set, then create the
// field with that number as suffix.
for ($i = 1; isset($this->options['fields']['search_api_aggregation_' . $i]); ++$i) {
}
$this->options['fields']['search_api_aggregation_' . $i] = array(
'name' => '',
'type' => 'fulltext',
'fields' => array(),
);
}
else {
$field = substr($button_name, 34);
unset($this->options['fields'][$field]);
}
$form_state['rebuild'] = TRUE;
$this->changes = TRUE;
}
}