diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-AttributeValueProcessorException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-AttributeValueProcessorException.html new file mode 100644 index 0000000000..1353b96882 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-AttributeValueProcessorException.html @@ -0,0 +1,297 @@ + + + + + AttributeValueProcessorException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AttributeValueProcessorException

+ +
+ AttributeValueProcessorException.php + : + 13 + +
+
Interface
+ +
+ Extends + Throwable
+
+ + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-FieldValueProcessorException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-FieldValueProcessorException.html new file mode 100644 index 0000000000..10bd6457a9 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-FieldValueProcessorException.html @@ -0,0 +1,297 @@ + + + + + FieldValueProcessorException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ FieldValueProcessorException

+ +
+ FieldValueProcessorException.php + : + 13 + +
+
Interface
+ +
+ Extends + Throwable
+
+ + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-StreamingApiRequestFailedException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-StreamingApiRequestFailedException.html new file mode 100644 index 0000000000..f33c44f3fe --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Exception-StreamingApiRequestFailedException.html @@ -0,0 +1,466 @@ + + + + + StreamingApiRequestFailedException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ StreamingApiRequestFailedException

+ +
+ StreamingApiRequestFailedException.php + : + 14 + +
+ +
+ Extends RuntimeException +
+ + +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ StreamingApiRequestFailedException.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(ResponseInterface $response[, string $message = null ][, int $code = 0 ][, Throwable $previous = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $response + + ResponseInterface + + - + + - +
+ $message + + string + + null + + - +
+ $code + + int + + 0 + + - +
+ $previous + + Throwable + + null + + - +
+ + +
+

+ publicgetResponse() + +

+
+ StreamingApiRequestFailedException.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getResponse() : ResponseInterface
+
+
+
+
+
+

Return values

+

ResponseInterface

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-AbstractDataExporter.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-AbstractDataExporter.html new file mode 100644 index 0000000000..5733e9ab01 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-AbstractDataExporter.html @@ -0,0 +1,642 @@ + + + + + AbstractDataExporter | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AbstractDataExporter

+ +
+ AbstractDataExporter.php + : + 16 + +
+
Abstract
+ + +
+ Implements + DataExporterInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ AbstractDataExporter.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(TransportInterface $transport, DatasetBuilderInterface $datasetBuilder, iterable<string|int, ExportDataProcessorInterface> $exportDataPostProcessors)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $transport + + TransportInterface + + - + + - +
+ $datasetBuilder + + DatasetBuilderInterface + + - + + - +
+ $exportDataPostProcessors + + iterable<string|int, ExportDataProcessorInterface> + + - + + - +
+ + +
+

+ publicexport() + +

+
+ AbstractDataExporter.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public export(DataExportContextInterface $dataExportContext, TransportContextInterface $transportContext) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $dataExportContext + + DataExportContextInterface + + - + + - +
+ $transportContext + + TransportContextInterface + + - + + - +
+ + +
+

+ protectedcreateBuildParameters() + +

+
+ AbstractDataExporter.php + : + 66 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected abstract createBuildParameters(DataExportContextInterface $dataExportContext, TransportContextInterface $transportContext) : BuildParametersInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $dataExportContext + + DataExportContextInterface + + - + + - +
+ $transportContext + + TransportContextInterface + + - + + - +
+

Return values

+

BuildParametersInterface

+ + +
+

+ protectedvalidateDataExportContext() + +

+
+ AbstractDataExporter.php + : + 64 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected abstract validateDataExportContext(DataExportContextInterface $dataExportContext) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $dataExportContext + + DataExportContextInterface + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-ContentDataExportContext.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-ContentDataExportContext.html new file mode 100644 index 0000000000..d00f75e6cc --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-ContentDataExportContext.html @@ -0,0 +1,496 @@ + + + + + ContentDataExportContext | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ContentDataExportContext

+ +
+ ContentDataExportContext.php + : + 13 + +
+
Final
+ + +
+ Implements + DataExportContextInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ContentDataExportContext.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, Criterion> $criteria)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + array<string|int, Criterion> + + - + + - +
+ + +
+

+ publicgetCriteria() + +

+
+ ContentDataExportContext.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCriteria() : array<string|int, Criterion>
+
+
+
+
+
+

Return values

+

array<string|int, Criterion>

+ + +
+

+ publicsetCriteria() + +

+
+ ContentDataExportContext.php + : + 37 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setCriteria(array<string|int, Criterion> $criteria) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + array<string|int, Criterion> + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-ContentDatasetBuildParameters.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-ContentDatasetBuildParameters.html new file mode 100644 index 0000000000..d5fbeca61d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-ContentDatasetBuildParameters.html @@ -0,0 +1,541 @@ + + + + + ContentDatasetBuildParameters | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ContentDatasetBuildParameters

+ +
+ ContentDatasetBuildParameters.php + : + 13 + +
+
Final
+ + +
+ Implements + BuildParametersInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ContentDatasetBuildParameters.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, Criterion> $criteria[, int|null $limit = null ][, int|null $offset = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + array<string|int, Criterion> + + - + + - +
+ $limit + + int|null + + null + + - +
+ $offset + + int|null + + null + + - +
+ + +
+

+ publicgetCriteria() + +

+
+ ContentDatasetBuildParameters.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCriteria() : array<string|int, Criterion>
+
+
+
+
+
+

Return values

+

array<string|int, Criterion>

+ + +
+

+ publicgetLimit() + +

+
+ ContentDatasetBuildParameters.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getLimit() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+

+ publicgetOffset() + +

+
+ ContentDatasetBuildParameters.php + : + 45 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getOffset() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-FieldProcessorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-FieldProcessorInterface.html new file mode 100644 index 0000000000..cb9445fd29 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-FieldProcessorInterface.html @@ -0,0 +1,480 @@ + + + + + FieldProcessorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ FieldProcessorInterface

+ +
+ FieldProcessorInterface.php + : + 17 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicprocess() + +

+
+ FieldProcessorInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(Field $field, Content $content) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $field + + Field + + - + + - +
+ $content + + Content + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicsupports() + +

+
+ FieldProcessorInterface.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(Field $field, Content $content) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $field + + Field + + - + + - +
+ $content + + Content + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-FieldValueProcessorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-FieldValueProcessorInterface.html new file mode 100644 index 0000000000..177b59f263 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Content-FieldValueProcessorInterface.html @@ -0,0 +1,480 @@ + + + + + FieldValueProcessorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ FieldValueProcessorInterface

+ +
+ FieldValueProcessorInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicprocess() + +

+
+ FieldValueProcessorInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(Field $field, Content $content) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $field + + Field + + - + + - +
+ $content + + Content + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicsupports() + +

+
+ FieldValueProcessorInterface.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(Field $field, Content $content) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $field + + Field + + - + + - +
+ $content + + Content + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-DataExportContextInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-DataExportContextInterface.html new file mode 100644 index 0000000000..41dd55d783 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-DataExportContextInterface.html @@ -0,0 +1,294 @@ + + + + + DataExportContextInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DataExportContextInterface

+ +
+ DataExportContextInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-DataExporterInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-DataExporterInterface.html new file mode 100644 index 0000000000..391f5bcb1e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-DataExporterInterface.html @@ -0,0 +1,391 @@ + + + + + DataExporterInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DataExporterInterface

+ +
+ DataExporterInterface.php + : + 13 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicexport() + +

+
+ DataExporterInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public export(DataExportContextInterface $dataExportContext, TransportContextInterface $transportContext) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $dataExportContext + + DataExportContextInterface + + - + + - +
+ $transportContext + + TransportContextInterface + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-AbstractDatasetBuilder.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-AbstractDatasetBuilder.html new file mode 100644 index 0000000000..006b86c2bd --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-AbstractDatasetBuilder.html @@ -0,0 +1,786 @@ + + + + + AbstractDatasetBuilder | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AbstractDatasetBuilder

+ +
+ AbstractDatasetBuilder.php + : + 13 + +
+
Abstract
+ + +
+ Implements + DatasetBuilderInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ AbstractDatasetBuilder.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(iterable<string|int, ItemProcessorInterface> $itemProcessors, iterable<string|int, ExportDataProcessorInterface> $exportDataPostProcessors)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $itemProcessors + + iterable<string|int, ItemProcessorInterface> + + - + + - +
+ $exportDataPostProcessors + + iterable<string|int, ExportDataProcessorInterface> + + - + + - +
+ + +
+

+ publicbuildItem() + +

+
+ AbstractDatasetBuilder.php + : + 44 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public buildItem(object $item, BuildParametersInterface $buildParameters) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $item + + object + + - + + - +
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicbuildIterator() + +

+
+ AbstractDatasetBuilder.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public buildIterator(BuildParametersInterface $buildParameters) : DatasetIterator
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

DatasetIterator

+ + +
+

+ publicpostProcess() + +

+
+ AbstractDatasetBuilder.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public postProcess(array<string|int, mixed> $dataset, BuildParametersInterface $buildParameters) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $dataset + + array<string|int, mixed> + + - + + - +
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ protectedgetInternalIterator() + +

+
+ AbstractDatasetBuilder.php + : + 71 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected abstract getInternalIterator(BuildParametersInterface $buildParameters) : Iterator
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

Iterator

+ + +
+

+ protectedvalidateBuildParameters() + +

+
+ AbstractDatasetBuilder.php + : + 76 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected abstract validateBuildParameters(BuildParametersInterface $buildParameters) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $buildParameters + + BuildParametersInterface + + - + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-BuildParametersInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-BuildParametersInterface.html new file mode 100644 index 0000000000..6dc1fc8e24 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-BuildParametersInterface.html @@ -0,0 +1,398 @@ + + + + + BuildParametersInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BuildParametersInterface

+ +
+ BuildParametersInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetLimit() + +

+
+ BuildParametersInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getLimit() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+

+ publicgetOffset() + +

+
+ BuildParametersInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getOffset() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-DatasetBuilderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-DatasetBuilderInterface.html new file mode 100644 index 0000000000..1b006f299d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-DatasetBuilderInterface.html @@ -0,0 +1,554 @@ + + + + + DatasetBuilderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DatasetBuilderInterface

+ +
+ DatasetBuilderInterface.php + : + 19 + +
+
Interface
+ +
+

DatasetBuilder creates Iterator that is used to create batches of processed data.

+ + +
+

Data format is defined by { @see DatasetBuilderInterface::buildItem() } method and uses arbitrary array structure.

+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicbuildItem() + +

+
+ DatasetBuilderInterface.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public buildItem(object $item, BuildParametersInterface $buildParameters) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $item + + object + + - + + - +
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicbuildIterator() + +

+
+ DatasetBuilderInterface.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public buildIterator(BuildParametersInterface $buildParameters) : DatasetIterator
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

DatasetIterator

+ + +
+

+ publicpostProcess() + +

+
+ DatasetBuilderInterface.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public postProcess(array<string|int, mixed> $dataset, BuildParametersInterface $buildParameters) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $dataset + + array<string|int, mixed> + + - + + - +
+ $buildParameters + + BuildParametersInterface + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-DatasetIterator.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-DatasetIterator.html new file mode 100644 index 0000000000..06d918e120 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-DatasetIterator.html @@ -0,0 +1,630 @@ + + + + + DatasetIterator | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DatasetIterator

+ +
+ DatasetIterator.php + : + 13 + +
+
Final
+ + +
+ Implements + Iterator
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ DatasetIterator.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(DatasetBuilderInterface $datasetBuilder, BuildParametersInterface $buildParameters, Iterator $internalDatasetIterator)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $datasetBuilder + + DatasetBuilderInterface + + - + + - +
+ $buildParameters + + BuildParametersInterface + + - + + - +
+ $internalDatasetIterator + + Iterator + + - + + - +
+ + +
+

+ publiccurrent() + +

+
+ DatasetIterator.php + : + 50 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public current() : array<string|int, mixed>
+
+
+
+
+
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publickey() + +

+
+ DatasetIterator.php + : + 64 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public key() : mixed
+
+
+
+
+
+ + +
+
+ Attributes + +
+
+
+ #[ReturnTypeWillChange] +
+
+
+
+

+ publicnext() + +

+
+ DatasetIterator.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public next() : void
+
+
+
+
+
+ + +
+

+ publicrewind() + +

+
+ DatasetIterator.php + : + 42 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public rewind() : void
+
+
+
+
+
+ + +
+

+ publicvalid() + +

+
+ DatasetIterator.php + : + 37 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public valid() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-ItemProcessorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-ItemProcessorInterface.html new file mode 100644 index 0000000000..5543fddccf --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Dataset-ItemProcessorInterface.html @@ -0,0 +1,480 @@ + + + + + ItemProcessorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ItemProcessorInterface

+ +
+ ItemProcessorInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicprocess() + +

+
+ ItemProcessorInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(array<string, scalar|null> $processedItemData, object $item) : array<string, scalar|null>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $processedItemData + + array<string, scalar|null> + + - + + - +
+ $item + + object + + - + + - +
+

Return values

+

array<string, scalar|null>

+ + +
+

+ publicsupports() + +

+
+ ItemProcessorInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(array<string, scalar|null> $processedItemData, object $item) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $processedItemData + + array<string, scalar|null> + + - + + - +
+ $item + + object + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-ExportDataProcessorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-ExportDataProcessorInterface.html new file mode 100644 index 0000000000..7efe9a1cc5 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-ExportDataProcessorInterface.html @@ -0,0 +1,456 @@ + + + + + ExportDataProcessorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ExportDataProcessorInterface

+ +
+ ExportDataProcessorInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicprocess() + +

+
+ ExportDataProcessorInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(array<string|int, mixed> $data) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $data + + array<string|int, mixed> + + - + +
+

Arbitrary data structure matching data mapping in CDP

+ +
+ +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicsupports() + +

+
+ ExportDataProcessorInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(array<string|int, mixed> $data) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $data + + array<string|int, mixed> + + - + +
+

Arbitrary data structure matching data mapping in CDP

+ +
+ +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-AttributeProcessorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-AttributeProcessorInterface.html new file mode 100644 index 0000000000..c93532635c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-AttributeProcessorInterface.html @@ -0,0 +1,480 @@ + + + + + AttributeProcessorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AttributeProcessorInterface

+ +
+ AttributeProcessorInterface.php + : + 17 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicprocess() + +

+
+ AttributeProcessorInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(AttributeInterface $attribute, ProductInterface $product) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $attribute + + AttributeInterface + + - + + - +
+ $product + + ProductInterface + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicsupports() + +

+
+ AttributeProcessorInterface.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(AttributeInterface $attribute, ProductInterface $product) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $attribute + + AttributeInterface + + - + + - +
+ $product + + ProductInterface + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-AttributeValueProcessorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-AttributeValueProcessorInterface.html new file mode 100644 index 0000000000..e5e32b63e3 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-AttributeValueProcessorInterface.html @@ -0,0 +1,480 @@ + + + + + AttributeValueProcessorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AttributeValueProcessorInterface

+ +
+ AttributeValueProcessorInterface.php + : + 16 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicprocess() + +

+
+ AttributeValueProcessorInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(AttributeInterface $attribute, object $product) : array<string|int, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $attribute + + AttributeInterface + + - + + - +
+ $product + + object + + - + + - +
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicsupports() + +

+
+ AttributeValueProcessorInterface.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(AttributeInterface $attribute, object $product) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $attribute + + AttributeInterface + + - + + - +
+ $product + + object + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-ProductDataExportContext.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-ProductDataExportContext.html new file mode 100644 index 0000000000..38b8c7b150 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-ProductDataExportContext.html @@ -0,0 +1,496 @@ + + + + + ProductDataExportContext | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductDataExportContext

+ +
+ ProductDataExportContext.php + : + 13 + +
+
Final
+ + +
+ Implements + DataExportContextInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ProductDataExportContext.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, CriterionInterface> $criteria)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + array<string|int, CriterionInterface> + + - + + - +
+ + +
+

+ publicgetCriteria() + +

+
+ ProductDataExportContext.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCriteria() : array<string|int, CriterionInterface>
+
+
+
+
+
+

Return values

+

array<string|int, CriterionInterface>

+ + +
+

+ publicsetCriteria() + +

+
+ ProductDataExportContext.php + : + 37 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setCriteria(array<string|int, CriterionInterface> $criteria) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + array<string|int, CriterionInterface> + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-ProductDatasetBuildParameters.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-ProductDatasetBuildParameters.html new file mode 100644 index 0000000000..8c2d67c181 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Product-ProductDatasetBuildParameters.html @@ -0,0 +1,541 @@ + + + + + ProductDatasetBuildParameters | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductDatasetBuildParameters

+ +
+ ProductDatasetBuildParameters.php + : + 13 + +
+
Final
+ + +
+ Implements + BuildParametersInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ProductDatasetBuildParameters.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, CriterionInterface> $criteria[, int|null $limit = null ][, int|null $offset = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + array<string|int, CriterionInterface> + + - + + - +
+ $limit + + int|null + + null + + - +
+ $offset + + int|null + + null + + - +
+ + +
+

+ publicgetCriteria() + +

+
+ ProductDatasetBuildParameters.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCriteria() : array<string|int, CriterionInterface>
+
+
+
+
+
+

Return values

+

array<string|int, CriterionInterface>

+ + +
+

+ publicgetLimit() + +

+
+ ProductDatasetBuildParameters.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getLimit() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+

+ publicgetOffset() + +

+
+ ProductDatasetBuildParameters.php + : + 45 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getOffset() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-StreamingApiClientInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-StreamingApiClientInterface.html new file mode 100644 index 0000000000..f03da25eef --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-StreamingApiClientInterface.html @@ -0,0 +1,409 @@ + + + + + StreamingApiClientInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ StreamingApiClientInterface

+ +
+ StreamingApiClientInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicstreamData() + +

+
+ StreamingApiClientInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public streamData(array<string|int, mixed> $data, string $streamId[, bool $isDraft = true ]) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $data + + array<string|int, mixed> + + - + +
+

Data has arbitrary structure that reflects data mapping in CDP

+ +
+ +
+ $streamId + + string + + - + + - +
+ $isDraft + + bool + + true + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-AbstractTransportContext.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-AbstractTransportContext.html new file mode 100644 index 0000000000..f15585938b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-AbstractTransportContext.html @@ -0,0 +1,496 @@ + + + + + AbstractTransportContext | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AbstractTransportContext

+ +
+ AbstractTransportContext.php + : + 11 + +
+
Abstract
+ + +
+ Implements + TransportContextInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ AbstractTransportContext.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(bool $isDraft)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $isDraft + + bool + + - + + - +
+ + +
+

+ publicisDraft() + +

+
+ AbstractTransportContext.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isDraft() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetIsDraft() + +

+
+ AbstractTransportContext.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setIsDraft(bool $isDraft) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $isDraft + + bool + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextBuilderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextBuilderInterface.html new file mode 100644 index 0000000000..338821f156 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextBuilderInterface.html @@ -0,0 +1,452 @@ + + + + + TransportContextBuilderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TransportContextBuilderInterface

+ +
+ TransportContextBuilderInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicbuild() + +

+
+ TransportContextBuilderInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public build(array{transport: string, stream_file: array{stream_id: string}} $data) : TransportContextInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $data + + array{transport: string, stream_file: array{stream_id: string}} + + - + + - +
+

Return values

+

TransportContextInterface

+ + +
+

+ publicsupports() + +

+
+ TransportContextBuilderInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(string $type) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $type + + string + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextFactoryInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextFactoryInterface.html new file mode 100644 index 0000000000..da2b24d689 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextFactoryInterface.html @@ -0,0 +1,383 @@ + + + + + TransportContextFactoryInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TransportContextFactoryInterface

+ +
+ TransportContextFactoryInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publiccreateTransportContext() + +

+
+ TransportContextFactoryInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public createTransportContext(string $type) : TransportContextInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $type + + string + + - + + - +
+

Return values

+

TransportContextInterface

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextInterface.html new file mode 100644 index 0000000000..61b4d24e6b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportContextInterface.html @@ -0,0 +1,423 @@ + + + + + TransportContextInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TransportContextInterface

+ +
+ TransportContextInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicisDraft() + +

+
+ TransportContextInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isDraft() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetIsDraft() + +

+
+ TransportContextInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setIsDraft(bool $isDraft) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $isDraft + + bool + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportInterface.html new file mode 100644 index 0000000000..4f2b0d0c2b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-Transport-TransportInterface.html @@ -0,0 +1,399 @@ + + + + + TransportInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TransportInterface

+ +
+ TransportInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicsendData() + +

+
+ TransportInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public sendData(array<string|int, mixed> $data, TransportContextInterface $transportContext) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $data + + array<string|int, mixed> + + - + +
+

Arbitrary data matching dataflow mapping in CDP

+ +
+ +
+ $transportContext + + TransportContextInterface + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-AbstractUserItemProcessor.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-AbstractUserItemProcessor.html new file mode 100644 index 0000000000..24292f268d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-AbstractUserItemProcessor.html @@ -0,0 +1,705 @@ + + + + + AbstractUserItemProcessor | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AbstractUserItemProcessor

+ +
+ AbstractUserItemProcessor.php + : + 16 + +
+
Abstract
+ + +
+ Implements + ItemProcessorInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ AbstractUserItemProcessor.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $userFieldTypeIdentifier)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $userFieldTypeIdentifier + + string + + - + + - +
+ + +
+

+ publicprocess() + +

+
+ AbstractUserItemProcessor.php + : + 49 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public process(array<string|int, mixed> $processedItemData, Content $item) : array<string, scalar|null>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $processedItemData + + array<string|int, mixed> + + - + + - +
+ $item + + Content + + - + + - +
+

Return values

+

array<string, scalar|null>

+ + +
+

+ publicsupports() + +

+
+ AbstractUserItemProcessor.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(array<string|int, mixed> $processedItemData, ValueObject $item) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $processedItemData + + array<string|int, mixed> + + - + + - +
+ $item + + ValueObject + + - + + - +
+

Return values

+

bool

+ + +
+

+ protecteddoProcess() + +

+
+ AbstractUserItemProcessor.php + : + 76 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected abstract doProcess(array<string, scalar|null> $processedItemData, Content $userContent) : array<string, scalar|null>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $processedItemData + + array<string, scalar|null> + + - + + - +
+ $userContent + + Content + + - + + - +
+

Return values

+

array<string, scalar|null>

+ + +
+

+ protectedgetUserField() + +

+
+ AbstractUserItemProcessor.php + : + 60 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected getUserField(Content $item) : Field|null
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $item + + Content + + - + + - +
+

Return values

+

Field|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-UsersDataExportContext.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-UsersDataExportContext.html new file mode 100644 index 0000000000..c7f0b91c2b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-UsersDataExportContext.html @@ -0,0 +1,496 @@ + + + + + UsersDataExportContext | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ UsersDataExportContext

+ +
+ UsersDataExportContext.php + : + 13 + +
+
Final
+ + +
+ Implements + DataExportContextInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ UsersDataExportContext.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, ContentType> $userContentTypes)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $userContentTypes + + array<string|int, ContentType> + + - + + - +
+ + +
+

