Plentymarkets interface documentation

ElasticSearch

Contracts

ElasticSearchMultiSearchRepositoryContract

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Contracts

Methods
public setIndex($index):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchMultiSearchRepositoryContract
Return type: ElasticSearchMultiSearchRepositoryContract
Parameters

Name

Type

Description

$index

IndexInterface

public addSearch($search):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchMultiSearchRepositoryContract
Return type: ElasticSearchMultiSearchRepositoryContract
Parameters

Name

Type

Description

$search

public execute():array

ElasticSearchSearchRepositoryContract

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Contracts

Methods
public setIndex($index):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchSearchRepositoryContract
Return type: ElasticSearchSearchRepositoryContract
Parameters

Name

Type

Description

$index

IndexInterface

public addSearch($search):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchSearchRepositoryContract
Return type: ElasticSearchSearchRepositoryContract
Parameters

Name

Type

Description

$search

public execute():array

Lib

ElasticSearch

elastic search constants

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib

Methods
public static getKeyByLanguage($language):string
Parameters

Name

Type

Description

$language

string

Lib

Collapse

BaseCollapse

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Collapse

Methods
public addInnerHit($innerHit):void
Parameters

Name

Type

Description

$innerHit

InnerHitInterface

public toArray():array

CollapseInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Collapse

Methods
public addInnerHit($innerHit):void
Parameters

Name

Type

Description

$innerHit

InnerHitInterface

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 getDynamicTemplateClassName():string
public getMeta():array
public getInfo():Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Info\InfoInterface
Return type: InfoInterface
public resetAvailibilityStatus():void
public hasUpdatedAt():bool
public hasAllField():bool
public getNext():Plenty\Modules\Cloud\ElasticSearch\Lib\Index\NextIndex
Return type: NextIndex
public getScrollRepositoryClassName():string
public refresh():bool
public getElasticSearchVersion():float

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 getDynamicTemplateClassName():void
public getNext():void
public getScrollRepositoryClassName():void
public getElasticSearchVersion():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

Name

Type

Description

$value

public resetAvailibilityStatus():void
public getMeta():array
public getInfo():Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Info\BaseInfo
Return type: BaseInfo
public mayBeQueuedForCreation():bool
public hasAllField():bool
public refresh():void

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 getDynamicTemplateClassName():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

Name

Type

Description

$value

public resetAvailibilityStatus():void
public getInfo():Plenty\Modules\Cloud\ElasticSearch\Lib\Index\Info\BaseInfo
Return type: BaseInfo
public mayBeQueuedForCreation():bool
public hasAllField():bool
public refresh():void
public getElasticSearchVersion():void

Output

DevNullOutput

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Output

Methods
public write($message):void
Parameters

Name

Type

Description

$message

string

public info($message):void
Parameters

Name

Type

Description

$message

string

public error($message):void
Parameters

Name

Type

Description

$message

string

OutputInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Output

Methods
public write($message):void
Parameters

Name

Type

Description

$message

string

public info($message):void
Parameters

Name

Type

Description

$message

string

public error($message):void
Parameters

Name

Type

Description

$message

string

Processor

BaseProcessor

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

public process($data):array
Parameters

Name

Type

Description

$data

array

public getDependencies():array

DocumentInnerHitsToRootProcessor

DocumentInnerHitsToRootProcessor

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

DocumentProcessor

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

ProcessorInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getDependencies():array

SuggestionProcessor

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Processor

Methods
public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

public process($data):array
Parameters

Name

Type

Description

$data

array

BaseSearch

Base class for different Search classes

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search

Methods
public setIsSourceDisabled($isSourceDisabled):void
Parameters

Name

Type

Description

$isSourceDisabled

bool

public setTrackTotalHits($trackTotalHits):void
Parameters

Name

Type

Description

$trackTotalHits

bool

public addFilter($filter):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$filter

TypeInterface

public addPostFilter($filter):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$filter

TypeInterface

public addQuery($query):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$query

TypeInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$source

SourceInterface

public setSorting($sorting):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$sorting

SortingInterface

public addAggregation($aggregation):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSuggestion($suggestion):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$suggestion

SuggestionInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public setPagination($pagination):void
Parameters

Name

Type

Description

$pagination

public setCollapse($collapse):void
Parameters

Name

Type

Description

$collapse

CollapseInterface

public getSources():void
public setScoreModifier($scoreModifier):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$scoreModifier

ScoreModifierInterface

public setMaxResultWindow($maxResults = 10000):void
Parameters

Name

Type

Description

$maxResults

int

public setIndex($index):void
Parameters

Name

Type

Description

$index

