ElasticSearch

Contracts

ElasticSearchMultiSearchRepositoryContract

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Contracts

Methods

public setIndex(IndexInterface
 $index):ElasticSearchMultiSearchRepositoryContract
Parameters
IndexInterface $index
public addSearch($search):ElasticSearchMultiSearchRepositoryContract
Parameters
$search
public execute():array

ElasticSearchSearchRepositoryContract

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Contracts

Methods

public setIndex(IndexInterface
 $index):ElasticSearchSearchRepositoryContract
Parameters
IndexInterface $index
public addSearch($search):ElasticSearchSearchRepositoryContract
Parameters
$search
public execute():array

Lib

ElasticSearch

elastic search constants

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib

Methods

public static getKeyByLanguage(string $language):string
Parameters
string $language

Lib

Collapse

BaseCollapse

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Collapse

Methods

public addInnerHit(InnerHitInterface
 $innerHit):void
Parameters
InnerHitInterface $innerHit
public toArray():array

CollapseInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Collapse

Methods

public addInnerHit(InnerHitInterface
 $innerHit):void
Parameters
InnerHitInterface $innerHit
public toArray():array

Get the instance as an array.

Index

IndexInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index

Methods

public getType():string
public getPlentyId():int
public getVersion():int
public getDomain():string
public getIdentifier():string
public isAvailable():bool
public isReady():bool
public getSettingsClassName():string
public getMappingClassName():string
public getMeta():array
public getInfo():InfoInterface
public resetAvailibilityStatus():void
public hasUpdatedAt():bool
public hasAllField():bool
public getNext():NextIndex
public getScrollRepositoryClassName():string

NextIndex

to bew written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index

Methods

public getType():void
public getVersion():void
public getDomain():string
public getSettingsClassName():void
public getMappingClassName():void
public getNext():void
public getScrollRepositoryClassName():void
public hasUpdatedAt():bool
public isReady():bool
public maySynchronize():bool

Vorrübergehender Cheat - alles was noch keine Version hat, darf nicht über die "neuen" Prozesse befüllt werden!

public getPlentyId():void
public getIdentifier():string
public isAvailable():bool

Checks whether ElasticSearch is generally available, and whether the index has already been created.

public setRefreshInterval($value):void
Parameters
$value
public resetAvailibilityStatus():void
public getMeta():array
public getInfo():BaseInfo
public mayBeQueuedForCreation():bool
public hasAllField():bool

ReindexIndex

to bew written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index

Methods

public getType():void
public getVersion():void
public getDomain():string
public getMeta():array
public getSettingsClassName():void
public getMappingClassName():void
public getNext():void
public getScrollRepositoryClassName():void
public hasUpdatedAt():bool
public isReady():bool
public maySynchronize():bool

Vorrübergehender Cheat - alles was noch keine Version hat, darf nicht über die "neuen" Prozesse befüllt werden!

public getPlentyId():void
public getIdentifier():string
public isAvailable():bool

Checks whether ElasticSearch is generally available, and whether the index has already been created.

public setRefreshInterval($value):void
Parameters
$value
public resetAvailibilityStatus():void
public getInfo():BaseInfo
public mayBeQueuedForCreation():bool
public hasAllField():bool

Output

DevNullOutput

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Output

Methods

public write(string $message):void
Parameters
string $message
public info(string $message):void
Parameters
string $message
public error(string $message):void
Parameters
string $message

OutputInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Output

Methods

public write(string $message):void
Parameters
string $message
public info(string $message):void
Parameters
string $message
public error(string $message):void
Parameters
string $message

Processor

BaseProcessor

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods

public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public process(array $data):array
Parameters
array $data
public getDependencies():array

DocumentProcessor

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods

public process(array $data):array
Parameters
array $data
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator

ProcessorInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods

public process(array $data):array
Parameters
array $data
public getDependencies():array