+ publicgetUserContentTypes() + +

+
+ UsersDataExportContext.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserContentTypes() : array<string|int, ContentType>
+
+
+
+
+
+

Return values

+

array<string|int, ContentType>

+ + +
+

+ publicsetUserContentTypes() + +

+
+ UsersDataExportContext.php + : + 37 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setUserContentTypes(array<string|int, ContentType> $userContentTypes) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $userContentTypes + + array<string|int, ContentType> + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-UsersDatasetBuildParameters.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-UsersDatasetBuildParameters.html new file mode 100644 index 0000000000..82257988dd --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Export-User-UsersDatasetBuildParameters.html @@ -0,0 +1,583 @@ + + + + + UsersDatasetBuildParameters | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ UsersDatasetBuildParameters

+ +
+ UsersDatasetBuildParameters.php + : + 13 + +
+
Final
+ + +
+ Implements + BuildParametersInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ UsersDatasetBuildParameters.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, ContentType> $userContentTypes[, int|null $limit = null ][, int|null $offset = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $userContentTypes + + array<string|int, ContentType> + + - + + - +
+ $limit + + int|null + + null + + - +
+ $offset + + int|null + + null + + - +
+ + +
+

+ publicgetLimit() + +

+
+ UsersDatasetBuildParameters.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getLimit() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+

+ publicgetOffset() + +

+
+ UsersDatasetBuildParameters.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getOffset() : int|null
+
+
+
+
+
+

Return values

+

int|null

+ + +
+

+ publicgetUserContentTypeIdentifiers() + +

+
+ UsersDatasetBuildParameters.php + : + 43 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserContentTypeIdentifiers() : array<string|int, string>
+
+
+
+
+
+

Return values

+

array<string|int, string>

+ + +
+

+ publicgetUserContentTypes() + +

+
+ UsersDatasetBuildParameters.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserContentTypes() : array<string|int, ContentType>
+
+
+
+
+
+

Return values

+

array<string|int, ContentType>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-CreateType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-CreateType.html new file mode 100644 index 0000000000..e114d1d078 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-CreateType.html @@ -0,0 +1,489 @@ + + + + + CreateType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ CreateType

+ +
+ CreateType.php + : + 13 + +
+
Final
+ + +
+ Implements + ActionType
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ CreateType.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $audienceName, string $audienceId)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $audienceName + + string + + - + + - +
+ $audienceId + + string + + - + + - +
+ + +
+

