You are here

class SearchApiAttachmentsMultifieldAlterSettings in Search API attachments 7

Hierarchy

Expanded class hierarchy of SearchApiAttachmentsMultifieldAlterSettings

1 string reference to 'SearchApiAttachmentsMultifieldAlterSettings'
search_api_attachments_multifield_search_api_alter_callback_info in contrib/search_api_attachments_multifield/search_api_attachments_multifield.module
Implements hook_search_api_alter_callback_info().

File

contrib/search_api_attachments_multifield/includes/callback_attachments_multifield_settings.inc, line 11
Search API data alteration callback.

View source
class SearchApiAttachmentsMultifieldAlterSettings extends SearchApiAttachmentsAlterSettings {

  /**
   * {@inheritdoc}
   */
  public function alterItems(array &$items) {

    // Get the multifield bundles.
    $multifields_instances = field_info_instances('multifield');
    $multifields = array_keys($multifields_instances);
    if (!empty($multifields_instances)) {
      foreach ($items as &$item) {

        // Case of multifield fields.
        foreach ($multifields as $multifield) {
          if (isset($item->{$multifield})) {

            // Get the file fields of the multifield item.
            $file_fields = array();
            foreach (array_keys($multifields_instances[$multifield]) as $field_name) {
              $field_info = field_info_field($field_name);

              // Only if the field is file and should be indexed.
              if ($field_info['type'] == 'file') {
                $file_fields[] = $field_name;
              }
            }
            if (empty($file_fields)) {
              return;
            }
            $multifield_items = field_get_items($this->index
              ->getEntityType(), $item, $multifield);
            if ($multifield_items) {

              // Index the files content.
              foreach ($file_fields as $file_field) {
                foreach ($multifield_items as $multifield_item) {
                  if (isset($multifield_item[$file_field]) && !empty($multifield_item[$file_field])) {
                    $files = array();

                    // Get the entity wrapper that have multifield with
                    // file fields.
                    $item_wrapper = entity_metadata_wrapper($this->index
                      ->getEntityType(), $item);
                    if (is_array($item_wrapper->{$multifield}
                      ->value())) {
                      foreach ($item_wrapper->{$multifield} as $multifield_wrapper) {
                        $files[] = $multifield_wrapper->{$file_field}
                          ->value();
                      }
                    }
                    else {
                      $files = array(
                        $item_wrapper->{$multifield}->{$file_field}
                          ->value(),
                      );
                    }
                    if (!empty($files)) {

                      // Limit to the max number of value per field.
                      if (isset($this->options['number_indexed']) && $this->options['number_indexed'] != '0' && count($files) > $this->options['number_indexed']) {
                        $files = array_slice($files, 0, $this->options['number_indexed']);
                      }
                      foreach ($files as $file) {
                        if ($this
                          ->isFileIndexable($file, $item, $multifield)) {
                          $attachments = 'attachments_' . $file_field;
                          if (isset($item->{$attachments})) {
                            $item->{$attachments} .= ' ' . $this
                              ->getFileContent($file);
                          }
                          else {
                            $item->{$attachments} = $this
                              ->getFileContent($file);
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function propertyInfo() {
    $ret = array();
    if ($this->index
      ->getEntityType() == 'file') {
      $ret['attachments_content'] = array(
        'label' => 'File content',
        'description' => 'File content',
        'type' => 'text',
      );
    }
    else {
      $fields = $this
        ->getFileFields();
      foreach ($fields as $name => $field) {
        $ret['attachments_' . $name] = array(
          'label' => 'Attachment content: ' . $name,
          'description' => $name,
          'type' => 'text',
        );
      }
    }
    return $ret;
  }

  /**
   * {@inheritdoc}
   */
  protected function getFileFields() {
    $ret = array();
    foreach (field_info_fields() as $name => $field) {
      if ($field['type'] == 'file') {
        $ret[$name] = $field;
      }
    }
    return $ret;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
SearchApiAbstractAlterCallback::$index protected property The index whose items will be altered.
SearchApiAbstractAlterCallback::$options protected property The configuration options for this callback, if it has any.
SearchApiAbstractAlterCallback::configurationFormSubmit public function Implements SearchApiAlterCallbackInterface::configurationFormSubmit(). Overrides SearchApiAlterCallbackInterface::configurationFormSubmit 4
SearchApiAbstractAlterCallback::configurationFormValidate public function Implements SearchApiAlterCallbackInterface::configurationFormValidate(). Overrides SearchApiAlterCallbackInterface::configurationFormValidate 1
SearchApiAbstractAlterCallback::isMultiEntityIndex protected function Determines whether the given index contains multiple types of entities.
SearchApiAbstractAlterCallback::supportsIndex public function Implements SearchApiAlterCallbackInterface::supportsIndex(). Overrides SearchApiAlterCallbackInterface::supportsIndex 10
SearchApiAbstractAlterCallback::__construct public function Implements SearchApiAlterCallbackInterface::__construct(). Overrides SearchApiAlterCallbackInterface::__construct 1
SearchApiAttachmentsAlterSettings::CACHE_TABLE constant 1
SearchApiAttachmentsAlterSettings::configurationForm public function Adds configuration form. Overrides SearchApiAbstractAlterCallback::configurationForm
SearchApiAttachmentsAlterSettings::extractExif protected function Extracts images metadata.
SearchApiAttachmentsAlterSettings::extractPdftotext protected function Extracts pdf file content using pdftotext.
SearchApiAttachmentsAlterSettings::extractPythonPdf2txt protected function Extracts pdf file content using python pdf2txt script.
SearchApiAttachmentsAlterSettings::extractSimple protected function Extracts file content for text files.
SearchApiAttachmentsAlterSettings::extractSolr protected function Extract data using Solr.
SearchApiAttachmentsAlterSettings::extractTika protected function Extracts file content using local tika executable.
SearchApiAttachmentsAlterSettings::extractTikaServer protected function Extracts file content using a tika server.
SearchApiAttachmentsAlterSettings::getFileContent protected function Extracts th file content.
SearchApiAttachmentsAlterSettings::getIndexableFileFields protected function Retrieve list of fields, that should be indexed.
SearchApiAttachmentsAlterSettings::getRealpath protected function Helper method to get a file's real path.
SearchApiAttachmentsAlterSettings::imageMimetypes protected function Helper function to store image's mimetypes.
SearchApiAttachmentsAlterSettings::isFileIndexable public function Checks if file is allowed to be indexed. 1
SearchApiAttachmentsAlterSettings::isMultipleIndexWithFile protected function
SearchApiAttachmentsAlterSettings::isPrivate protected function Check if the file is private.
SearchApiAttachmentsAlterSettings::isTemporary protected function Check if the file is temporary.
SearchApiAttachmentsAlterSettings::pdfMimetypes protected function Helper function to store pdf's mimetypes.
SearchApiAttachmentsAlterSettings::textMimetypes protected function Helper function to store text's mimetypes.
SearchApiAttachmentsMultifieldAlterSettings::alterItems public function Alter items before indexing. Overrides SearchApiAttachmentsAlterSettings::alterItems
SearchApiAttachmentsMultifieldAlterSettings::getFileFields protected function Helper method to get all file fields. Overrides SearchApiAttachmentsAlterSettings::getFileFields
SearchApiAttachmentsMultifieldAlterSettings::propertyInfo public function Adds attachments property. Overrides SearchApiAttachmentsAlterSettings::propertyInfo