PHP Class Nqxcode\LuceneSearch\Model\Config

Show file Open project: nqxcode/laravel-lucene-search Class Usage Examples

Public Methods

Method Description
__construct ( array $configuration, Nqxcode\LuceneSearch\Model\Factory $modelFactory ) Create configuration for models.
boost ( Model $model ) : integer Get boost for model.
classUidPair ( Model $model ) : array Get 'key-value' pair for UID of model class.
fields ( Model $model ) : array Get model fields for indexing.
models ( ZendSearch\Lucene\Search\QueryHit[] $hits ) : Nqxcode\LuceneSearch\Support\Collection Get models by query hits.
optionalAttributes ( Model $model ) : array Get optional attributes for indexing for model.
primaryKeyPair ( Model $model ) : array Get 'key-value' pair for private key of model.
repositories ( ) : Model[] | Builder[] Get full list of models instances.

Private Methods

Method Description
classUidList ( ZendSearch\Lucene\Search\QueryHit[] $hits ) : array Get classes uid list for hits.
config ( Model $model ) : array Get configuration for model.
groupedSearchableIdsAsKeys ( array $hits ) : array Get searchable id list grouped by classes.
model ( ZendSearch\Lucene\Search\QueryHit $hit ) : Illuminate\Database\Eloquent\Collection | Model | static Get the model by query hit.
newInstanceBy ( $classUid ) : Model Create instance of model by class UID.

Method Details

__construct() public method

Create configuration for models.
public __construct ( array $configuration, Nqxcode\LuceneSearch\Model\Factory $modelFactory )
$configuration array
$modelFactory Nqxcode\LuceneSearch\Model\Factory

boost() public method

Get boost for model.
public boost ( Model $model ) : integer
$model Illuminate\Database\Eloquent\Model
return integer

classUidPair() public method

Get 'key-value' pair for UID of model class.
public classUidPair ( Model $model ) : array
$model Illuminate\Database\Eloquent\Model
return array

fields() public method

Get model fields for indexing.
public fields ( Model $model ) : array
$model Illuminate\Database\Eloquent\Model
return array

models() public method

Get models by query hits.
public models ( ZendSearch\Lucene\Search\QueryHit[] $hits ) : Nqxcode\LuceneSearch\Support\Collection
$hits ZendSearch\Lucene\Search\QueryHit[]
return Nqxcode\LuceneSearch\Support\Collection

optionalAttributes() public method

Get optional attributes for indexing for model.
public optionalAttributes ( Model $model ) : array
$model Illuminate\Database\Eloquent\Model
return array

primaryKeyPair() public method

Get 'key-value' pair for private key of model.
public primaryKeyPair ( Model $model ) : array
$model Illuminate\Database\Eloquent\Model
return array

repositories() public method

Get full list of models instances.
public repositories ( ) : Model[] | Builder[]
return Illuminate\Database\Eloquent\Model[] | Illuminate\Database\Query\Builder[]