+ publicgetAudienceId() + +

+
+ CreateType.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getAudienceId() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetAudienceName() + +

+
+ CreateType.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getAudienceName() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-DetachType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-DetachType.html new file mode 100644 index 0000000000..2b05cf172c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-DetachType.html @@ -0,0 +1,433 @@ + + + + + DetachType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DetachType

+ +
+ DetachType.php + : + 13 + +
+
Final
+ + +
+ Implements + ActionType
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ DetachType.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $audienceId)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $audienceId + + string + + - + + - +
+ + +
+

+ publicgetAudienceId() + +

+
+ DetachType.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getAudienceId() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-HeartbeatType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-HeartbeatType.html new file mode 100644 index 0000000000..2a53f0dbee --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-HeartbeatType.html @@ -0,0 +1,308 @@ + + + + + HeartbeatType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ HeartbeatType

+ +
+ HeartbeatType.php + : + 13 + +
+
Final
+ + +
+ Implements + ActionType
+ +
+ + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChange.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChange.html new file mode 100644 index 0000000000..59251fc942 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChange.html @@ -0,0 +1,598 @@ + + + + + MembershipChange | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ MembershipChange

+ +
+ MembershipChange.php + : + 13 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ MembershipChange.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $audienceId, string $personId, bool $membership[, PersonIdType|null $personIdType = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $audienceId + + string + + - + + - +
+ $personId + + string + + - + + - +
+ $membership + + bool + + - + + - +
+ $personIdType + + PersonIdType|null + + null + + - +
+ + +
+

+ publicgetAudienceId() + +

+
+ MembershipChange.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getAudienceId() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetPersonId() + +

+
+ MembershipChange.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPersonId() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetPersonIdType() + +

+
+ MembershipChange.php + : + 50 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPersonIdType() : PersonIdType
+
+
+
+
+
+

Return values

+

PersonIdType

+ + +
+

+ publicisMembership() + +

+
+ MembershipChange.php + : + 45 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isMembership() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChangesType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChangesType.html new file mode 100644 index 0000000000..2f1985b667 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChangesType.html @@ -0,0 +1,593 @@ + + + + + MembershipChangesType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ MembershipChangesType

+ +
+ MembershipChangesType.php + : + 13 + +
+
Final
+ + +
+ Implements + BulkActionTypeInterface
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ MembershipChangesType.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, MembershipChange> $changes)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $changes + + array<string|int, MembershipChange> + + - + + - +
+ + +
+