public isSearchAfter():void
public getFilterRaw():void
public getQueriesRaw():void
public getAggregationsRaw():array
public getSorting():void
public getScoreModifier():void
public process($data):void
Parameters

Name

Type

Description

$data

array

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($search):void
Parameters

Name

Type

Description

$search

SearchInterface

public addFilter($filter):void
Parameters

Name

Type

Description

$filter

TypeInterface

public addQuery($query):void
Parameters

Name

Type

Description

$query

TypeInterface

SearchInterface

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Search

Methods
public addFilter($filter):void
Parameters

Name

Type

Description

$filter

TypeInterface

public addQuery($query):void
Parameters

Name

Type

Description

$query

TypeInterface

public addSource($source):void
Parameters

Name

Type

Description

$source

SourceInterface

public setSorting($sorting):void
Parameters

Name

Type

Description

$sorting

SortingInterface

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSuggestion($suggestion):void
Parameters

Name

Type

Description

$suggestion

SuggestionInterface

public process($data):void
Parameters

Name

Type

Description

$data

array

public getName():string
public setMaxResultWindow($maxResults = 10000):void
Parameters

Name

Type

Description

$maxResults

int

public setPagination($pagination):void
Parameters

Name

Type

Description

$pagination

public isSearchAfter():void
public toArray():array

Get the instance as an array.

Sorting

MultipleSorting

To be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting

Methods
public addSorting($sorting):void
Parameters

Name

Type

Description

$sorting

SortingInterface

public add($path, $order = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SORTING_ORDER_ASC):void
Parameters

Name

Type

Description

$path

string

$order

string

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():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\SourceInterface
Return type: SourceInterface
public activate():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\SourceInterface
Return type: SourceInterface
public activateList($fields):Plenty\Modules\Cloud\ElasticSearch\Lib\Source
Return type: Source
Parameters

Name

Type

Description

$fields

array

IncludeSource

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source

Methods
public toArray():array
public getPrefix():string
public activateAll():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\SourceInterface
Return type: SourceInterface
public activate():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\SourceInterface
Return type: SourceInterface
public activateList($fields):Plenty\Modules\Cloud\ElasticSearch\Lib\Source
Return type: Source
Parameters

Name

Type

Description

$fields

array

IndependentSource

foo

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source

Methods
public toArray():array
public getPrefix():string
public activateAll():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\SourceInterface
Return type: SourceInterface
public activate():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\SourceInterface
Return type: SourceInterface
public activateList($fields):Plenty\Modules\Cloud\ElasticSearch\Lib\Source
Return type: Source
Parameters

Name

Type

Description

$fields

array

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($sorting):void
Parameters

Name

Type

Description

$sorting

SortingInterface

public setSource($source):void
Parameters

Name

Type

Description

$source

SourceInterface

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():Plenty\Modules\Cloud\ElasticSearch\Lib\Index\IndexInterface
Return type: 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($key, $default = null):void
Parameters

Name

Type

Description

$key

string

$default

public set($key, $value):void
Parameters

Name

Type

Description

$key

string

$value

public remove($key):void
Parameters

Name

Type

Description

$key

string

InfoInterface

foo

Namespace

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

Methods
public get($key, $default = null):void
Parameters

Name

Type

Description

$key

string

$default

public set($key, $value):void
Parameters

Name

Type

Description

$key

string

$value

public remove($key):void
Parameters

Name

Type

Description

$key

string

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 setIndex($index):void
Parameters

Name

Type

Description

$index

IndexInterface

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($property):void
Parameters

Name

Type

Description

$property

PropertyInterface

public setIndex($index):void
Parameters

Name

Type

Description

$index

IndexInterface

public toArray():array

Get the instance as an array.

Filter

BoolShouldStatementFilter

Combine multiple filters. minimum should match defines how many statements need to match

Namespace

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

Methods
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

Query

MultiMatchQuery

to be written

Namespace

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

Methods
public addField($field, $boost):void
Parameters

Name

Type

Description

$field

string

$boost

int

public toArray():array
public setType($type):void
Parameters

Name

Type

Description

$type

string

public setOperator($operator):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\Query\MultiMatchQuery
Return type: MultiMatchQuery
Parameters

Name

Type

Description

$operator

string

public setFuzzy($fuzzy):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\Query\MultiMatchQuery
Return type: MultiMatchQuery
Parameters

Name

Type

Description

$fuzzy

bool

ScoreModifier

RandomScore

to be written

Namespace

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

Methods
public getFunction():array
public getBoostMode():void
public getSeed():string
public setSeed($seed):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\ScoreModifier\RandomScore
Return type: RandomScore
Parameters

Name

Type

Description

$seed

string

public setQuery($query):void
Parameters

Name

Type

Description

$query

public toArray():void

ScoreModifierInterface

To be written