SuggestionProcessor

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public process(array $data):array
Parameters
array $data

Search

BaseSearch

Base class for different Search classes

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search

Methods

public addFilter(TypeInterface
 $filter):Search
Parameters
TypeInterface $filter
public addPostFilter(TypeInterface
 $filter):Search
Parameters
TypeInterface $filter
public addQuery(TypeInterface
 $query):Search
Parameters
TypeInterface $query
public addSource(SourceInterface
 $source):Search
Parameters
SourceInterface $source
public setSorting(SortingInterface
 $sorting):Search
Parameters
SortingInterface $sorting
public addAggregation(AggregationInterface
 $aggregation):Search
Parameters
AggregationInterface $aggregation
public addSuggestion(SuggestionInterface
 $suggestion):Search
Parameters
SuggestionInterface $suggestion
public setPage(int $page, int $rowsPerPage):Search
Parameters
int $page
int $rowsPerPage
public setCollapse(CollapseInterface
 $collapse):void
Parameters
CollapseInterface $collapse
public getSources():void
public process(array $data):void
Parameters
array $data
public getName():string
public toArray():array

Get the instance as an array.

SearchGroup

To be written...

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search

Methods

public addSearch(SearchInterface
 $search):void
Parameters
SearchInterface $search
public addFilter(TypeInterface
 $filter):void
Parameters
TypeInterface $filter
public addQuery(TypeInterface
 $query):void
Parameters
TypeInterface $query

SearchInterface

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search

Methods

public addFilter(TypeInterface
 $filter):void
Parameters
TypeInterface $filter
public addQuery(TypeInterface
 $query):void
Parameters
TypeInterface $query
public addSource(SourceInterface
 $source):void
Parameters
SourceInterface $source
public setSorting(SortingInterface
 $sorting):void
Parameters
SortingInterface $sorting
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSuggestion(SuggestionInterface
 $suggestion):void
Parameters
SuggestionInterface $suggestion
public process(array $data):void
Parameters
array $data
public getName():string
public toArray():array

Get the instance as an array.

Sorting

MultipleSorting

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting

Methods

public addSorting(SortingInterface
 $sorting):void
Parameters
SortingInterface $sorting
public add(string $path, string $order = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SORTING_ORDER_ASC):void
Parameters
string $path
string $order
public toArray():array

SingleNestedSorting

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting

Methods

public toArray():array

SingleSorting

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting

Methods

public toArray():array

SortingInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting

Methods

public toArray():array

Get the instance as an array.

Source

ExcludeSource

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source

Methods

public toArray():array
public getPrefix():string
public activateAll():SourceInterface
public activateList(array $fields):Source
Parameters
array $fields

IncludeSource

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source

Methods

public toArray():array
public getPrefix():string
public activateAll():SourceInterface
public activateList(array $fields):Source
Parameters
array $fields

IndependentSource

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source

Methods

public toArray():array
public getPrefix():string
public activateAll():SourceInterface
public activateList(array $fields):Source
Parameters
array $fields

SourceInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source

Methods

public toArray():array

Collapse

InnerHit

BaseInnerHit

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Collapse\InnerHit

Methods

public setSorting(SortingInterface
 $sorting):void
Parameters
SortingInterface $sorting
public setSource(SourceInterface
 $source):void
Parameters
SourceInterface $source
public getName():string
public toArray():array

InnerHitInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Collapse\InnerHit

Methods

public getName():string
public toArray():array

Get the instance as an array.

Data

Document

DocumentInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Data\Document

Methods

public getIndex():IndexInterface
public getSize():int
public toArray():array

Get the instance as an array.

Index

Info

BaseInfo

to bew written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Info

Methods

public get(string $key, $default = null):void
Parameters
string $key
$default
public set(string $key, $value):void
Parameters
string $key
$value
public remove(string $key):void
Parameters
string $key

InfoInterface

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Info

Methods