+ publiccreateSingleItemInstance() + +

+
+ MembershipChangesType.php + : + 47 + +
+
+

Creates a new ActionType instance containing only the specified item.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public createSingleItemInstance(mixed $item) : static
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $item + + mixed + + - + +
+

Single item from getItems()

+ +
+ +
+

Return values

+

static

+ + +
+

+ publicgetChanges() + +

+
+ MembershipChangesType.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getChanges() : array<string|int, MembershipChange>
+
+
+
+
+
+

Return values

+

array<string|int, MembershipChange>

+ + +
+

+ publicgetItemCount() + +

+
+ MembershipChangesType.php + : + 42 + +
+
+

Returns the count of items.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getItemCount() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetItems() + +

+
+ MembershipChangesType.php + : + 37 + +
+
+

Returns all items in the bulk collection.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getItems() : iterable<string|int, MembershipChange>
+
+
+
+
+
+

Return values

+

iterable<string|int, MembershipChange>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-Metadata.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-Metadata.html new file mode 100644 index 0000000000..1d9d110f44 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-Metadata.html @@ -0,0 +1,542 @@ + + + + + Metadata | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Metadata

+ +
+ Metadata.php + : + 11 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ Metadata.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $key, string $propertyName, string $value)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $key + + string + + - + + - +
+ $propertyName + + string + + - + + - +
+ $value + + string + + - + + - +
+ + +
+