Namespace

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

Methods
public setQuery($query):void
Parameters

Name

Type

Description

$query

public toArray():array

Get the instance as an array.

Statement

Filter

MultiMatchFilter

to be written

Namespace

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

Methods
public addField($field, $boost):void
Parameters

Name

Type

Description

$field

string

$boost

int

public toArray():array
public setType($type):void
Parameters

Name

Type

Description

$type

string

public setOperator($operator):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Statement\Filter\MultiMatchFilter
Return type: MultiMatchFilter
Parameters

Name

Type

Description

$operator

string

public setFuzzy($fuzzy):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Statement\Filter\MultiMatchFilter
Return type: MultiMatchFilter
Parameters

Name

Type

Description

$fuzzy

bool

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.

Aggregation

AggregationInterface

To be written

Namespace

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

Methods
public addSource($source):void
Parameters

Name

Type

Description

$source

SourceInterface

public process($data):void
Parameters

Name

Type

Description

$data

array

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($data):array
Parameters

Name

Type

Description

$data

array

public getFilter():array
public getPostFilter():array
public getQuery():array
public getAggregations():array
public getSuggestions():array
public getSources():void
public addDependenciesToSource($sources):void
Parameters

Name

Type

Description

$sources

public getName():void
public setName($name):void
Parameters

Name

Type

Description

$name

public setIsSourceDisabled($isSourceDisabled):void
Parameters

Name

Type

Description

$isSourceDisabled

bool

public setTrackTotalHits($trackTotalHits):void
Parameters

Name

Type

Description

$trackTotalHits

bool

public addFilter($filter):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$filter

TypeInterface

public addPostFilter($filter):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$filter

TypeInterface

public addQuery($query):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$query

TypeInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$source

SourceInterface

public setSorting($sorting):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$sorting

SortingInterface

public addAggregation($aggregation):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSuggestion($suggestion):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$suggestion

SuggestionInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public setPagination($pagination):void
Parameters

Name

Type

Description

$pagination

public setCollapse($collapse):void
Parameters

Name

Type

Description

$collapse

CollapseInterface

public setScoreModifier($scoreModifier):Plenty\Modules\Cloud\ElasticSearch\Lib\Search
Return type: Search
Parameters

Name

Type

Description

$scoreModifier

ScoreModifierInterface

public setMaxResultWindow($maxResults = 10000):void
Parameters

Name

Type

Description

$maxResults

int

public setIndex($index):void
Parameters

Name

Type

Description

$index

public isSearchAfter():void
public getFilterRaw():void
public getQueriesRaw():void
public getAggregationsRaw():array
public getSorting():void
public getScoreModifier():void

Suggestion

SuggestionInterface

To be written

Namespace

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

Methods
public setText($text):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Suggestion
Return type: Suggestion
Parameters

Name

Type

Description

$text

string

public process($data):array
Parameters

Name

Type

Description

$data

array

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($data):array
Parameters

Name

Type

Description

$data

array

public setText($text):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Suggestion
Return type: Suggestion
Parameters

Name

Type

Description

$text

string

public getName():string
public getField():string

Source

Condition

ConditionInterface

to be written

Namespace

Plenty\Modules\Cloud\ElasticSearch\Lib\Source\Condition

Methods
public isValid($document):bool
Parameters

Name

Type

Description

$document

array

Mutator

BaseMutator

to be written

Namespace

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

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

Name

Type

Description

$data

array

MutatorInterface

to be written

Namespace

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

Methods
public mutate($data):array
Parameters

Name

Type

Description

$data

array

public getDependencies():array

Mutator

BuiltIn

LanguageMutator

foo

Namespace

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

Methods
public mutate($data):array
Parameters

Name

Type

Description

$data

array

public addLanguage($language):void
Parameters

Name

Type

Description

$language

string

public setLanguages($languages):void
Parameters

Name

Type

Description

$languages

array

public setSetLanguageAsIndex($setLanguageAsIndex):void
Parameters

Name

Type

Description

$setLanguageAsIndex

bool

public static isSeqArray($array):void
Parameters

Name

Type

Description

$array

public getDependencies():array

Storage

Models

StorageObject

Represent a storage object

Namespace

Plenty\Modules\Cloud\Storage\Models

Properties
Name Type Description

key

string

lastModified

string

metaData

array

eTag

string

size

int

storageClass

string

body

string

contentType

string

contentLength

string

Methods
public toArray()

Returns this model as an array.

StorageObjectList

Represent a list of storage objects

Namespace

Plenty\Modules\Cloud\Storage\Models

Properties
Name Type Description

isTruncated

bool

nextContinuationToken

string

objects

array

commonPrefixes

array

Methods
public toArray()

Returns this model as an array.