public get(string $key, $default = null):void
Parameters
string $key
$default
public set(string $key, $value):void
Parameters
string $key
$value
public remove(string $key):void
Parameters
string $key

Settings

SettingsInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Settings

Methods

public toArray():array

Get the instance as an array.

Mapping

Property

PropertyInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Mapping\Property

Methods

public toArray():array

Get the instance as an array.

Type

Complex

ComplexPropertyInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Mapping\Property\Type\Complex

Methods

public getProperties():array
public addProperty(PropertyInterface
 $property):void
Parameters
PropertyInterface $property
public toArray():array

Get the instance as an array.

Query

Statement

StatementInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Statement

Methods

public toArray():array

Get the instance as an array.

Type

TypeInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type

Methods

public toArray():array

Get the instance as an array.

Search

Aggregation

AggregationInterface

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation

Methods

public addSource(SourceInterface
 $source):void
Parameters
SourceInterface $source
public process(array $data):void
Parameters
array $data
public getName():string
public toArray():array

Get the instance as an array.

Document

DocumentSearch

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Document

Methods

public toArray():array
public process(array $data):array
Parameters
array $data
public getFilter():array
public getPostFilter():array
public getQuery():array
public getAggregations():array
public getSuggestions():array
public getSources():void
public getName():void
public setName($name):void
Parameters
$name
public addFilter(TypeInterface
 $filter):Search
Parameters
TypeInterface $filter
public addPostFilter(TypeInterface
 $filter):Search
Parameters
TypeInterface $filter
public addQuery(TypeInterface
 $query):Search
Parameters
TypeInterface $query
public addSource(SourceInterface
 $source):Search
Parameters
SourceInterface $source
public setSorting(SortingInterface
 $sorting):Search
Parameters
SortingInterface $sorting
public addAggregation(AggregationInterface
 $aggregation):Search
Parameters
AggregationInterface $aggregation
public addSuggestion(SuggestionInterface
 $suggestion):Search
Parameters
SuggestionInterface $suggestion
public setPage(int $page, int $rowsPerPage):Search
Parameters
int $page
int $rowsPerPage
public setCollapse(CollapseInterface
 $collapse):void
Parameters
CollapseInterface $collapse

Suggestion

SuggestionInterface

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Suggestion

Methods

public setText(string $text):Suggestion
Parameters
string $text
public process(array $data):array
Parameters
array $data
public getName():string
public toArray():array

Get the instance as an array.

TermSuggestion

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Suggestion

Methods

public toArray():array
public process(array $data):array
Parameters
array $data
public setText(string $text):Suggestion
Parameters
string $text
public getName():string
public getField():string

Source

Mutator

BaseMutator

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source\Mutator

Methods

public getDependencies():array
public mutate(array $data):array
Parameters
array $data

MutatorInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source\Mutator

Methods

public mutate(array $data):array
Parameters
array $data
public getDependencies():array

Mutator

BuiltIn

LanguageMutator

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source\Mutator\BuiltIn

Methods

public mutate(array $data):array
Parameters
array $data
public addLanguage(string $language):void
Parameters
string $language
public setLanguages(array $languages):void
Parameters
array $languages
public setSetLanguageAsIndex(bool $setLanguageAsIndex):void
Parameters
bool $setLanguageAsIndex
public static isSeqArray($array):void
Parameters
$array
public getDependencies():array

Storage

Models

StorageObject

Represent a storage object

Namespace

Plenty\Modules\Cloud\Storage\Models

Properties

Type Name Description
string key
string lastModified
array metaData
string eTag
int size
string storageClass
string body
string contentType
string contentLength

Methods

public toArray()

Returns this model as an array.

StorageObjectList

Represent a list of storage objects

Namespace

Plenty\Modules\Cloud\Storage\Models

Properties

Type Name Description
bool isTruncated
string nextContinuationToken
array objects
array commonPrefixes

Methods

public toArray()

Returns this model as an array.