+ publicgetKey() + +

+
+ Metadata.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getKey() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetPropertyName() + +

+
+ Metadata.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPropertyName() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ Metadata.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getValue() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MetadataType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MetadataType.html new file mode 100644 index 0000000000..188fedc356 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MetadataType.html @@ -0,0 +1,433 @@ + + + + + MetadataType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ MetadataType

+ +
+ MetadataType.php + : + 13 + +
+
Final
+ + +
+ Implements + ActionType
+ +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ MetadataType.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, Metadata> $changes)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $changes + + array<string|int, Metadata> + + - + + - +
+ + +
+

+ publicgetChanges() + +

+
+ MetadataType.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getChanges() : array<string|int, Metadata>
+
+
+
+
+
+

Return values

+

array<string|int, Metadata>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-ActionType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-ActionType.html new file mode 100644 index 0000000000..0f5cbfbcc8 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-ActionType.html @@ -0,0 +1,298 @@ + + + + + ActionType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ActionType

+ +
+ ActionType.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-BulkActionTypeInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-BulkActionTypeInterface.html new file mode 100644 index 0000000000..feb10e23de --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-BulkActionTypeInterface.html @@ -0,0 +1,477 @@ + + + + + BulkActionTypeInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BulkActionTypeInterface

+ +
+ BulkActionTypeInterface.php + : + 11 + +
+
Interface
+ +
+ Extends + ActionType
+
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publiccreateSingleItemInstance() + +

