' . t('Provides example search plugin for adding search to custom content entities. Uses Content Entity Example.') . '
'; + return $output; + + default: + } +} + +/** + * Implements hook_theme(). + */ +function search_plugin_example_theme() { + $theme = []; + + return $theme; +} + +/** + * Implements hook_contact_update(). + * + * Marks updated entity items for search reindexing. + * + * @ingroup entity_crud + * + * @see hook_ENTITY_TYPE_update() + * @see node_reindex_node_search() + */ +function search_plugin_example_content_entity_example_contact_update(\Drupal\content_entity_example\Entity\Contact $contact) { + if (\Drupal::moduleHandler()->moduleExists('search')) { + // Reindex node context indexed by the node module search plugin. + // 'search_plugin_example_search' comes from the plugin ID, declared + // in the annotation. + search_mark_for_reindex('search_plugin_example_search', $contact->id()); + } +} + + +/** + * Implements hook_contact_delete(). + * + * Deletes entity data from the search index. + * + * This functionality is in a predelete hook to follow the model used by + * nodes. + * + * @ingroup entity_crud + * + * @see hook_ENTITY_TYPE_predelete() + * @see \Drupal\node\Entity\Node::preDelete() + */ +function search_plugin_example_content_entity_example_contact_predelete(\Drupal\content_entity_example\Entity\Contact $contact) { + // 'search_plugin_example_search' comes from the plugin ID, declared + // in the annotation. + search_index_clear('search_plugin_example_search', $contact->id()); +} diff --git a/search_plugin_example/src/Plugin/Search/SearchPluginExampleSearch.php b/search_plugin_example/src/Plugin/Search/SearchPluginExampleSearch.php new file mode 100644 index 0000000..9b3b1e3 --- /dev/null +++ b/search_plugin_example/src/Plugin/Search/SearchPluginExampleSearch.php @@ -0,0 +1,865 @@ +\Drupal\search\SearchQuery. + *\Drupal\search\SearchQuery adds some search
+ * features such as automatically including {search_dataset} in the
+ * query, weighting the the result scores based on the importance of individual
+ * words, etc.
+ * If these "extra features" aren't approprite for your custom content entity,
+ * see \Drupal\user\Plugin\Search\UserSearch as an example
+ * of not using \Drupal\search\SearchQuery.
+ *
+ * @see \Drupal\node\Plugin\Search\NodeSearch
+ * @see \Drupal\user\Plugin\Search\UserSearch
+ *
+ * Annotation for discovery by Search module.
+ * - 'id': unique machine name for this search plugin.
+ * Will be used for the `type` field in {search_index} and {search_dataset}.
+ * - 'title': Translatable title for the search page & navigation tab.
+ *
+ * @see https://api.drupal.org/api/drupal/core!core.api.php/group/plugin_api/8#sec_create
+ * @see https://api.drupal.org/api/drupal/core!core.api.php/group/annotation/8
+ *
+ * @SearchPlugin(
+ * id = "search_plugin_example_search",
+ * title = @Translation("Search Plugin Example")
+ * )
+ */
+class SearchPluginExampleSearch extends ConfigurableSearchPluginBase implements AccessibleInterface, SearchIndexingInterface {
+
+ /**
+ * A database connection object.
+ *
+ * @var \Drupal\Core\Database\Connection
+ */
+ protected $database;
+
+ /**
+ * An entity manager object.
+ *
+ * @var \Drupal\Core\Entity\EntityManagerInterface
+ */
+ protected $entityManager;
+
+ /**
+ * A module manager object.
+ *
+ * @var \Drupal\Core\Extension\ModuleHandlerInterface
+ */
+ protected $moduleHandler;
+
+ /**
+ * A config object for 'search.settings'.
+ *
+ * @var \Drupal\Core\Config\Config
+ */
+ protected $searchSettings;
+
+ /**
+ * The language manager.
+ *
+ * @var \Drupal\Core\Language\LanguageManagerInterface
+ */
+ protected $languageManager;
+
+ /**
+ * The Drupal account to use for checking for access to advanced search.
+ *
+ * @var \Drupal\Core\Session\AccountInterface
+ */
+ protected $account;
+
+ /**
+ * The Renderer service to format the username and entity.
+ *
+ * @var \Drupal\Core\Render\RendererInterface
+ */
+ protected $renderer;
+
+ /**
+ * An array of additional rankings from hook_ranking().
+ *
+ * @var array
+ */
+ protected $rankings;
+
+ /**
+ * The list of options and info for advanced search filters.
+ *
+ * Each entry in the array has the option as the key and for its value, an
+ * array that determines how the value is matched in the database query. The
+ * possible keys in that array are:
+ * - column: (required) Name of the database column to match against.
+ * - join: (optional) Information on a table to join. By default the data is
+ * matched against any tables joined in the $query declaration in
+ * findResults().
+ * - operator: (optional) OR or AND, defaults to OR.
+ *
+ * For advanced search to work, probably also must modify:
+ * - buildSearchUrlQuery() to build the redirect URL.
+ * - searchFormAlter() to add fields to advanced search form.
+ *
+ * Note: In our case joins aren't needed because the {contact} table is
+ * joined in findResults().
+ *
+ * @var array
+ */
+ protected $advanced = array(
+ 'name' => array(
+ 'column' => 'c.name',
+ ),
+
+ 'first_name' => array(
+ 'column' => 'c.first_name',
+ ),
+
+ 'gender' => array(
+ 'column' => 'c.gender',
+ ),
+ );
+
+ /**
+ * A constant for setting and checking the query string.
+ */
+ const ADVANCED_FORM = 'advanced-form';
+
+ /**
+ * {@inheritdoc}
+ */
+ static public function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('database'),
+ $container->get('entity.manager'),
+ $container->get('module_handler'),
+ $container->get('config.factory')->get('search.settings'),
+ $container->get('language_manager'),
+ $container->get('renderer'),
+ $container->get('current_user')
+ );
+ }
+
+ /**
+ * Constructs \Drupal\content_entity_example\Plugin\Search\SearchPluginExampleSearch.
+ *
+ * @param array $configuration
+ * A configuration array containing information about the plugin instance.
+ * @param string $plugin_id
+ * The plugin_id for the plugin instance.
+ * @param mixed $plugin_definition
+ * The plugin implementation definition.
+ * @param \Drupal\Core\Database\Connection $database
+ * A database connection object.
+ * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
+ * An entity manager object.
+ * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+ * A module manager object.
+ * @param \Drupal\Core\Config\Config $search_settings
+ * A config object for 'search.settings'.
+ * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+ * The language manager.
+ * @param \Drupal\Core\Session\AccountInterface $account
+ * The $account object to use for checking for access to advanced search.
+ */
+ public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database, EntityManagerInterface $entity_manager, ModuleHandlerInterface $module_handler, Config $search_settings, LanguageManagerInterface $language_manager, RendererInterface $renderer, AccountInterface $account = NULL) {
+ $this->database = $database;
+ $this->entityManager = $entity_manager;
+ $this->moduleHandler = $module_handler;
+ $this->searchSettings = $search_settings;
+ $this->languageManager = $language_manager;
+ $this->renderer = $renderer;
+ $this->account = $account;
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+
+ $this->addCacheTags(['contact_list']);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function access($operation = 'view', AccountInterface $account = NULL, $return_as_object = FALSE) {
+ $result = AccessResult::allowedIfHasPermission($account, 'access content');
+ return $return_as_object ? $result : $result->isAllowed();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isSearchExecutable() {
+ // Contact search is executable if we have keywords or an advanced
+ // parameter.
+ // At least, we should parse out the parameters and see if there are any
+ // keyword matches in that case, rather than just printing out the
+ // "Please enter keywords" message.
+ return !empty($this->keywords) || (isset($this->searchParameters['f']) && count($this->searchParameters['f']));
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getType() {
+ return $this->getPluginId();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function execute() {
+ if ($this->isSearchExecutable()) {
+ $results = $this->findResults();
+
+ if ($results) {
+ return $this->prepareResults($results);
+ }
+ }
+
+ return array();
+ }
+
+ /**
+ * Queries to find search results, and sets status messages.
+ *
+ * This method can assume that $this->isSearchExecutable() has already been
+ * checked and returned TRUE.
+ *
+ * @return \Drupal\Core\Database\StatementInterface|null
+ * Results from search query execute() method, or NULL if the search
+ * failed.
+ */
+ protected function findResults() {
+
+ $keys = $this->keywords;
+
+ // Build matching conditions.
+ $query = $this->database
+ ->select('search_index', 'i', array('target' => 'replica'))
+ ->extend('Drupal\search\SearchQuery')
+ ->extend('Drupal\Core\Database\Query\PagerSelectExtender');
+
+ // Join on {contact} and {users_field_data} to get user's published status.
+ // This join on {contact} also serves the advanced search items
+ // (in $this->advanced) that are in {contact}.
+ $query->join('contact', 'c', 'c.id = i.sid');
+ $query->join('users_field_data', 'ufd', 'ufd.uid = c.user_id');
+ $query->condition('ufd.status', 1);
+
+ $query
+ ->searchExpression($keys, $this->getPluginId());
+
+ // @todo ===============
+ // Handle advanced search filters in the f query string.
+ // \Drupal::request()->query->get('f') is an array that looks like this in
+ // the URL: ?f[]=first_name:Jane&f[]=gender:f
+ // So $parameters['f'] looks like:
+ // array('first_name:Jane', 'gender:f');
+ // We need to parse this out into query conditions, some of which go into
+ // the keywords string, and some of which are separate conditions.
+ //
+ // Note: advanced form fields are added in searchFormAlter(),
+ // and the URL containing the "f" parameter is built in
+ // buildSearchUrlQuery().
+ $parameters = $this->getParameters();
+ if (!empty($parameters['f']) && is_array($parameters['f'])) {
+ // @todo This loop should probably be moved to a helper function.
+ $filters = array();
+ // Match any query value that is an expected option and a value
+ // separated by ':' like 'first_name:Jane'.
+ $pattern = '/^(' . implode('|', array_keys($this->advanced)) . '):([^ ]*)/i';
+ foreach ($parameters['f'] as $item) {
+ if (preg_match($pattern, $item, $m)) {
+ // Use the matched value as the array key to eliminate duplicates.
+ $filters[$m[1]][$m[2]] = $m[2];
+ }
+ }
+
+ // Now turn these into query conditions. This assumes that everything in
+ // $filters is a known type of advanced search as defined in
+ // $this->advanced.
+ foreach ($filters as $option => $matched) {
+ $info = $this->advanced[$option];
+ // Insert additional conditions. By default, all use the OR operator.
+ $operator = empty($info['operator']) ? 'OR' : $info['operator'];
+ $where = new Condition($operator);
+ foreach ($matched as $value) {
+ $where->condition($info['column'], $value);
+ }
+ $query->condition($where);
+ if (!empty($info['join'])) {
+ $query->join($info['join']['table'], $info['join']['alias'], $info['join']['condition']);
+ }
+ }
+ }
+ // ===============
+ // Add the ranking expressions.
+ $this->addContactRankings($query);
+
+ // Run the query.
+ $find = $query
+ // Add the language code of the indexed item to the result of the query,
+ // since the entity will be rendered using the respective language.
+ ->fields('i', array('langcode'))
+ // And since SearchQuery makes these into GROUP BY queries, if we add
+ // a field, for PostgreSQL we also need to make it an aggregate or a
+ // GROUP BY. In this case, we want GROUP BY.
+ ->groupBy('i.langcode')
+ ->limit(10)
+ ->execute();
+
+ // Check query status and set messages if needed.
+ $status = $query->getStatus();
+
+ if ($status & SearchQuery::EXPRESSIONS_IGNORED) {
+ drupal_set_message($this->t('Your search used too many AND/OR expressions. Only the first @count terms were included in this search.', array('@count' => $this->searchSettings->get('and_or_limit'))), 'warning');
+ }
+
+ if ($status & SearchQuery::LOWER_CASE_OR) {
+ drupal_set_message($this->t('Search for either of the two terms with uppercase OR. For example, cats OR dogs.'), 'warning');
+ }
+
+ if ($status & SearchQuery::NO_POSITIVE_KEYWORDS) {
+ drupal_set_message($this->formatPlural($this->searchSettings->get('index.minimum_word_size'), 'You must include at least one keyword to match in the content, and punctuation is ignored.', 'You must include at least one keyword to match in the content. Keywords must be at least @count characters, and punctuation is ignored.'), 'warning');
+ }
+
+ return $find;
+ }
+
+ /**
+ * Prepares search results for rendering.
+ *
+ * @param \Drupal\Core\Database\StatementInterface $found
+ * Results found from a successful search query execute() method.
+ *
+ * @return array
+ * Array of search result item render arrays (empty array if no results).
+ */
+ protected function prepareResults(StatementInterface $found) {
+ $results = array();
+
+ // 'content_entity_example_contact' comes from the entity type id declared
+ // in the annotation for \Drupal\content_entity_example\Entity\Contact.
+ // Replace this with your entity's type id.
+ $entity_storage = $this->entityManager->getStorage('content_entity_example_contact');
+ $entity_render = $this->entityManager->getViewBuilder('content_entity_example_contact');
+ $keys = $this->keywords;
+
+ foreach ($found as $item) {
+ // Render the contact.
+ /** @var \Drupal\content_entity_example\ContactInterface $entity */
+ $entity = $entity_storage->load($item->sid)->getTranslation($item->langcode);
+ $build = $entity_render->view($entity, 'search_result', $item->langcode);
+
+ unset($build['#theme']);
+ // Uncomment to use removeFromSnippet() for excluding data from snippet.
+ /* $build['#pre_render'][] = array($this, 'removeFromSnippet'); */
+
+ // Build the snippet.
+ $rendered = $this->renderer->renderPlain($build);
+ $this->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));
+
+ $extra = $this->moduleHandler->invokeAll('search_plugin_example_search_result', [$entity]);
+
+ $language = $this->languageManager->getLanguage($item->langcode);
+
+ $result = array(
+ 'link' => $entity->url(
+ 'canonical',
+ array(
+ 'absolute' => TRUE,
+ 'language' => $language,
+ )
+ ),
+ 'type' => 'Contact',
+ 'title' => $entity->label(),
+ 'contact' => $entity,
+ 'extra' => $extra,
+ 'score' => $item->calculated_score,
+ 'snippet' => search_excerpt($keys, $rendered, $item->langcode),
+ 'langcode' => $entity->language()->getId(),
+ );
+
+ $this->addCacheableDependency($entity);
+
+ // We have to separately add the contact owner's cache tags because search
+ // module doesn't use the rendering system, it does its own rendering
+ // without taking cacheability metadata into account. So we have to do it
+ // explicitly here.
+ $this->addCacheableDependency($entity->getOwner());
+
+ // @codingStandardsIgnoreStart
+ // Uncomment this to display owner name and last changed time.
+ // $username = array(
+ // '#theme' => 'username',
+ // '#account' => $entity->getOwner(),
+ // );
+ // $result += array(
+ // 'user' => $this->renderer->renderPlain($username),
+ // 'date' => $entity->getChangedTime(),
+ // );
+ // @codingStandardsIgnoreEnd
+ $results[] = $result;
+
+ }
+ return $results;
+ }
+
+ /**
+ * Removes results data from the search result snippet.
+ *
+ * This information is being removed from the rendered entity that is used to
+ * build the search result snippet.
+ *
+ * @param array $build
+ * The build array.
+ *
+ * @return array
+ * The modified build array.
+ */
+ public function removeFromSnippet(array $build) {
+ // Code to remove arbitrary data from $build goes here.
+ // Examples:
+ // - unset($build['created']);
+ // - unset($build['uid']);.
+ return $build;
+ }
+
+ /**
+ * Adds the configured rankings to the search query.
+ *
+ * @param SelectExtender $query
+ * A query object that has been extended with the Search DB Extender.
+ */
+ protected function addContactRankings(SelectExtender $query) {
+ if ($ranking = $this->getRankings()) {
+ $tables = &$query->getTables();
+ foreach ($ranking as $rank => $values) {
+ if (isset($this->configuration['rankings'][$rank]) && !empty($this->configuration['rankings'][$rank])) {
+ $entity_rank = $this->configuration['rankings'][$rank];
+ // If the table defined in the ranking isn't already joined, add it.
+ if (isset($values['join']) && !isset($tables[$values['join']['alias']])) {
+ $query->addJoin($values['join']['type'], $values['join']['table'], $values['join']['alias'], $values['join']['on']);
+ }
+ $arguments = isset($values['arguments']) ? $values['arguments'] : array();
+ $query->addScore($values['score'], $arguments, $entity_rank);
+ }
+ }
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function updateIndex() {
+ // Interpret the cron limit setting as the maximum number of entities to
+ // index per cron run.
+ $limit = (int) $this->searchSettings->get('index.cron_limit');
+
+ $result = $this->database->queryRange("SELECT c.id, MAX(sd.reindex) FROM {contact} c LEFT JOIN {search_dataset} sd ON sd.sid = c.id AND sd.type = :type WHERE sd.sid IS NULL OR sd.reindex <> 0 GROUP BY c.id ORDER BY MAX(sd.reindex) is null DESC, MAX(sd.reindex) ASC, c.id ASC", 0, $limit, array(':type' => $this->getPluginId()), array('target' => 'replica'));
+
+ $rids = $result->fetchCol();
+ if (!$rids) {
+ return;
+ }
+
+ // 'content_entity_example_contact' comes from the entity type id declared
+ // in the annotation for \Drupal\content_entity_example\Entity\Contact.
+ // Replace this with your entity's type id.
+ $entity_storage = $this->entityManager->getStorage('content_entity_example_contact');
+
+ foreach ($entity_storage->loadMultiple($rids) as $entity) {
+ $this->indexContact($entity);
+ }
+ }
+
+ /**
+ * Indexes a single contact.
+ *
+ * @param \Drupal\content_entity_example\ContactInterface $entity
+ * The contact to index.
+ */
+ protected function indexContact(ContactInterface $entity) {
+ $languages = $entity->getTranslationLanguages();
+ // 'content_entity_example_contact' comes from the entity type id declared
+ // in the annotation for \Drupal\content_entity_example\Entity\Contact.
+ // Replace this with your entity's type id.
+ $entity_render = $this->entityManager->getViewBuilder('content_entity_example_contact');
+
+ foreach ($languages as $language) {
+ $entity = $entity->getTranslation($language->getId());
+ // Render the contact.
+ $build = $entity_render->view($entity, 'search_index', $language->getId());
+
+ unset($build['#theme']);
+
+ // Add the title to text so it is searchable.
+ $build['search_title'] = [
+ '#prefix' => '' . $this->t('Influence is a numeric multiplier used in ordering search results. A higher number means the corresponding factor has more influence on search results; zero means the factor is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') . '
', + ); + // Prepare table. + $header = [$this->t('Factor'), $this->t('Influence')]; + $form['content_ranking']['rankings'] = array( + '#type' => 'table', + '#header' => $header, + ); + + // Note: reversed to reflect that higher number = higher ranking. + $range = range(0, 10); + $options = array_combine($range, $range); + foreach ($this->getRankings() as $var => $values) { + $form['content_ranking']['rankings'][$var]['name'] = array( + '#markup' => $values['title'], + ); + $form['content_ranking']['rankings'][$var]['value'] = array( + '#type' => 'select', + '#options' => $options, + '#attributes' => ['aria-label' => $this->t("Influence of '@title'", ['@title' => $values['title']])], + '#default_value' => isset($this->configuration['rankings'][$var]) ? $this->configuration['rankings'][$var] : 0, + ); + } + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + foreach ($this->getRankings() as $var => $values) { + if (!$form_state->isValueEmpty(['rankings', $var, 'value'])) { + $this->configuration['rankings'][$var] + = $form_state->getValue(['rankings', $var, 'value']); + } + else { + unset($this->configuration['rankings'][$var]); + } + } + } + +}