Maslosoft Manganel API

Name: Manganel
Brand: Maslosoft

Class Manganel

Manganel

Namespace: Maslosoft\Manganel
Author: Piotr Maselkowski
Located at Manganel.php

Methods summary

`public`	# `__construct( string $indexId = self::DefaultIndexId )` Class constructor Class constructor Parameters `$indexId` Codecoverageignore This is implicitly tested
`public static Maslosoft\Manganel\Manganel`	# `create( Maslosoft\Addendum\Interfaces\AnnotatedInterface $model )` Parameters `$model` Returns `Maslosoft\Manganel\Manganel` Codecoverageignore This is implicitly tested
`public static Maslosoft\Manganel\Manganel`	# `fly( string $indexId = self::DefaultIndexId )` Get flyweight instance of Manganel component. Only one instance will be created for each `$indexId`. Get flyweight instance of Manganel component. Only one instance will be created for each `$indexId`. Parameters `$indexId` Returns `Maslosoft\Manganel\Manganel` Codecoverageignore This is implicitly tested New
`public`	# `init( )` Codecoverageignore This is implicitly tested
`public string`	# `getVersion( )` Get mangan version Get mangan version Returns string
`public boolean`	# `drop( )` Drop current index Drop current index Returns boolean
`public Elasticsearch\Client`	# `getClient( )` Returns Elasticsearch\Client Codecoverageignore This is implicitly tested
`public Maslosoft\Mangan\Interfaces\ProfilerInterface`	# `getProfiler( )` Get profiler instance. This is guaranted, if not configured will return NullProfiller. Get profiler instance. This is guaranted, if not configured will return NullProfiller. Returns Maslosoft\Mangan\Interfaces\ProfilerInterface See NullProfiler
`public Maslosoft\Manganel\Manganel`	# `setProfiler( Maslosoft\Mangan\Interfaces\ProfilerInterface $profiller )` Set profiler instance Set profiler instance Parameters `$profiller` Returns `Maslosoft\Manganel\Manganel`

Constants summary

`string`	`DefaultIndexId`	# `'manganel'`

Properties summary

`public array`	`$decorators`	# `[ SearchCriteria::class => [ ConditionDecorator::class, ConditionsDecorator::class, ScrollDecorator::class, SearchDecorator::class, InDecorator::class, NotDecorator::class, RangeDecorator::class, SimpleTermDecorator::class, BoostDecorator::class, PrefixQueryDecorator::class, ] ]`
`public array`	`$hosts`	# `[ 'localhost:9200' ]`
`public`	`$auth`	# `null`
`public string`	`$username`	# `''`
`public string`	`$password`	# `''`
`public array`	`$params`	# `[]`
`public string`	`$index` TODO Enforce lowercase TODO Enforce lowercase	# `'my_index'`
`public string`	`$indexId`	# `self::DefaultIndexId`
`public string\|Closure`	`$refresh` Whether to use refresh option when indexing document. NOTE: Due to performance reasons, this should be set to `true` only when really necessary - so it can be also callback. Whether to use refresh option when indexing document. NOTE: Due to performance reasons, this should be set to `true` only when really necessary - so it can be also callback. Callback function signature: function(AnnotatedInterface $model)	# `false`

API documentation generated by ApiGen

Maslosoft Manganel API

Namespaces

Classes

Class Manganel

Methods summary

Parameters

Codecoverageignore

Parameters

Returns

Codecoverageignore

Parameters

Returns

Codecoverageignore

New

Codecoverageignore

Returns

Returns

Returns

Codecoverageignore

Returns

See

Parameters

Returns

Constants summary

Properties summary

Contact us