+
+ BulkActionTypeInterface.php + : + 32 + +
+
+

Creates a new ActionType instance containing only the specified item.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public createSingleItemInstance(mixed $item) : static
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $item + + mixed + + - + +
+

Single item from getItems()

+ +
+ +
+

Return values

+

static

+ + +
+

+ publicgetItemCount() + +

+
+ BulkActionTypeInterface.php + : + 23 + +
+
+

Returns the count of items.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getItemCount() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetItems() + +

+
+ BulkActionTypeInterface.php + : + 18 + +
+
+

Returns all items in the bulk collection.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getItems() : iterable<string|int, mixed>
+
+
+
+
+
+

Return values

+

iterable<string|int, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Message.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Message.html new file mode 100644 index 0000000000..58cb74487e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Message.html @@ -0,0 +1,538 @@ + + + + + Message | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Message

+ +
+ Message.php + : + 11 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ Message.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $updateType, string $segmentGroupIdentifier, ActionType $data)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $updateType + + string + + - + + - +
+ $segmentGroupIdentifier + + string + + - + + - +
+ $data + + ActionType + + - + + - +
+ + +
+

+ publicgetData() + +

+
+ Message.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getData() : ActionType
+
+
+
+
+
+

Return values

+

ActionType

+ + +
+

+ publicgetSegmentGroupIdentifier() + +

