SearchIndexFieldDefinition.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search;
 
abstract class SearchIndexFieldDefinition implements SearchIndexField {
 
    protected $name;
 
    protected $type;
 
    protected $flags = 0;
 
    protected $subfields = [];
 
    private $mergeCallback;
 
    public function __construct( $name, $type ) {
        $this->name = $name;
        $this->type = $type;
    }
 
    public function getName() {
        return $this->name;
    }
 
    public function getIndexType() {
        return $this->type;
    }
 
    public function setFlag( $flag, $unset = false ) {
        if ( $unset ) {
            $this->flags &= ~$flag;
        } else {
            $this->flags |= $flag;
        }
        return $this;
    }
 
    public function checkFlag( $flag ) {
        return $this->flags & $flag;
    }
 
    public function merge( SearchIndexField $that ) {
        if ( $this->mergeCallback ) {
            return ( $this->mergeCallback )( $this, $that );
        }
        // TODO: which definitions may be compatible?
        if ( ( $that instanceof self ) && $this->type === $that->type &&
            $this->flags === $that->flags && $this->type !== self::INDEX_TYPE_NESTED
        ) {
            return $that;
        }
        return false;
    }
 
    public function getSubfields() {
        return $this->subfields;
    }
 
    public function setSubfields( array $subfields ) {
        $this->subfields = $subfields;
        return $this;
    }
 
    abstract public function getMapping( SearchEngine $engine );
 
    public function setMergeCallback( $callback ) {
        $this->mergeCallback = $callback;
    }
 
    public function getEngineHints( SearchEngine $engine ) {
        return [];
    }
}
 
class_alias( SearchIndexFieldDefinition::class, 'SearchIndexFieldDefinition' );