diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html index d6a89890b8..b6544daba0 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ InvalidConfigurationExceptionInterface

+ +
+ InvalidConfigurationExceptionInterface.php + : + 13 + +
+
Interface
+ +
+ Extends + Exception
+
+

Marker interface for all Repository related exceptions.

+ + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Configuration-ProviderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Configuration-ProviderInterface.html new file mode 100644 index 0000000000..849be2cca5 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Configuration-ProviderInterface.html @@ -0,0 +1,575 @@ + + + + + ProviderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProviderInterface

+ +
+ ProviderInterface.php + : + 16 + +
+
Interface
+ +
+

Provides contextualized (dynamic) tracking configuration. Use this service at runtime only.

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

+ Methods¶ +

+ +
+

+ publicgetCurrentCustomerId() + ¶ +

+
+ ProviderInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCurrentCustomerId() : string
+
+
+
+
+
+

Return values

+

string

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+

+ publicgetCurrentRecommendationsApiKey() + ¶ +

+
+ ProviderInterface.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCurrentRecommendationsApiKey() : string
+
+
+
+
+
+

Return values

+

string

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+

+ publicgetCurrentRecommendationsApiUri() + ¶ +

+
+ ProviderInterface.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCurrentRecommendationsApiUri() : string
+
+
+
+
+
+

Return values

+

string

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+

+ publicgetCurrentTrackingType() + ¶ +

+
+ ProviderInterface.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCurrentTrackingType() : Type
+
+
+
+
+
+

Return values

+

Type

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+

+ publicisEnabled() + ¶ +

+
+ ProviderInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isEnabled() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Content-Resolver-CurrentContentResolverInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Content-Resolver-CurrentContentResolverInterface.html new file mode 100644 index 0000000000..f169eaca10 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Content-Resolver-CurrentContentResolverInterface.html @@ -0,0 +1,354 @@ + + + + + CurrentContentResolverInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ CurrentContentResolverInterface

+ +
+ CurrentContentResolverInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicresolve() + ¶ +

+
+ CurrentContentResolverInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public resolve() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Exception-RaptorClientException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Exception-RaptorClientException.html new file mode 100644 index 0000000000..ee93bb1475 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Exception-RaptorClientException.html @@ -0,0 +1,305 @@ + + + + + RaptorClientException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Exception-RaptorClientExceptionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Exception-RaptorClientExceptionInterface.html new file mode 100644 index 0000000000..d0a10ec1ef --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Exception-RaptorClientExceptionInterface.html @@ -0,0 +1,299 @@ + + + + + RaptorClientExceptionInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RaptorClientExceptionInterface

+ +
+ RaptorClientExceptionInterface.php + : + 13 + +
+
Interface
+ +
+ Extends + Throwable
+
+ + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Model-RecommendationItem.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Model-RecommendationItem.html new file mode 100644 index 0000000000..ec6042fe8c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Model-RecommendationItem.html @@ -0,0 +1,546 @@ + + + + + RecommendationItem | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RecommendationItem

+ +
+ RecommendationItem.php + : + 14 + +
+
Read-only
+
Final
+ + + +
+

Represents a single recommendation item from Raptor API.

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

+ Properties¶ +

+ +
+

+ public + $attributes + + ¶ +

+
+ RecommendationItem.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public array<string|int, mixed> $attributes = []
+
+
+
+ + +
+

+ public + $itemId + + ¶ +

+
+ RecommendationItem.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $itemId
+
+
+
+ + +
+

+ public + $priority + + ¶ +

+
+ RecommendationItem.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public int $priority
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ RecommendationItem.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $itemId, int $priority[, array<string, mixed> $attributes = [] ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $itemId + + string + + - + + - +
+ $priority + + int + + - + + - +
+ $attributes + + array<string, mixed> + + [] + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Model-RecommendationsResponse.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Model-RecommendationsResponse.html new file mode 100644 index 0000000000..8dc8c0f239 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-RaptorClient-Model-RecommendationsResponse.html @@ -0,0 +1,492 @@ + + + + + RecommendationsResponse | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RecommendationsResponse

+ +
+ RecommendationsResponse.php + : + 14 + +
+
Read-only
+
Final
+ + + +
+

Represents response from Raptor recommendations API.

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

+ Properties¶ +

+ +
+

+ public + $items + + ¶ +

+
+ RecommendationsResponse.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public array<string|int, mixed> $items
+
+
+
+ + +
+

+ public + $totalCount + + ¶ +

+
+ RecommendationsResponse.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public int $totalCount
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ RecommendationsResponse.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, mixed> $items, int $totalCount)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $items + + array<string|int, mixed> + + - + + - +
+ $totalCount + + int + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-RecommendationsServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-RecommendationsServiceInterface.html new file mode 100644 index 0000000000..6a0add204a --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-RecommendationsServiceInterface.html @@ -0,0 +1,2722 @@ + + + + + RecommendationsServiceInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RecommendationsServiceInterface

+ +
+ RecommendationsServiceInterface.php + : + 18 + +
+
Interface
+ +
+

Service for fetching product and content recommendations from Raptor.

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

+ Methods¶ +

+ +
+

+ publicgetContentBasedOnItemWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 60 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getContentBasedOnItemWeb(string $productCode[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetContentBasedOnProductCategoryWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 71 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getContentBasedOnProductCategoryWeb(string $categoryId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $categoryId + + string + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetContentCatalogueRank() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 248 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getContentCatalogueRank([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetItemsBasedOnContentWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 93 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getItemsBasedOnContentWeb(string $contentId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $contentId + + string + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetMerchandisingContentWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 216 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getMerchandisingContentWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetMerchandisingItemsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 206 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getMerchandisingItemsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetNumOfUsersRightNowWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 196 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getNumOfUsersRightNowWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPIMRelatedItemsForBasketWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 237 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPIMRelatedItemsForBasketWeb(string $productCodes[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCodes + + string + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPIMRelatedItemsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 226 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPIMRelatedItemsWeb(string $productCode[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPopularBrandsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 166 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPopularBrandsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPopularCategoriesWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 176 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPopularCategoriesWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPopularContentWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 186 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPopularContentWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPopularItemsInCategoryWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 37 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPopularItemsInCategoryWeb(string $categoryId, bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $categoryId + + string + + - + + - +
+ $inStockOnly + + bool + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetPopularItemsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 114 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPopularItemsWeb(bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $inStockOnly + + bool + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetProductCatalogueRank() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 258 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getProductCatalogueRank([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetSimilarContentWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 82 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getSimilarContentWeb(string $contentId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $contentId + + string + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetSimilarItemsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getSimilarItemsWeb(string $productCode, bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ $inStockOnly + + bool + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetUserContentHistoryWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 156 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserContentHistoryWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetUserContentRecommendationsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 104 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserContentRecommendationsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ContentRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetUserCrossSellingItemsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 136 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserCrossSellingItemsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetUserItemHistoryWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 49 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserItemHistoryWeb([bool $inStockOnly = false ][, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $inStockOnly + + bool + + false + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetUserItemRecommendationsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 125 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserItemRecommendationsWeb(bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $inStockOnly + + bool + + - + + - +
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+

+ publicgetUserLookAlikeItemsWeb() + ¶ +

+
+ RecommendationsServiceInterface.php + : + 146 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserLookAlikeItemsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $numOfItems + + int + + 10 + + - +
+ $options + + array<string, mixed> + + [] + + - +
+

Return values

+

ProductRecommendations

+ +
+ Tags + + +
+
+
+ Throws +
+
+ RaptorClientExceptionInterface + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-Value-ContentRecommendations.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-Value-ContentRecommendations.html new file mode 100644 index 0000000000..f8d2719c80 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-Value-ContentRecommendations.html @@ -0,0 +1,579 @@ + + + + + ContentRecommendations | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ContentRecommendations

+ +
+ ContentRecommendations.php + : + 21 + +
+
Read-only
+
Final
+ + +
+ Implements + IteratorAggregate, Countable
+ +
+

Collection of recommended content items from Raptor.

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

+ Properties¶ +

+ +
+

+ public + $contentItems + + ¶ +

+
+ ContentRecommendations.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public array<string|int, mixed> $contentItems
+
+
+
+ + +
+

+ public + $totalCount + + ¶ +

+
+ ContentRecommendations.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public int $totalCount
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ ContentRecommendations.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, mixed> $contentItems, int $totalCount)
+
+
+
+
+
+

Parameters

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

+ publiccount() + ¶ +

+
+ ContentRecommendations.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public count() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetIterator() + ¶ +

+
+ ContentRecommendations.php + : + 31 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getIterator() : Traversable
+
+
+
+
+
+

Return values

+

Traversable

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-Value-ProductRecommendations.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-Value-ProductRecommendations.html new file mode 100644 index 0000000000..7262bbed21 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Recommendations-Value-ProductRecommendations.html @@ -0,0 +1,579 @@ + + + + + ProductRecommendations | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductRecommendations

+ +
+ ProductRecommendations.php + : + 21 + +
+
Read-only
+
Final
+ + +
+ Implements + IteratorAggregate, Countable
+ +
+

Collection of recommended products from Raptor.

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

+ Properties¶ +

+ +
+

+ public + $productItems + + ¶ +

+
+ ProductRecommendations.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public array<string|int, mixed> $productItems
+
+
+
+ + +
+

+ public + $totalCount + + ¶ +

+
+ ProductRecommendations.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public int $totalCount
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ ProductRecommendations.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<string|int, mixed> $productItems, int $totalCount)
+
+
+
+
+
+

Parameters

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

+ publiccount() + ¶ +

+
+ ProductRecommendations.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public count() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetIterator() + ¶ +

+
+ ProductRecommendations.php + : + 31 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getIterator() : Traversable
+
+
+
+
+
+

Return values

+

Traversable

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-AbstractEventData.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-AbstractEventData.html new file mode 100644 index 0000000000..d42432c015 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-AbstractEventData.html @@ -0,0 +1,446 @@ + + + + + AbstractEventData | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AbstractEventData

+ +
+ AbstractEventData.php + : + 16 + +
+
Read-only
+
Abstract
+ + +
+ Implements + EventDataInterface
+ +
+

Base class for tracking event data with common parameter building logic.

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

+ Methods¶ +

+ +
+

+ publicgetTemplateHint() + ¶ +

+
+ AbstractEventData.php + : + 44 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ protectedbuildParameters() + ¶ +

+
+ AbstractEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected buildParameters(array<string, mixed> $required[, array<string, mixed> $optional = [] ]) : array<string, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $required + + array<string, mixed> + + - + + - +
+ $optional + + array<string, mixed> + + [] + + - +
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-BasketEventData.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-BasketEventData.html new file mode 100644 index 0000000000..1f92db2baa --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-BasketEventData.html @@ -0,0 +1,1084 @@ + + + + + BasketEventData | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BasketEventData

+ +
+ BasketEventData.php + : + 14 + +
+
Read-only
+
Final
+ +
+ Extends AbstractEventData +
+ + +
+

Base class for tracking event data with common parameter building logic.

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

+ Properties¶ +

+ +
+

+ public + $basketContent + + ¶ +

+
+ BasketEventData.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $basketContent
+
+
+
+ + +
+

+ public + $basketId + + ¶ +

+
+ BasketEventData.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $basketId
+
+
+
+ + +
+

+ public + $categoryPath + + ¶ +

+
+ BasketEventData.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $categoryPath = null
+
+
+
+ + +
+

+ public + $itemPrice + + ¶ +

+
+ BasketEventData.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $itemPrice = null
+
+
+
+ + +
+

+ public + $masterId + + ¶ +

+
+ BasketEventData.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $masterId = null
+
+
+
+ + +
+

+ public + $productCode + + ¶ +

+
+ BasketEventData.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $productCode = null
+
+
+
+ + +
+

+ public + $productName + + ¶ +

+
+ BasketEventData.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $productName = null
+
+
+
+ + +
+

+ public + $quantity + + ¶ +

+
+ BasketEventData.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public int|null $quantity = null
+
+
+
+ + +
+

+ public + $websiteId + + ¶ +

+
+ BasketEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $websiteId = null
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ BasketEventData.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $basketContent, string $basketId[, string|null $productCode = null ][, string|null $productName = null ][, string|null $categoryPath = null ][, string|null $itemPrice = null ][, int|null $quantity = null ][, string|null $websiteId = null ][, string|null $masterId = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $basketContent + + string + + - + + - +
+ $basketId + + string + + - + + - +
+ $productCode + + string|null + + null + + - +
+ $productName + + string|null + + null + + - +
+ $categoryPath + + string|null + + null + + - +
+ $itemPrice + + string|null + + null + + - +
+ $quantity + + int|null + + null + + - +
+ $websiteId + + string|null + + null + + - +
+ $masterId + + string|null + + null + + - +
+ + +
+

+ publicgetEventType() + ¶ +

+
+ BasketEventData.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getEventType() : EventType
+
+
+
+
+
+

Return values

+

EventType

+ + +
+

+ publicgetTemplateHint() + ¶ +

+
+ AbstractEventData.php + : + 44 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publictoArray() + ¶ +

+
+ BasketEventData.php + : + 33 + +
+
+

Returns Raptor tracking parameters.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public toArray() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+

+ protectedbuildParameters() + ¶ +

+
+ AbstractEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected buildParameters(array<string, mixed> $required[, array<string, mixed> $optional = [] ]) : array<string, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $required + + array<string, mixed> + + - + + - +
+ $optional + + array<string, mixed> + + [] + + - +
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-BuyEventData.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-BuyEventData.html new file mode 100644 index 0000000000..709dfef8cf --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-BuyEventData.html @@ -0,0 +1,1084 @@ + + + + + BuyEventData | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BuyEventData

+ +
+ BuyEventData.php + : + 14 + +
+
Read-only
+
Final
+ +
+ Extends AbstractEventData +
+ + +
+

Base class for tracking event data with common parameter building logic.

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

+ Properties¶ +

+ +
+

+ public + $categoryPath + + ¶ +

+
+ BuyEventData.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $categoryPath = null
+
+
+
+ + +
+

+ public + $currency + + ¶ +

+
+ BuyEventData.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $currency
+
+
+
+ + +
+

+ public + $itemPrice + + ¶ +

+
+ BuyEventData.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $itemPrice
+
+
+
+ + +
+

+ public + $masterId + + ¶ +

+
+ BuyEventData.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $masterId = null
+
+
+
+ + +
+

+ public + $productCode + + ¶ +

+
+ BuyEventData.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $productCode
+
+
+
+ + +
+

+ public + $productName + + ¶ +

+
+ BuyEventData.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $productName
+
+
+
+ + +
+

+ public + $quantity + + ¶ +

+
+ BuyEventData.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public int $quantity
+
+
+
+ + +
+

+ public + $subtotal + + ¶ +

+
+ BuyEventData.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $subtotal
+
+
+
+ + +
+

+ public + $websiteId + + ¶ +

+
+ BuyEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $websiteId = null
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ BuyEventData.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $productCode, string $productName, string $subtotal, string $currency, string $itemPrice, int $quantity[, string|null $categoryPath = null ][, string|null $websiteId = null ][, string|null $masterId = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ $productName + + string + + - + + - +
+ $subtotal + + string + + - + + - +
+ $currency + + string + + - + + - +
+ $itemPrice + + string + + - + + - +
+ $quantity + + int + + - + + - +
+ $categoryPath + + string|null + + null + + - +
+ $websiteId + + string|null + + null + + - +
+ $masterId + + string|null + + null + + - +
+ + +
+

+ publicgetEventType() + ¶ +

+
+ BuyEventData.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getEventType() : EventType
+
+
+
+
+
+

Return values

+

EventType

+ + +
+

+ publicgetTemplateHint() + ¶ +

+
+ AbstractEventData.php + : + 44 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publictoArray() + ¶ +

+
+ BuyEventData.php + : + 33 + +
+
+

Returns Raptor tracking parameters.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public toArray() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+

+ protectedbuildParameters() + ¶ +

+
+ AbstractEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected buildParameters(array<string, mixed> $required[, array<string, mixed> $optional = [] ]) : array<string, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $required + + array<string, mixed> + + - + + - +
+ $optional + + array<string, mixed> + + [] + + - +
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-ContentVisitEventData.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-ContentVisitEventData.html new file mode 100644 index 0000000000..e64da18ac3 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-ContentVisitEventData.html @@ -0,0 +1,706 @@ + + + + + ContentVisitEventData | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ContentVisitEventData

+ +
+ ContentVisitEventData.php + : + 14 + +
+
Read-only
+
Final
+ +
+ Extends AbstractEventData +
+ + +
+

Base class for tracking event data with common parameter building logic.

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

+ Properties¶ +

+ +
+

+ public + $contentId + + ¶ +

+
+ ContentVisitEventData.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $contentId
+
+
+
+ + +
+

+ public + $websiteId + + ¶ +

+
+ ContentVisitEventData.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $websiteId = null
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ ContentVisitEventData.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $contentId[, string|null $websiteId = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $contentId + + string + + - + + - +
+ $websiteId + + string|null + + null + + - +
+ + +
+

+ publicgetEventType() + ¶ +

+
+ ContentVisitEventData.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getEventType() : EventType
+
+
+
+
+
+

Return values

+

EventType

+ + +
+

+ publicgetTemplateHint() + ¶ +

+
+ AbstractEventData.php + : + 44 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publictoArray() + ¶ +

+
+ ContentVisitEventData.php + : + 26 + +
+
+

Returns Raptor tracking parameters.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public toArray() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+

+ protectedbuildParameters() + ¶ +

+
+ AbstractEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected buildParameters(array<string, mixed> $required[, array<string, mixed> $optional = [] ]) : array<string, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $required + + array<string, mixed> + + - + + - +
+ $optional + + array<string, mixed> + + [] + + - +
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-EventDataInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-EventDataInterface.html new file mode 100644 index 0000000000..4557eb6f90 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-EventDataInterface.html @@ -0,0 +1,441 @@ + + + + + EventDataInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EventDataInterface

+ +
+ EventDataInterface.php + : + 16 + +
+
Interface
+ +
+

Base interface for tracking event data.

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

+ Methods¶ +

+ +
+

+ publicgetEventType() + ¶ +

+
+ EventDataInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getEventType() : EventType
+
+
+
+
+
+

Return values

+

EventType

+ + +
+

+ publicgetTemplateHint() + ¶ +

+
+ EventDataInterface.php + : + 30 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publictoArray() + ¶ +

+
+ EventDataInterface.php + : + 25 + +
+
+

Returns Raptor tracking parameters.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public toArray() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-ItemClickEventData.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-ItemClickEventData.html new file mode 100644 index 0000000000..e6c29406bb --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-ItemClickEventData.html @@ -0,0 +1,760 @@ + + + + + ItemClickEventData | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ItemClickEventData

+ +
+ ItemClickEventData.php + : + 15 + +
+
Read-only
+
Final
+ +
+ Extends AbstractEventData +
+ + +
+

Base class for tracking event data with common parameter building logic.

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

+ Properties¶ +

+ +
+

+ public + $moduleName + + ¶ +

+
+ ItemClickEventData.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $moduleName
+
+
+
+ + +
+

+ public + $productCode + + ¶ +

+
+ ItemClickEventData.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $productCode
+
+
+
+ + +
+

+ public + $redirectUrl + + ¶ +

+
+ ItemClickEventData.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $redirectUrl
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ ItemClickEventData.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $productCode, string $moduleName, string $redirectUrl)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ $moduleName + + string + + - + + - +
+ $redirectUrl + + string + + - + + - +
+ + +
+

+ publicgetEventType() + ¶ +

+
+ ItemClickEventData.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getEventType() : EventType
+
+
+
+
+
+

Return values

+

EventType

+ + +
+

+ publicgetTemplateHint() + ¶ +

+
+ ItemClickEventData.php + : + 41 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publictoArray() + ¶ +

+
+ ItemClickEventData.php + : + 28 + +
+
+

Returns Raptor tracking parameters.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public toArray() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+

+ protectedbuildParameters() + ¶ +

+
+ AbstractEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected buildParameters(array<string, mixed> $required[, array<string, mixed> $optional = [] ]) : array<string, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $required + + array<string, mixed> + + - + + - +
+ $optional + + array<string, mixed> + + [] + + - +
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-VisitEventData.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-VisitEventData.html new file mode 100644 index 0000000000..21fa862494 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Event-VisitEventData.html @@ -0,0 +1,976 @@ + + + + + VisitEventData | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ VisitEventData

+ +
+ VisitEventData.php + : + 14 + +
+
Read-only
+
Final
+ +
+ Extends AbstractEventData +
+ + +
+

Base class for tracking event data with common parameter building logic.

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

+ Properties¶ +

+ +
+

+ public + $categoryPath + + ¶ +

+
+ VisitEventData.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $categoryPath
+
+
+
+ + +
+

+ public + $currency + + ¶ +

+
+ VisitEventData.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $currency = null
+
+
+
+ + +
+

+ public + $itemPrice + + ¶ +

+
+ VisitEventData.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $itemPrice = null
+
+
+
+ + +
+

+ public + $masterId + + ¶ +

+
+ VisitEventData.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $masterId = null
+
+
+
+ + +
+

+ public + $productCode + + ¶ +

+
+ VisitEventData.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $productCode
+
+
+
+ + +
+

+ public + $productName + + ¶ +

+
+ VisitEventData.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $productName
+
+
+
+ + +
+

+ public + $websiteId + + ¶ +

+
+ VisitEventData.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $websiteId = null
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ VisitEventData.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $productCode, string $productName, string $categoryPath[, string|null $websiteId = null ][, string|null $currency = null ][, string|null $itemPrice = null ][, string|null $masterId = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ $productName + + string + + - + + - +
+ $categoryPath + + string + + - + + - +
+ $websiteId + + string|null + + null + + - +
+ $currency + + string|null + + null + + - +
+ $itemPrice + + string|null + + null + + - +
+ $masterId + + string|null + + null + + - +
+ + +
+

+ publicgetEventType() + ¶ +

+
+ VisitEventData.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getEventType() : EventType
+
+
+
+
+
+

Return values

+

EventType

+ + +
+

+ publicgetTemplateHint() + ¶ +

+
+ AbstractEventData.php + : + 44 + +
+
+

Returns optional template hint for special rendering needs.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplateHint() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publictoArray() + ¶ +

+
+ VisitEventData.php + : + 31 + +
+
+

Returns Raptor tracking parameters.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public toArray() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+

+ protectedbuildParameters() + ¶ +

+
+ AbstractEventData.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
protected buildParameters(array<string, mixed> $required[, array<string, mixed> $optional = [] ]) : array<string, mixed>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $required + + array<string, mixed> + + - + + - +
+ $optional + + array<string, mixed> + + [] + + - +
+

Return values

+

array<string, mixed>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventContext.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventContext.html new file mode 100644 index 0000000000..b3858c4e7f --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventContext.html @@ -0,0 +1,645 @@ + + + + + EventContext | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EventContext

+ +
+ EventContext.php + : + 14 + +
+
Read-only
+
Final
+ + + +
+

Context keys for tracking events.

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

+ Constants¶ +

+
+

+ publicBASKET_CONTENT ¶ +

+
+ EventContext.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed BASKET_CONTENT = 'basketContent'
+
+
+
+ + +
+

+ publicBASKET_ID ¶ +

+
+ EventContext.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed BASKET_ID = 'basketId'
+
+
+
+ + +
+

+ publicCATEGORY_IDENTIFIER ¶ +

+
+ EventContext.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed CATEGORY_IDENTIFIER = 'categoryIdentifier'
+
+
+
+ + +
+

+ publicCURRENCY ¶ +

+
+ EventContext.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed CURRENCY = 'currency'
+
+
+
+ + +
+

+ publicMODULE_NAME ¶ +

+
+ EventContext.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed MODULE_NAME = 'moduleName'
+
+
+
+ + +
+

+ publicQUANTITY ¶ +

+
+ EventContext.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed QUANTITY = 'quantity'
+
+
+
+ + +
+

+ publicREDIRECT_URL ¶ +

+
+ EventContext.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed REDIRECT_URL = 'redirectUrl'
+
+
+
+ + +
+

+ publicSUBTOTAL ¶ +

+
+ EventContext.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed SUBTOTAL = 'subtotal'
+
+
+
+ + +
+

+ publicWEBSITE_ID ¶ +

+
+ EventContext.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed WEBSITE_ID = 'websiteId'
+
+
+
+ + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventMapperInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventMapperInterface.html new file mode 100644 index 0000000000..9d7f16df04 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventMapperInterface.html @@ -0,0 +1,420 @@ + + + + + EventMapperInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EventMapperInterface

+ +
+ EventMapperInterface.php + : + 17 + +
+
Interface
+ +
+

Maps domain objects to tracking event data using registered strategies.

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

+ Methods¶ +

+ +
+

+ publicmap() + ¶ +

+
+ EventMapperInterface.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public map(EventType $eventType, mixed $data[, array<string, mixed> $context = [] ]) : EventDataInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $eventType + + EventType + + - + + - +
+ $data + + mixed + + - + + - +
+ $context + + array<string, mixed> + + [] + + - +
+

Return values

+

EventDataInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventMappingStrategyInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventMappingStrategyInterface.html new file mode 100644 index 0000000000..4881a47ae5 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventMappingStrategyInterface.html @@ -0,0 +1,517 @@ + + + + + EventMappingStrategyInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EventMappingStrategyInterface

+ +
+ EventMappingStrategyInterface.php + : + 16 + +
+
Interface
+ +
+

Strategy interface for mapping domain objects to tracking events.

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

+ Methods¶ +

+ +
+

+ publicgetPriority() + ¶ +

+
+ EventMappingStrategyInterface.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPriority() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicmap() + ¶ +

+
+ EventMappingStrategyInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public map(EventType $eventType, mixed $data[, array<string, mixed> $context = [] ]) : EventDataInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $eventType + + EventType + + - + + - +
+ $data + + mixed + + - + + - +
+ $context + + array<string, mixed> + + [] + + - +
+

Return values

+

EventDataInterface

+ + +
+

+ publicsupports() + ¶ +

+
+ EventMappingStrategyInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public supports(EventType $eventType) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $eventType + + EventType + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventRendererInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventRendererInterface.html new file mode 100644 index 0000000000..ba4302e6b5 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventRendererInterface.html @@ -0,0 +1,477 @@ + + + + + EventRendererInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EventRendererInterface

+ +
+ EventRendererInterface.php + : + 16 + +
+
Interface
+ +
+

Renders JavaScript snippets for tracking events.

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

+ Methods¶ +

+ +
+

+ publicrenderEvent() + ¶ +

+
+ EventRendererInterface.php + : + 21 + +
+
+

Render JavaScript snippet for tracking event from EventDataInterface.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public renderEvent(EventDataInterface $eventData[, string|null $template = null ]) : string
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $eventData + + EventDataInterface + + - + + - +
+ $template + + string|null + + null + + - +
+

Return values

+

string

+ + +
+

+ publicrenderEventScript() + ¶ +

+
+ EventRendererInterface.php + : + 31 + +
+
+

Render JavaScript snippet for tracking event.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public renderEventScript(array<string, mixed> $parameters[, string|null $template = null ]) : string
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $parameters + + array<string, mixed> + + - + + - +
+ $template + + string|null + + null + + - +
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventType.html new file mode 100644 index 0000000000..333665d154 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-EventType.html @@ -0,0 +1,508 @@ + + + + + EventType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EventType +

+ +
+ EventType.php + : + 14 + +
+
+ Enum: string +
+
+

Defines supported Raptor tracking event types.

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

+ Cases + + +

+
+
+

+ VISIT ¶ +

+
+ EventType.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string VISIT = 'visit'
+
+
+
+ + +
+
+
+

+ CONTENT_VISIT ¶ +

+
+ EventType.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string CONTENT_VISIT = 'contentvisit'
+
+
+
+ + +
+
+
+

+ BUY ¶ +

+
+ EventType.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string BUY = 'buy'
+
+
+
+ + +
+
+
+

+ BASKET ¶ +

+
+ EventType.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string BASKET = 'basket'
+
+
+
+ + +
+
+
+

+ ITEM_CLICK ¶ +

+
+ EventType.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string ITEM_CLICK = 'itemclick'
+
+
+
+ + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-RaptorParameter.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-RaptorParameter.html new file mode 100644 index 0000000000..3a29ffebd7 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-RaptorParameter.html @@ -0,0 +1,830 @@ + + + + + RaptorParameter | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RaptorParameter

+ +
+ RaptorParameter.php + : + 14 + +
+
Read-only
+
Final
+ + + +
+

Raptor tracking parameter names.

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

+ Constants¶ +

+
+

+ publicBASKET_CONTENT ¶ +

+
+ RaptorParameter.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed BASKET_CONTENT = 'p10'
+
+
+
+ + +
+

+ publicBASKET_ID ¶ +

+
+ RaptorParameter.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed BASKET_ID = 'p11'
+
+
+
+ + +
+

+ publicCATEGORY_PATH ¶ +

+
+ RaptorParameter.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed CATEGORY_PATH = 'p4'
+
+
+
+ + +
+

+ publicCONTENT_ID ¶ +

+
+ RaptorParameter.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed CONTENT_ID = 'p9'
+
+
+
+ + +
+

+ publicCURRENCY ¶ +

+
+ RaptorParameter.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed CURRENCY = 'p6'
+
+
+
+ + +
+

+ publicEVENT_TYPE ¶ +

+
+ RaptorParameter.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed EVENT_TYPE = 'p1'
+
+
+
+ + +
+

+ publicITEM_PRICE ¶ +

+
+ RaptorParameter.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed ITEM_PRICE = 'p12'
+
+
+
+ + +
+

+ publicMASTER_PRODUCT_ID ¶ +

+
+ RaptorParameter.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed MASTER_PRODUCT_ID = 'p18'
+
+
+
+ + +
+

+ publicMETADATA ¶ +

+
+ RaptorParameter.php + : + 42 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed METADATA = '_metadata'
+
+
+
+ + +
+

+ publicPRODUCT_ID ¶ +

+
+ RaptorParameter.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed PRODUCT_ID = 'p2'
+
+
+
+ + +
+

+ publicPRODUCT_NAME ¶ +

+
+ RaptorParameter.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed PRODUCT_NAME = 'p3'
+
+
+
+ + +
+

+ publicQUANTITY ¶ +

+
+ RaptorParameter.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed QUANTITY = 'p13'
+
+
+
+ + +
+

+ publicSUBTOTAL ¶ +

+
+ RaptorParameter.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed SUBTOTAL = 'p5'
+
+
+
+ + +
+

+ publicWEBSITE_ID ¶ +

+
+ RaptorParameter.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed WEBSITE_ID = 'p7'
+
+
+
+ + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-ServerSideTrackingDispatcherInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-ServerSideTrackingDispatcherInterface.html new file mode 100644 index 0000000000..3e6efd311c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-ServerSideTrackingDispatcherInterface.html @@ -0,0 +1,379 @@ + + + + + ServerSideTrackingDispatcherInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ServerSideTrackingDispatcherInterface

+ +
+ ServerSideTrackingDispatcherInterface.php + : + 16 + +
+
Interface
+ +
+

Dispatches server-side tracking events asynchronously via message queue.

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

+ Methods¶ +

+ +
+

+ publicdispatch() + ¶ +

+
+ ServerSideTrackingDispatcherInterface.php + : + 21 + +
+
+

Dispatches tracking event for asynchronous processing.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public dispatch(EventDataInterface $eventData) : string
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $eventData + + EventDataInterface + + - + + - +
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingClockInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingClockInterface.html new file mode 100644 index 0000000000..f40bb8c43d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingClockInterface.html @@ -0,0 +1,434 @@ + + + + + TrackingClockInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TrackingClockInterface

+ +
+ TrackingClockInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicaddDays() + ¶ +

+
+ TrackingClockInterface.php + : + 23 + +
+
+

Add days (supports fractional days like 0.015 for ~21.6 minutes).

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public addDays(float $days) : DateTimeImmutable
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $days + + float + + - + + - +
+

Return values

+

DateTimeImmutable

+ +
+ Tags + + +
+
+
+ Throws +
+
+ DateMalformedIntervalStringException + +
+
+ +
+

+ publicnow() + ¶ +

+
+ TrackingClockInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public now() : DateTimeImmutable
+
+
+
+
+
+

Return values

+

DateTimeImmutable

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingIdentifierProviderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingIdentifierProviderInterface.html new file mode 100644 index 0000000000..d4ccb271b8 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingIdentifierProviderInterface.html @@ -0,0 +1,437 @@ + + + + + TrackingIdentifierProviderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TrackingIdentifierProviderInterface

+ +
+ TrackingIdentifierProviderInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicgetCookieId() + ¶ +

+
+ TrackingIdentifierProviderInterface.php + : + 16 + +
+
+

Get or create cookie identifier (coid).

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getCookieId() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetSessionId() + ¶ +

+
+ TrackingIdentifierProviderInterface.php + : + 21 + +
+
+

Get or create session identifier (sid).

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getSessionId() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetUserId() + ¶ +

+
+ TrackingIdentifierProviderInterface.php + : + 26 + +
+
+

Get user identifier (ruid) for tracking logged-in users.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserId() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingServiceInterface.html new file mode 100644 index 0000000000..04d6ebd39b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-TrackingServiceInterface.html @@ -0,0 +1,531 @@ + + + + + TrackingServiceInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TrackingServiceInterface

+ +
+ TrackingServiceInterface.php + : + 17 + +
+
Interface
+ +
+

Server-side tracking service for Raptor.

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

+ Methods¶ +

+ +
+

+ publicisServerTrackingEnabled() + ¶ +

+
+ TrackingServiceInterface.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isServerTrackingEnabled() : bool
+
+
+
+
+
+

Return values

+

bool

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+

+ publicisTrackingEnabled() + ¶ +

+
+ TrackingServiceInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isTrackingEnabled() : bool
+
+
+
+
+
+

Return values

+

bool

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+

+ publictrack() + ¶ +

+
+ TrackingServiceInterface.php + : + 34 + +
+
+

Track any event type using generic EventDataInterface.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public track(EventDataInterface $eventData, string $url[, string|null $moduleName = null ]) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $eventData + + EventDataInterface + + - + + - +
+ $url + + string + + - + + - +
+ $moduleName + + string|null + + null + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidConfigurationExceptionInterface + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Type.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Type.html new file mode 100644 index 0000000000..a7d8c9a6eb --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorRaptor-Tracking-Type.html @@ -0,0 +1,390 @@ + + + + + Type | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Type +

+ +
+ Type.php + : + 11 + +
+
+ Enum: string +
+
+ + + + + + + + + + + +
+

+ Cases + + +

+
+
+

+ CLIENT ¶ +

+
+ Type.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string CLIENT = 'client'
+
+
+
+ + +
+
+
+

+ SERVER ¶ +

+
+ Type.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
string SERVER = 'server'
+
+
+
+ + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ContentForms-Content-Form-Provider-GroupedContentFormFieldsProviderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ContentForms-Content-Form-Provider-GroupedContentFormFieldsProviderInterface.html index c2489d3c80..0f451c97e7 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ContentForms-Content-Form-Provider-GroupedContentFormFieldsProviderInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ContentForms-Content-Form-Provider-GroupedContentFormFieldsProviderInterface.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+

+ ReferenceAwareExternalStorage

+ +
+ ReferenceAwareExternalStorage.php + : + 18 + +
+
Interface
+ +
+

Interface for external storages that support creating lightweight references +to another version's data instead of copying it.

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

+ Constants¶ +

+
+

+ publicREFERENCE_LANGUAGE_CODE ¶ +

+
+ ReferenceAwareExternalStorage.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public mixed REFERENCE_LANGUAGE_CODE = 'reference-language-code'
+
+
+
+ + + +

+ Methods¶ +

+ +
+

+ publicreferenceLegacyField() + ¶ +

+
+ ReferenceAwareExternalStorage.php + : + 30 + +
+
+

Creates a reference to the original field's external data instead of copying it.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public referenceLegacyField(VersionInfo $versionInfo, Field $field, Field $originalField) : bool|null
+
+
+
+
+
+
+

Called for fields in languages not being edited during draft creation. +The implementation should store a lightweight pointer to $originalField's +external data (identified by $originalField->versionNo) and resolve it +in FieldStorage::getFieldData().

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $versionInfo + + VersionInfo + + - + + - +
+ $field + + Field + + - + + - +
+ $originalField + + Field + + - + + - +
+

Return values

+

bool|null

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-StorageGateway.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-StorageGateway.html index 9fe8e6a1c3..b3f175d819 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-StorageGateway.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-StorageGateway.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+

+ Context

+ +
+ Context.php + : + 16 + +
+
Final
+ + +
+ Implements + OptionsBag, ArrayAccess
+ +
+ + + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ Context.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct([array<string, mixed> $data = [] ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $data + + array<string, mixed> + + [] + + - +
+ + +
+

+ publicall() + ¶ +

+
+ Context.php + : + 32 + +
+
+

Returns all options as an associative array.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public all() : array<string, mixed>
+
+
+
+
+
+

Return values

+

array<string, mixed>

+ + +
+

+ publicget() + ¶ +

+
+ Context.php + : + 37 + +
+
+

Returns the value of the option identified by $key.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public get(string $key[, mixed $default = null ]) : mixed
+
+
+
+
+
+
+

If the option does not exist, returns $default.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $key + + string + + - + + - +
+ $default + + mixed + + null + + - +
+ + +
+

+ publichas() + ¶ +

+
+ Context.php + : + 46 + +
+
+

Checks if the option identified by $key exists.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public has(string $key) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $key + + string + + - + + - +
+

Return values

+

bool

+ + +
+

+ publicoffsetExists() + ¶ +

+
+ Context.php + : + 51 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public offsetExists(mixed $offset) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $offset + + mixed + + - + + - +
+

Return values

+

bool

+ + +
+

+ publicoffsetGet() + ¶ +

+
+ Context.php + : + 56 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public offsetGet(mixed $offset) : mixed
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $offset + + mixed + + - + + - +
+ + +
+

+ publicoffsetSet() + ¶ +

+
+ Context.php + : + 61 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public offsetSet(mixed $offset, mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $offset + + mixed + + - + + - +
+ $value + + mixed + + - + + - +
+ + +
+

+ publicoffsetUnset() + ¶ +

+
+ Context.php + : + 66 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public offsetUnset(mixed $offset) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $offset + + mixed + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Options-MutableOptionsBag.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Options-MutableOptionsBag.html index a4d83e76a2..05bbc22f68 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Options-MutableOptionsBag.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Options-MutableOptionsBag.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+
+

+ OrderStatusLabelProviderInterface

+ +
+ OrderStatusLabelProviderInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicgetOrderStatusLabel() + ¶ +

+
+ OrderStatusLabelProviderInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getOrderStatusLabel(string $status) : string
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $status + + string + + - + + - +
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Permission-MemberResolver.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Permission-MemberResolver.html index fb74b5f140..39c3add5d3 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Permission-MemberResolver.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Permission-MemberResolver.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BlockBuilderInterface

+ +
+ BlockBuilderInterface.php + : + 13 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicbuild() + ¶ +

+
+ BlockBuilderInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public build(array<string, mixed> $blockConfig) : ProductTourBlockInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $blockConfig + + array<string, mixed> + + - + + - +
+

Return values

+

ProductTourBlockInterface

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-Event-RenderProductTourScenarioEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-Event-RenderProductTourScenarioEvent.html new file mode 100644 index 0000000000..06a9db4d24 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-Event-RenderProductTourScenarioEvent.html @@ -0,0 +1,587 @@ + + + + + RenderProductTourScenarioEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RenderProductTourScenarioEvent

+ +
+ RenderProductTourScenarioEvent.php + : + 14 + +
+
Final
+ +
+ Extends Event +
+ + +
+

Event is the base class for classes containing event data.

+ + +
+

This class contains no event data. It is used by events that do not pass +state information to an event handler when an event is raised.

+

You can call the method stopPropagation() to abort the execution of +further listeners in your event listener.

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

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ RenderProductTourScenarioEvent.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(ProductTourScenarioInterface $scenario)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $scenario + + ProductTourScenarioInterface + + - + + - +
+ + +
+

+ publicgetScenario() + ¶ +

+
+ RenderProductTourScenarioEvent.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getScenario() : ProductTourScenarioInterface
+
+
+
+
+
+

Return values

+

ProductTourScenarioInterface

+ + +
+

+ publicisPropagationStopped() + ¶ +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetScenario() + ¶ +

+
+ RenderProductTourScenarioEvent.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setScenario(ProductTourScenarioInterface $scenario) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $scenario + + ProductTourScenarioInterface + + - + + - +
+ + +
+

+ publicstopPropagation() + ¶ +

+
+ Event.php + : + 47 + +
+
+

Stops the propagation of the event to further event listeners.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public stopPropagation() : void
+
+
+
+
+
+
+

If multiple event listeners are connected to the same event, no +further event listener will be triggered once any trigger calls +stopPropagation().

+ +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourBlockInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourBlockInterface.html new file mode 100644 index 0000000000..63a6ce2f4d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourBlockInterface.html @@ -0,0 +1,350 @@ + + + + + ProductTourBlockInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductTourBlockInterface

+ +
+ ProductTourBlockInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicgetType() + ¶ +

+
+ ProductTourBlockInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getType() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourScenarioInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourScenarioInterface.html new file mode 100644 index 0000000000..601ccebc9e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourScenarioInterface.html @@ -0,0 +1,811 @@ + + + + + ProductTourScenarioInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductTourScenarioInterface

+ +
+ ProductTourScenarioInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicaddStep() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 31 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public addStep(ProductTourStepInterface $step) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $step + + ProductTourStepInterface + + - + + - +
+ + +
+

+ publicgetIdentifier() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getIdentifier() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetSteps() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getSteps() : array<string|int, ProductTourStepInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ProductTourStepInterface>

+ + +
+

+ publicgetType() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getType() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetUserGroupsExcluded() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getUserGroupsExcluded() : array<string|int, string>
+
+
+
+
+
+

Return values

+

array<string|int, string>

+ + +
+

+ publicremoveStep() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public removeStep(ProductTourStepInterface $step) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $step + + ProductTourStepInterface + + - + + - +
+ + +
+

+ publicsetIdentifier() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setIdentifier(string $identifier) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+ + +
+

+ publicsetType() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setType(string $type) : void
+
+
+
+
+
+

Parameters

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

+ publicsetUserGroupsExcluded() + ¶ +

+
+ ProductTourScenarioInterface.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setUserGroupsExcluded(array<string|int, string> $userGroupsExcluded) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $userGroupsExcluded + + array<string|int, string> + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourStepInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourStepInterface.html new file mode 100644 index 0000000000..353c1e2737 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-ProductTour-ProductTourStepInterface.html @@ -0,0 +1,1029 @@ + + + + + ProductTourStepInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductTourStepInterface

+ +
+ ProductTourStepInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicaddBlock() + ¶ +

+
+ ProductTourStepInterface.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public addBlock(ProductTourBlockInterface $block) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $block + + ProductTourBlockInterface + + - + + - +
+ + +
+

+ publicgetBackgroundImage() + ¶ +

+
+ ProductTourStepInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getBackgroundImage() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publicgetBlocks() + ¶ +

+
+ ProductTourStepInterface.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getBlocks() : array<string|int, ProductTourBlockInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ProductTourBlockInterface>

+ + +
+

+ publicgetIdentifier() + ¶ +

+
+ ProductTourStepInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getIdentifier() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetInteractionMode() + ¶ +

+
+ ProductTourStepInterface.php + : + 31 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getInteractionMode() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publicgetTarget() + ¶ +

+
+ ProductTourStepInterface.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTarget() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publicgetTitle() + ¶ +

+
+ ProductTourStepInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTitle() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicremoveBlock() + ¶ +

+
+ ProductTourStepInterface.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public removeBlock(ProductTourBlockInterface $block) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $block + + ProductTourBlockInterface + + - + + - +
+ + +
+

+ publicsetBackgroundImage() + ¶ +

+
+ ProductTourStepInterface.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setBackgroundImage(string|null $backgroundImage) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $backgroundImage + + string|null + + - + + - +
+ + +
+

+ publicsetIdentifier() + ¶ +

+
+ ProductTourStepInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setIdentifier(string $identifier) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+ + +
+

+ publicsetInteractionMode() + ¶ +

+
+ ProductTourStepInterface.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setInteractionMode(string|null $interactionMode) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $interactionMode + + string|null + + - + + - +
+ + +
+

+ publicsetTarget() + ¶ +

+
+ ProductTourStepInterface.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setTarget(string|null $target) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $target + + string|null + + - + + - +
+ + +
+

+ publicsetTitle() + ¶ +

+
+ ProductTourStepInterface.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setTitle(string $title) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $title + + string + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-Renderer-BlockRendererInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-Renderer-BlockRendererInterface.html new file mode 100644 index 0000000000..187b54e3a2 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-IntegratedHelp-Renderer-BlockRendererInterface.html @@ -0,0 +1,377 @@ + + + + + BlockRendererInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BlockRendererInterface

+ +
+ BlockRendererInterface.php + : + 13 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ publicrender() + ¶ +

+
+ BlockRendererInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public render(ProductTourBlockInterface $block) : string
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $block + + ProductTourBlockInterface + + - + + - +
+

Return values

+

string

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Measurement-Converter-UnitConverterInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Measurement-Converter-UnitConverterInterface.html index 31f0674377..ae79fdb2b1 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Measurement-Converter-UnitConverterInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Measurement-Converter-UnitConverterInterface.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+

+ ProductAttributeRenderEvent

+ +
+ ProductAttributeRenderEvent.php + : + 14 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(array<int, string> $templates, AttributeInterface $attribute[, array<string|int, mixed> $parameters = [] ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $templates + + array<int, string> + + - + + - +
+ $attribute + + AttributeInterface + + - + + - +
+ $parameters + + array<string|int, mixed> + + [] + + - +
+ + +
+

+ publicaddTemplateAfter() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 79 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public addTemplateAfter(string $template, string $targetTemplate) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $template + + string + + - + + - +
+ $targetTemplate + + string + + - + + - +
+ + +
+

+ publicaddTemplateBefore() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 69 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public addTemplateBefore(string $template, string $targetTemplate) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $template + + string + + - + + - +
+ $targetTemplate + + string + + - + + - +
+ + +
+

+ publicappendTemplate() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 59 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public appendTemplate(string $template) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $template + + string + + - + + - +
+ + +
+

+ publicgetAttribute() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 94 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getAttribute() : AttributeInterface
+
+
+
+
+
+

Return values

+

AttributeInterface

+ + +
+

+ publicgetParameters() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getParameters() : array<string|int, mixed>
+
+
+
+
+
+

Return values

+

array<string|int, mixed>

+ + +
+

+ publicgetTemplates() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 46 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getTemplates() : array<int, string>
+
+
+
+
+
+

Return values

+

array<int, string>

+ + +
+

+ publichasTemplate() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 89 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public hasTemplate(string $template) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $template + + string + + - + + - +
+

Return values

+

bool

+ + +
+

+ publicprependTemplate() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 64 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public prependTemplate(string $template) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $template + + string + + - + + - +
+ + +
+

+ publicsetParameters() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setParameters(array<string|int, mixed> $parameters) : void
+
+
+
+
+
+

Parameters

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

+ publicsetTemplates() + ¶ +

+
+ ProductAttributeRenderEvent.php + : + 54 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public setTemplates(array<int, string> $templates) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $templates + + array<int, string> + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Events-RegionResolveEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Events-RegionResolveEvent.html index 43b3c75319..0452c8eb71 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Events-RegionResolveEvent.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Events-RegionResolveEvent.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+

+ TaxonomyNoEntries

+ +
+ TaxonomyNoEntries.php + : + 16 + +
+
Final
+ +
+ Extends Criterion +
+ +
+ Implements + FilteringCriterion
+ +
+ + + + + + + + + + + + + +

+ Properties¶ +

+ +
+

+ public + $operator + + ¶ +

+
+ Criterion.php + : + 21 + +
+
+

The operator used by the Criterion.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string $operator
+
+
+
+ + +
+

+ public + $target + + ¶ +

+
+ Criterion.php + : + 33 + +
+
+

The target used by the criteria (field, metadata...).

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public string|null $target
+
+
+
+ + +
+

+ public + $value + + ¶ +

+
+ Criterion.php + : + 28 + +
+
+

The value(s) matched by the criteria.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public array<string|int, scalar>|scalar $value
+
+
+
+ + +
+

+ public + $valueData + + ¶ +

+
+ Criterion.php + : + 38 + +
+
+

Additional value data, required by some criteria, MapLocationDistance for instance.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public Value|null $valueData
+
+
+
+ + + + +

+ Methods¶ +

+ +
+

+ public__construct() + ¶ +

+
+ TaxonomyNoEntries.php + : + 18 + +
+
+

Creates a Criterion.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public __construct(string $taxonomy)
+
+
+
+
+
+
+

Performs operator validation based on the Criterion specifications returned by Criterion::getSpecifications().

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $taxonomy + + string + + - + + - +
+ + +
+

+ publicgetSpecifications() + ¶ +

+
+ TaxonomyNoEntries.php + : + 23 + +
+
+

Criterion description function.

+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getSpecifications() : array<int, Specifications>
+
+
+
+
+
+
+

Returns the combination of the Criterion's supported operator/value, +as an array of Specifications objects

+ +
// IN and EQ are supported
+return [
+    // The EQ operator expects a single value, either as an integer or a string
+    new Specifications(
+        Operator::EQ,
+        Specifications::FORMAT_SINGLE,
+        Specifications::TYPE_INTEGER | Specifications::TYPE_STRING
+    ),
+    // The IN operator expects an array of values, of either integers or strings
+    new Specifications(
+        Operator::IN,
+        Specifications::FORMAT_ARRAY,
+        Specifications::TYPE_INTEGER | Specifications::TYPE_STRING
+    )
+]
+
+ +
+

Return values

+

array<int, Specifications>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Search-Query-Criterion-TaxonomySubtree.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Search-Query-Criterion-TaxonomySubtree.html index 3b3a887d21..17997a1df2 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Search-Query-Criterion-TaxonomySubtree.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Search-Query-Criterion-TaxonomySubtree.html @@ -17,7 +17,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-content-resolver.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-content-resolver.html new file mode 100644 index 0000000000..2ec3c545de --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-content-resolver.html @@ -0,0 +1,283 @@ + + + + + Resolver | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-content.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-content.html new file mode 100644 index 0000000000..f11c546be9 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-content.html @@ -0,0 +1,280 @@ + + + + + Content | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient-exception.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient-exception.html new file mode 100644 index 0000000000..41227fb1ac --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient-exception.html @@ -0,0 +1,290 @@ + + + + + Exception | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient-model.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient-model.html new file mode 100644 index 0000000000..11bc1e87ca --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient-model.html @@ -0,0 +1,290 @@ + + + + + Model | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient.html new file mode 100644 index 0000000000..4445decd88 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-raptorclient.html @@ -0,0 +1,288 @@ + + + + + RaptorClient | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-recommendations-value.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-recommendations-value.html new file mode 100644 index 0000000000..415bd60609 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-recommendations-value.html @@ -0,0 +1,290 @@ + + + + + Value | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-recommendations.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-recommendations.html new file mode 100644 index 0000000000..f9763c6c59 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-recommendations.html @@ -0,0 +1,292 @@ + + + + + Recommendations | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-tracking-event.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-tracking-event.html new file mode 100644 index 0000000000..e0c9daf3ea --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-tracking-event.html @@ -0,0 +1,325 @@ + + + + + Event | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Event +

+ +
+ + + + +

+ Interfaces, classes, traits, and enums¶ +

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-tracking.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-tracking.html new file mode 100644 index 0000000000..e42642e0d2 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor-tracking.html @@ -0,0 +1,362 @@ + + + + + Tracking | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Tracking +

+ +
+ + +

+ Namespaces¶ +

+ + + +

+ Interfaces, classes, traits, and enums¶ +

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor.html new file mode 100644 index 0000000000..fd919c310d --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-connectorraptor.html @@ -0,0 +1,308 @@ + + + + + ConnectorRaptor | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-contentforms-content-form-provider.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-contentforms-content-form-provider.html index 2138ed8b4c..f95bd8feab 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-contentforms-content-form-provider.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-contentforms-content-form-provider.html @@ -15,7 +15,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-corporateaccount-permission.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-corporateaccount-permission.html index 0450522faa..a57b258bcf 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-corporateaccount-permission.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-corporateaccount-permission.html @@ -15,7 +15,7 @@ + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-builder.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-builder.html new file mode 100644 index 0000000000..a98205d63e --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-builder.html @@ -0,0 +1,280 @@ + + + + + Builder | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-event.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-event.html new file mode 100644 index 0000000000..076691b89b --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-event.html @@ -0,0 +1,279 @@ + + + + + Event | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-producttour.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-producttour.html new file mode 100644 index 0000000000..ee9e9dcd8b --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-producttour.html @@ -0,0 +1,293 @@ + + + + + ProductTour | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-renderer.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-renderer.html new file mode 100644 index 0000000000..d9dc095665 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp-renderer.html @@ -0,0 +1,279 @@ + + + + + Renderer | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp.html new file mode 100644 index 0000000000..b6da26c7fc --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-integratedhelp.html @@ -0,0 +1,300 @@ + + + + + IntegratedHelp | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-measurement-converter.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-measurement-converter.html index 93a1e6a2be..ae8be14c6b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-measurement-converter.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-measurement-converter.html @@ -15,7 +15,7 @@