+
+ Message.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getSegmentGroupIdentifier() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetUpdateType() + +

+
+ Message.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUpdateType() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-PersonIdType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-PersonIdType.html new file mode 100644 index 0000000000..96dceb168c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-PersonIdType.html @@ -0,0 +1,475 @@ + + + + + PersonIdType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ PersonIdType

+ +
+ PersonIdType.php + : + 11 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + +

+ Constants +

+
+

+ publicDEFAULT +

+
+ PersonIdType.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed DEFAULT = 'user-id'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ PersonIdType.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $value)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + string + + - + + - +
+ + +
+

+ publicgetValue() + +

+
+ PersonIdType.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getValue() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Webhook-PersonIdResolverInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Webhook-PersonIdResolverInterface.html new file mode 100644 index 0000000000..b0c309c789 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Webhook-PersonIdResolverInterface.html @@ -0,0 +1,490 @@ + + + + + PersonIdResolverInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ PersonIdResolverInterface

+ +
+ PersonIdResolverInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetType() + +

+
+ PersonIdResolverInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getType() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicresolve() + +

+
+ PersonIdResolverInterface.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public resolve(string $personId) : User
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $personId + + string + + - + + - +
+

Return values

+

User

+ + +
+

+ publicsupports() + +

+
+ PersonIdResolverInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(PersonIdType $type) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $type + + PersonIdType + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/index.html b/docs/api/php_api/php_api_reference/index.html index 538380fd61..4587823f13 100644 --- a/docs/api/php_api/php_api_reference/index.html +++ b/docs/api/php_api/php_api_reference/index.html @@ -2981,6 +2981,754 @@
  • + +
    • + + +
  • + +