includes/search/SearchIndexField.php

   1 <?php
   2 /**
   3  * Definition of a mapping for the search index field.
   4  * @since 1.28
   5  */
   6 interface SearchIndexField {
   7         /**
   8          * Field types
   9          */
  10         const INDEX_TYPE_TEXT = 0;
  11         const INDEX_TYPE_KEYWORD = 1;
  12         const INDEX_TYPE_INTEGER = 2;
  13         const INDEX_TYPE_NUMBER = 3;
  14         const INDEX_TYPE_DATETIME = 4;
  15         const INDEX_TYPE_NESTED = 5;
  16         const INDEX_TYPE_BOOL = 6;
  17
  18         /**
  19          * SHORT_TEXT is meant to be used with short text made of mostly ascii
  20          * technical information. Generally a language agnostic analysis chain
  21          * is used and aggressive splitting to increase recall.
  22          * E.g suited for mime/type
  23          */
  24         const INDEX_TYPE_SHORT_TEXT = 7;
  25
  26         /**
  27          * Generic field flags.
  28          */
  29         /**
  30          * This field is case-insensitive.
  31          */
  32         const FLAG_CASEFOLD = 1;
  33         /**
  34          * This field contains secondary information, which is
  35          * already present in other fields, but can be used for
  36          * scoring.
  37          */
  38         const FLAG_SCORING = 2;
  39         /**
  40          * This field does not need highlight handling.
  41          */
  42         const FLAG_NO_HIGHLIGHT = 4;
  43         /**
  44          * Do not index this field, just store it.
  45          */
  46         const FLAG_NO_INDEX = 8;
  47
  48         /**
  49          * Get mapping for specific search engine
  50          * @param SearchEngine $engine
  51          * @return array|null Null means this field does not map to anything
  52          */
  53         public function getMapping( SearchEngine $engine );
  54         /**
  55          * Set global flag for this field.
  56          *
  57          * @param int  $flag Bit flag to set/unset
  58          * @param bool $unset True if flag should be unset, false by default
  59          * @return $this
  60          */
  61         public function setFlag( $flag, $unset = false );
  62         /**
  63          * Check if flag is set.
  64          * @param $flag
  65          * @return int 0 if unset, !=0 if set
  66          */
  67         public function checkFlag( $flag );
  68         /**
  69          * Merge two field definitions if possible.
  70          *
  71          * @param SearchIndexField $that
  72          * @return SearchIndexField|false New definition or false if not mergeable.
  73          */
  74         public function merge( SearchIndexField $that );
  75
  76         /**
  77          * A list of search engine hints for this field.
  78          * Hints are usually specific to a search engine implementation
  79          * and allow to fine control how the search engine will handle this
  80          * particular field.
  81          *
  82          * For example some search engine permits some optimizations
  83          * at index time by ignoring an update if the updated value
  84          * does not change by more than X% on a numeric value.
  85          *
  86          * @param SearchEngine $engine
  87          * @return array an array of hints generally indexed by hint name. The type of
  88          * values is search engine specific
  89          * @since 1.30
  90          */
  91         public function getEngineHints( SearchEngine $engine );
  92 }