diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Menu-AbstractActionBuilder.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Menu-AbstractActionBuilder.html index 82fd6bd1c1..b832f5b646 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Menu-AbstractActionBuilder.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Menu-AbstractActionBuilder.html @@ -291,7 +291,7 @@

-
protected string IBEXA_BTN_CONTENT_DRAFT_EDIT_CLASS = 'ibexa-btn--content-draft-edit'
+
protected string IBEXA_BTN_CONTENT_DRAFT_EDIT_CLASS = 'ids-btn--content-draft-edit'
diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Doctrine-FilteringQueryBuilder.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Doctrine-FilteringQueryBuilder.html index dda8ccae66..9f3eba64bd 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Doctrine-FilteringQueryBuilder.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Doctrine-FilteringQueryBuilder.html @@ -326,7 +326,7 @@

FilteringQueryBuilder.php : - 127 + 234
@@ -397,6 +397,17 @@

Return values

FilteringQueryBuilder

+
+
+ Attributes + +
+
+
+ #[Override] +
+
+

publicbuildOperatorBasedCriterionConstraint() @@ -405,7 +416,7 @@

FilteringQueryBuilder.php : - 171 + 279

@@ -504,6 +515,96 @@
+

+ publicfrom() + +

+
+ FilteringQueryBuilder.php + : + 53 + +
+
+

Inherited from \Doctrine\DBAL\Query\QueryBuilder::from.

+ +
+ + + + + + + +
+
+
+
+
+
+
public from(string $from[, string|null $alias = null ]) : $this
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $from + + string + + - + + - +
+ $alias + + string|null + + null + + - +
+

Return values

+

$this

+ + +
+
+ Attributes + +
+
+
+ #[Override] +
+
+
+

publicgetExistingTableAliasJoinCondition() @@ -511,7 +612,7 @@

FilteringQueryBuilder.php : - 102 + 219

@@ -527,7 +628,7 @@

-
public getExistingTableAliasJoinCondition(string $tableAlias) : string
+
public getExistingTableAliasJoinCondition(string $tableAlias) : string|null
@@ -564,7 +665,7 @@

Parameters

Return values

-

string

+

string|null

conditions, null if table is not joined yet.

@@ -573,17 +674,18 @@

Return values

-

- publicjoinAllLocations() - +

+ publichasFromAlias() +

FilteringQueryBuilder.php : - 234 + 145
+

Whether $alias has been registered as a root FROM alias (via {@see from()}).

@@ -596,7 +698,7 @@

@@ -605,23 +707,50 @@

+

Parameters

+
-
public joinAllLocations() : FilteringQueryBuilder
+
public hasFromAlias(string $alias) : bool
+ + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $alias + + string + + - + + - +

Return values

-

FilteringQueryBuilder

+

bool

-

- publicjoinOnce() - +

+ publicinnerJoin() +

FilteringQueryBuilder.php : - 38 + 91
-

Create table JOIN, but only if it hasn't been already joined (determined based on $tableAlias).

+

Inherited from \Doctrine\DBAL\Query\QueryBuilder::innerJoin.

@@ -634,7 +763,7 @@

@@ -670,7 +799,7 @@

Parameters

+ + + + + +
-
public joinOnce(string $fromAlias, string $tableName, string $tableAlias, string $conditions) : FilteringQueryBuilder
+
public innerJoin(string $fromAlias, string $join, string $alias[, string|Stringable|null $condition = null ]) : $this
- $tableName + $join string @@ -684,7 +813,7 @@

Parameters

- $tableAlias + $alias string @@ -698,7 +827,111 @@

Parameters

- $conditions + $condition + + string|Stringable|null + + null + + - +
+

Return values

+

$this

+ + +
+
+ Attributes + +
+
+
+ #[Override] +
+
+
+
+

+ publicjoin() + +

+
+ FilteringQueryBuilder.php + : + 73 + +
+
+

Inherited from \Doctrine\DBAL\Query\QueryBuilder::join.

+ +
+ + + + + + + +
+
+
+
+
+
+
public join(string $fromAlias, string $join, string $alias[, string|Stringable|null $condition = null ]) : $this
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $fromAlias + + string + + - + + - +
+ $join + + string + + - + + - +
+ $alias string @@ -709,40 +942,47 @@

Parameters

-
+ $condition + + string|Stringable|null + + null + + - +

Return values

-

FilteringQueryBuilder

- -
- Tags - - -
-
-
- Throws -
-
- DatabaseException -
-

if conditions of pre-existing same alias joins are different

- -
- -
-
+

$this

+ +
+
+ Attributes + +
+
+
+ #[Override] +
+
+
-

- publicjoinPublishedVersion() - +

+ publicjoinAllLocations() +

FilteringQueryBuilder.php : - 210 + 341
@@ -758,7 +998,7 @@

-
public joinPublishedVersion() : FilteringQueryBuilder
+
public joinAllLocations() : FilteringQueryBuilder
@@ -772,18 +1012,18 @@

Return values

-

- publicleftJoinOnce() - +

+ publicjoinOnce() +

FilteringQueryBuilder.php : - 71 + 155
-

Create table LEFT JOIN, but only if it hasn't been already joined (determined based on $tableAlias).

+

Create table JOIN, but only if it hasn't been already joined (determined based on $tableAlias).

@@ -796,7 +1036,7 @@

@@ -879,7 +1119,7 @@

Return values

Tags - +
@@ -896,9 +1136,407 @@
- - - +
+

+ publicjoinPublishedVersion() + +

+
+ FilteringQueryBuilder.php + : + 317 + +
+
+ +
+
-
public leftJoinOnce(string $fromAlias, string $tableName, string $tableAlias, string $conditions) : FilteringQueryBuilder
+
public joinOnce(string $fromAlias, string $tableName, string $tableAlias, string $conditions) : FilteringQueryBuilder
+ + + + + + +
+
+
+
+
+
+
public joinPublishedVersion() : FilteringQueryBuilder
+
+
+
+
+
+

Return values

+

FilteringQueryBuilder

+ + +
+

+ publicleftJoin() + +

+
+ FilteringQueryBuilder.php + : + 109 + +
+
+

Inherited from \Doctrine\DBAL\Query\QueryBuilder::leftJoin.

+ +
+ + + + + + + +
+
+
+
+
+
+
public leftJoin(string $fromAlias, string $join, string $alias[, string|Stringable|null $condition = null ]) : $this
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $fromAlias + + string + + - + + - +
+ $join + + string + + - + + - +
+ $alias + + string + + - + + - +
+ $condition + + string|Stringable|null + + null + + - +
+

Return values

+

$this

+ + +
+
+ Attributes + +
+
+
+ #[Override] +
+
+
+
+

+ publicleftJoinOnce() + +

+
+ FilteringQueryBuilder.php + : + 188 + +
+
+

Create table LEFT JOIN, but only if it hasn't been already joined (determined based on $tableAlias).

+ +
+ + + + + + + +
+
+
+
+
+
+
public leftJoinOnce(string $fromAlias, string $tableName, string $tableAlias, string $conditions) : FilteringQueryBuilder
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $fromAlias + + string + + - + + - +
+ $tableName + + string + + - + + - +
+ $tableAlias + + string + + - + + - +
+ $conditions + + string + + - + + - +
+

Return values

+

FilteringQueryBuilder

+ +
+ Tags + + +
+
+
+ Throws +
+
+ DatabaseException +
+

if conditions of pre-existing same alias joins are different

+ +
+ +
+
+ +
+

+ publicrightJoin() + +

+
+ FilteringQueryBuilder.php + : + 127 + +
+
+

Inherited from \Doctrine\DBAL\Query\QueryBuilder::rightJoin.

+ +
+ + + + + + + +
+
+
+
+
+
+
public rightJoin(string $fromAlias, string $join, string $alias[, string|Stringable|null $condition = null ]) : $this
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $fromAlias + + string + + - + + - +
+ $join + + string + + - + + - +
+ $alias + + string + + - + + - +
+ $condition + + string|Stringable|null + + null + + - +
+

Return values

+

$this

+ + +
+
+ Attributes + +
+
+
+ #[Override] +
+
+
+
+ +
@@ -939,11 +1577,31 @@
buildOperatorBasedCriterionConstraint() + +
  • + + from() +
  • getExistingTableAliasJoinCondition() +
  • +
  • + + hasFromAlias() + +
  • +
  • + + innerJoin() + +
  • +
  • + + join() +
  • @@ -959,11 +1617,21 @@
    joinPublishedVersion() +
  • +
  • + + leftJoin() +
  • leftJoinOnce() +
  • +
  • + + rightJoin() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Message.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Message.html index 9c24cb62bd..e90c9b2076 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Message.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Message.html @@ -461,7 +461,7 @@

    Message.php : - 50 + 60

    @@ -501,6 +501,81 @@
    +
    +

    + publicgetMessageTemplate() + +

    +
    + Message.php + : + 50 + +
    +
    +

    The message template to translate, with %placeholder% parameters.

    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getMessageTemplate() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValues() + +

    +
    + Message.php + : + 55 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValues() : array<string, scalar|null>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string, scalar|null>

    + +

    protectedgetProperties() @@ -633,6 +708,16 @@

    __toString() + +
  • + + getMessageTemplate() + +
  • +
  • + + getValues() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Plural.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Plural.html index 38a0f151d2..1a700a9a84 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Plural.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation-Plural.html @@ -249,7 +249,7 @@

    Plural.php : - 36 + 37
    @@ -305,7 +305,7 @@

    Plural.php : - 48 + 49

  • @@ -342,7 +342,7 @@

    Plural.php : - 42 + 43
    @@ -379,7 +379,7 @@

    Plural.php : - 55 + 56
    @@ -419,7 +419,7 @@

    Plural.php : - 62 + 63
    @@ -510,7 +510,7 @@

    Plural.php : - 71 + 82
    @@ -550,6 +550,81 @@

    +
    +

    + publicgetMessageTemplate() + +

    +
    + Plural.php + : + 72 + +
    +
    +

    The message template to translate, with %placeholder% parameters.

    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getMessageTemplate() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValues() + +

    +
    + Plural.php + : + 77 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValues() : array<string, scalar|null>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string, scalar|null>

    + +

    protectedgetProperties() @@ -687,6 +762,16 @@

    __toString() + +
  • + + getMessageTemplate() + +
  • +
  • + + getValues() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation.html index 249735de12..4a580453b4 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Translation.html @@ -367,6 +367,81 @@

    Parameters

    +
    +

    + publicgetMessageTemplate() + +

    +
    + Translation.php + : + 24 + +
    +
    +

    The message template to translate, with %placeholder% parameters.

    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public abstract getMessageTemplate() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValues() + +

    +
    + Translation.php + : + 29 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public abstract getValues() : array<string, scalar|null>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string, scalar|null>

    + +

    protectedgetProperties() @@ -475,6 +550,16 @@

    __construct() +
  • +
  • + + getMessageTemplate() + +
  • +
  • + + getValues() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Admin-Form-Data-GeneralPropertiesInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Admin-Form-Data-GeneralPropertiesInterface.html index 886ecd3391..2cd7f09468 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Admin-Form-Data-GeneralPropertiesInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Admin-Form-Data-GeneralPropertiesInterface.html @@ -250,7 +250,7 @@

    GeneralPropertiesInterface.php : - 19 + 18
    Interface
    @@ -281,7 +281,7 @@

    GeneralPropertiesInterface.php : - 21 + 20

  • @@ -313,7 +313,7 @@

    GeneralPropertiesInterface.php : - 22 + 21
    @@ -415,7 +415,7 @@

    GeneralPropertiesInterface.php : - 109 + 103
    @@ -479,7 +479,7 @@

    GeneralPropertiesInterface.php : - 116 + 110
    @@ -558,7 +558,7 @@

    GeneralPropertiesInterface.php : - 54 + 48
    @@ -646,7 +646,7 @@

    GeneralPropertiesInterface.php : - 86 + 80
    @@ -697,7 +697,7 @@

    GeneralPropertiesInterface.php : - 42 + 41
    @@ -726,20 +726,6 @@

    Return values

    string

    -
    -
    - Attributes - -
    -
    -
    - #[Sequentially] -
    -
    - [new Assert\NotBlank(), new Assert\Length(min: 1, max: 190), new Identifier()] -
    -
    -

    publicgetLabel() @@ -748,7 +734,7 @@

    GeneralPropertiesInterface.php : - 123 + 117

    @@ -802,7 +788,7 @@

    GeneralPropertiesInterface.php : - 131 + 125
    @@ -853,7 +839,7 @@

    GeneralPropertiesInterface.php : - 29 + 28
    @@ -890,7 +876,7 @@

    GeneralPropertiesInterface.php : - 31 + 30
    @@ -941,7 +927,7 @@

    GeneralPropertiesInterface.php : - 62 + 56
    @@ -995,7 +981,7 @@

    GeneralPropertiesInterface.php : - 104 + 98
    @@ -1032,7 +1018,7 @@

    GeneralPropertiesInterface.php : - 77 + 71
    @@ -1088,7 +1074,7 @@

    GeneralPropertiesInterface.php : - 94 + 88
    @@ -1125,7 +1111,7 @@

    GeneralPropertiesInterface.php : - 70 + 64
    @@ -1226,7 +1212,7 @@

    GeneralPropertiesInterface.php : - 114 + 108
    @@ -1290,7 +1276,7 @@

    GeneralPropertiesInterface.php : - 121 + 115
    @@ -1418,7 +1404,7 @@

    GeneralPropertiesInterface.php : - 60 + 54
    @@ -1544,7 +1530,7 @@

    GeneralPropertiesInterface.php : - 99 + 93
    @@ -1608,7 +1594,7 @@

    GeneralPropertiesInterface.php : - 92 + 86
    @@ -1672,7 +1658,7 @@

    GeneralPropertiesInterface.php : - 52 + 46
    @@ -1736,7 +1722,7 @@

    GeneralPropertiesInterface.php : - 129 + 123
    @@ -1800,7 +1786,7 @@

    GeneralPropertiesInterface.php : - 137 + 131
    @@ -1864,7 +1850,7 @@

    GeneralPropertiesInterface.php : - 27 + 26
    @@ -1928,7 +1914,7 @@

    GeneralPropertiesInterface.php : - 40 + 39
    @@ -1992,7 +1978,7 @@

    GeneralPropertiesInterface.php : - 75 + 69
    @@ -2056,7 +2042,7 @@

    GeneralPropertiesInterface.php : - 68 + 62
    @@ -2120,7 +2106,7 @@

    GeneralPropertiesInterface.php : - 84 + 78
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformName.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformName.html index d888c58ab9..61ea00befe 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformName.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformName.html @@ -110,7 +110,7 @@
    - +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformResolver.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformResolver.html index 5d17c71d81..aeeac607ab 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformResolver.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-Database-DatabasePlatformResolver.html @@ -111,7 +111,7 @@
    - +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-SchemaAssetsFilterBypassInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-SchemaAssetsFilterBypassInterface.html new file mode 100644 index 0000000000..0776ab511b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-DoctrineSchema-SchemaAssetsFilterBypassInterface.html @@ -0,0 +1,403 @@ + + + + + SchemaAssetsFilterBypassInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + SchemaAssetsFilterBypassInterface

    + +
    + SchemaAssetsFilterBypassInterface.php + : + 25 + +
    +
    Interface
    + +
    +

    Temporarily lifts whatever schema assets filter is configured on a +connection so a callback can see every table, then restores it.

    + + +
    +

    Doctrine\DBAL\Configuration::setSchemaAssetsFilter() is applied by +AbstractSchemaManager to every schema introspection call on a connection +(listTables(), tablesExist(), listTableDetails(), ...), not just to +doctrine:schema:update's comparison. Code that legitimately needs to see +a table hidden by such a filter - e.g. checking whether its own +hand-managed table already exists - has to bypass the filter for that one +call rather than rely on it.

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

    + Methods +

    + +
    +

    + publiccall() + +

    +
    + SchemaAssetsFilterBypassInterface.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public call(Connection $connection, callable $callback) : mixed
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $connection + + Connection + + - + + - +
    + $callback + + callable + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockAttributeDefinition.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockAttributeDefinition.html index 75e8f75187..01a73e55b3 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockAttributeDefinition.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockAttributeDefinition.html @@ -445,7 +445,7 @@

    -
    protected array<string|int, mixed> $options = []
    +
    protected array<string, mixed> $options = []
    @@ -538,7 +538,7 @@

    BlockAttributeDefinition.php : - 105 + 111

    @@ -686,7 +686,7 @@

    BlockAttributeDefinition.php : - 79 + 82
    @@ -702,7 +702,7 @@

    -
    public getOptions() : array<string|int, mixed>
    +
    public getOptions() : array<string, mixed>
    @@ -712,7 +712,7 @@

    Return values

    -

    array<string|int, mixed>

    +

    array<string, mixed>

    @@ -760,7 +760,7 @@

    BlockAttributeDefinition.php : - 92 + 98

    @@ -795,7 +795,7 @@

    BlockAttributeDefinition.php : - 110 + 116
    @@ -1043,7 +1043,7 @@

    BlockAttributeDefinition.php : - 84 + 90
    @@ -1059,7 +1059,7 @@

    -
    public setOptions(array<string|int, mixed> $options) : void
    +
    public setOptions(array<string, mixed> $options) : void
    @@ -1084,7 +1084,7 @@

    Parameters

    $options - array<string|int, mixed> + array<string, mixed> - @@ -1167,7 +1167,7 @@

    BlockAttributeDefinition.php : - 100 + 106
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html index 370cf50736..c0feca607a 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html @@ -255,7 +255,7 @@

    BlockDefinition.php : - 11 + 14
    @@ -289,7 +289,7 @@

    BlockDefinition.php : - 37 + 42
    @@ -324,7 +324,7 @@

    BlockDefinition.php : - 40 + 45
    @@ -359,7 +359,7 @@

    BlockDefinition.php : - 22 + 27
    @@ -394,7 +394,7 @@

    BlockDefinition.php : - 31 + 36
    @@ -419,6 +419,41 @@

    +
    +

    + protected + $description + + +

    +
    + BlockDefinition.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    protected string $description = ''
    +
    +
    +
    + +

    protected @@ -429,7 +464,7 @@

    BlockDefinition.php : - 14 + 17

    @@ -464,7 +499,7 @@

    BlockDefinition.php : - 17 + 20
    @@ -499,7 +534,7 @@

    BlockDefinition.php : - 19 + 24
    @@ -534,7 +569,7 @@

    BlockDefinition.php : - 25 + 30
    @@ -569,7 +604,7 @@

    BlockDefinition.php : - 34 + 39
    @@ -585,7 +620,7 @@

    -
    protected array<string|int, string> $views = []
    +
    protected array<string, TView$views = []
    @@ -604,7 +639,7 @@

    BlockDefinition.php : - 28 + 33
    @@ -643,7 +678,7 @@

    BlockDefinition.php : - 124 + 139
    @@ -707,7 +742,7 @@

    BlockDefinition.php : - 111 + 126
    @@ -744,7 +779,7 @@

    BlockDefinition.php : - 152 + 167
    @@ -781,7 +816,7 @@

    BlockDefinition.php : - 72 + 87
    @@ -818,7 +853,7 @@

    BlockDefinition.php : - 129 + 144
    @@ -847,6 +882,43 @@

    Return values

    string

    +
    +

    + publicgetDescription() + +

    +
    + BlockDefinition.php + : + 67 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getDescription() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + +

    publicgetIdentifier() @@ -855,7 +927,7 @@

    BlockDefinition.php : - 42 + 47

    @@ -892,7 +964,7 @@

    BlockDefinition.php : - 52 + 57
    @@ -929,7 +1001,7 @@

    BlockDefinition.php : - 62 + 77
    @@ -966,7 +1038,7 @@

    BlockDefinition.php : - 82 + 97
    @@ -1003,7 +1075,7 @@

    BlockDefinition.php : - 95 + 110
    @@ -1019,7 +1091,7 @@

    -
    public getViews() : array<string|int, string>
    +
    public getViews() : array<string, TView>
    @@ -1029,7 +1101,7 @@

    Return values

    -

    array<string|int, string>

    +

    array<string, TView>

    @@ -1040,7 +1112,7 @@

    BlockDefinition.php : - 139 + 154

    @@ -1077,7 +1149,7 @@

    BlockDefinition.php : - 119 + 134
    @@ -1139,7 +1211,7 @@

    BlockDefinition.php : - 160 + 175
    @@ -1201,7 +1273,7 @@

    BlockDefinition.php : - 77 + 92
    @@ -1263,7 +1335,7 @@

    BlockDefinition.php : - 134 + 149
    @@ -1317,6 +1389,68 @@

    Parameters

    +
    +

    + publicsetDescription() + +

    +
    + BlockDefinition.php + : + 72 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setDescription(string $description) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $description + + string + + - + + - +
    + +

    publicsetIdentifier() @@ -1325,7 +1459,7 @@

    BlockDefinition.php : - 47 + 52

    @@ -1387,7 +1521,7 @@

    BlockDefinition.php : - 57 + 62
    @@ -1449,7 +1583,7 @@

    BlockDefinition.php : - 67 + 82
    @@ -1511,7 +1645,7 @@

    BlockDefinition.php : - 87 + 102
    @@ -1573,7 +1707,7 @@

    BlockDefinition.php : - 103 + 118
    @@ -1589,7 +1723,7 @@

    -
    public setViews(array<string|int, string> $views) : void
    +
    public setViews(array<string, TView$views) : void
    @@ -1614,7 +1748,7 @@

    Parameters

    $views - array<string|int, string> + array<string, TView> - @@ -1635,7 +1769,7 @@

    BlockDefinition.php : - 144 + 159
    @@ -1728,6 +1862,11 @@

    Parameters

    configurationTemplate + +
  • + + description +
  • @@ -1792,6 +1931,11 @@

    Parameters

    getConfigurationTemplate() +
  • +
  • + + getDescription() +
  • @@ -1842,6 +1986,11 @@

    Parameters

    setConfigurationTemplate() +
  • +
  • + + setDescription() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html index 69d5e33140..d6a7a78bbc 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html @@ -293,7 +293,7 @@

    BlockDefinition.php : - 37 + 42
    @@ -328,7 +328,7 @@

    BlockDefinition.php : - 40 + 45
    @@ -363,7 +363,7 @@

    BlockDefinition.php : - 22 + 27
    @@ -433,7 +433,7 @@

    BlockDefinition.php : - 31 + 36
    @@ -458,6 +458,41 @@

    +
    +

    + protected + $description + + +

    +
    + BlockDefinition.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    protected string $description = ''
    +
    +
    +
    + +

    protected @@ -468,7 +503,7 @@

    BlockDefinition.php : - 14 + 17

    @@ -503,7 +538,7 @@

    BlockDefinition.php : - 17 + 20
    @@ -538,7 +573,7 @@

    BlockDefinition.php : - 19 + 24
    @@ -573,7 +608,7 @@

    BlockDefinition.php : - 25 + 30
    @@ -608,7 +643,7 @@

    BlockDefinition.php : - 34 + 39
    @@ -624,7 +659,7 @@

    -
    protected array<string|int, string> $views = []
    +
    protected array<string, TView$views = []
    @@ -643,7 +678,7 @@

    BlockDefinition.php : - 28 + 33
    @@ -682,7 +717,7 @@

    BlockDefinition.php : - 124 + 139
    @@ -746,7 +781,7 @@

    BlockDefinition.php : - 111 + 126
    @@ -783,7 +818,7 @@

    BlockDefinition.php : - 152 + 167
    @@ -820,7 +855,7 @@

    BlockDefinition.php : - 72 + 87
    @@ -894,7 +929,7 @@

    BlockDefinition.php : - 129 + 144
    @@ -923,6 +958,43 @@

    Return values

    string

    +
    +

    + publicgetDescription() + +

    +
    + BlockDefinition.php + : + 67 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getDescription() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + +

    publicgetIdentifier() @@ -931,7 +1003,7 @@

    BlockDefinition.php : - 42 + 47

    @@ -968,7 +1040,7 @@

    BlockDefinition.php : - 52 + 57
    @@ -1005,7 +1077,7 @@

    BlockDefinition.php : - 62 + 77
    @@ -1042,7 +1114,7 @@

    BlockDefinition.php : - 82 + 97
    @@ -1079,7 +1151,7 @@

    BlockDefinition.php : - 95 + 110
    @@ -1095,7 +1167,7 @@

    -
    public getViews() : array<string|int, string>
    +
    public getViews() : array<string, TView>
    @@ -1105,7 +1177,7 @@

    Return values

    -

    array<string|int, string>

    +

    array<string, TView>

    @@ -1116,7 +1188,7 @@

    BlockDefinition.php : - 139 + 154

    @@ -1153,7 +1225,7 @@

    BlockDefinition.php : - 119 + 134
    @@ -1215,7 +1287,7 @@

    BlockDefinition.php : - 160 + 175
    @@ -1277,7 +1349,7 @@

    BlockDefinition.php : - 77 + 92
    @@ -1401,7 +1473,7 @@

    BlockDefinition.php : - 134 + 149
    @@ -1455,6 +1527,68 @@

    Parameters

    +
    +

    + publicsetDescription() + +

    +
    + BlockDefinition.php + : + 72 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setDescription(string $description) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $description + + string + + - + + - +
    + +

    publicsetIdentifier() @@ -1463,7 +1597,7 @@

    BlockDefinition.php : - 47 + 52

    @@ -1525,7 +1659,7 @@

    BlockDefinition.php : - 57 + 62
    @@ -1587,7 +1721,7 @@

    BlockDefinition.php : - 67 + 82
    @@ -1649,7 +1783,7 @@

    BlockDefinition.php : - 87 + 102
    @@ -1711,7 +1845,7 @@

    BlockDefinition.php : - 103 + 118
    @@ -1727,7 +1861,7 @@

    -
    public setViews(array<string|int, string> $views) : void
    +
    public setViews(array<string, TView$views) : void
    @@ -1752,7 +1886,7 @@

    Parameters

    $views - array<string|int, string> + array<string, TView> - @@ -1773,7 +1907,7 @@

    BlockDefinition.php : - 144 + 159
    @@ -1871,6 +2005,11 @@

    Parameters

    configurationTemplate +
  • +
  • + + description +
  • @@ -1940,6 +2079,11 @@

    Parameters

    getConfigurationTemplate() +
  • +
  • + + getDescription() +
  • @@ -1995,6 +2139,11 @@

    Parameters

    setConfigurationTemplate() +
  • +
  • + + setDescription() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-PageStructure-Event-PageStructureResolveEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-PageStructure-Event-PageStructureResolveEvent.html new file mode 100644 index 0000000000..ce41394bfa --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-PageStructure-Event-PageStructureResolveEvent.html @@ -0,0 +1,647 @@ + + + + + PageStructureResolveEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +
    +

    + PageStructureResolveEvent

    + +
    + PageStructureResolveEvent.php + : + 18 + +
    +
    Final
    + +
    + Extends Event +
    + + +
    +

    Allows amending the resolved Page structure before it is returned.

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

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + PageStructureResolveEvent.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(PageStructure $pageStructure[, ContentType|null $contentType = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $pageStructure + + PageStructure + + - + + - +
    + $contentType + + ContentType|null + + null + + - +
    + + +
    +

    + publicgetContentType() + +

    +
    + PageStructureResolveEvent.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getContentType() : ContentType|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    ContentType|null

    + + +
    +

    + publicgetPageStructure() + +

    +
    + PageStructureResolveEvent.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getPageStructure() : PageStructure
    +
    +
    +
    +
    +
    +

    Return values

    +

    PageStructure

    + + +
    +

    + publicisPropagationStopped() + +

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

    Return values

    +

    bool

    + + +
    +

    + publicsetPageStructure() + +

    +
    + PageStructureResolveEvent.php + : + 31 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setPageStructure(PageStructure $pageStructure) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $pageStructure + + PageStructure + + - + + - +
    + + +
    +

    + 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-HttpCache-ResponseTagger-ResponseTagger.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-HttpCache-ResponseTagger-ResponseTagger.html index 5777ec8f7a..41facc78b9 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-HttpCache-ResponseTagger-ResponseTagger.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-HttpCache-ResponseTagger-ResponseTagger.html @@ -266,6 +266,70 @@

    +

    + publicsupports() + +

    +
    + ResponseTagger.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public supports(mixed $value) : bool
    +
    +
    +
    +
    +
    +

    Parameters

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

    Return values

    +

    bool

    + + +

    publictag() @@ -273,7 +337,7 @@

    ResponseTagger.php : - 21 + 23

    @@ -349,6 +413,11 @@

    Parameters

    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-Criterion-LogicalAnd.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-Criterion-LogicalAnd.html new file mode 100644 index 0000000000..e5b87b48c9 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-Criterion-LogicalAnd.html @@ -0,0 +1,638 @@ + + + + + LogicalAnd | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +
    +

    + LogicalAnd

    + +
    + LogicalAnd.php + : + 14 + +
    +
    Final
    + +
    + Extends LogicalAnd +
    + +
    + Implements + CriterionInterface
    + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + AbstractCompositeCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(CriterionInterface ...$criteria)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicadd() + +

    +
    + AbstractCompositeCriterion.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public add(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicgetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 47 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public final getCriteria() : array<string|int, CriterionInterface>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, CriterionInterface>

    + + +
    +

    + publicremove() + +

    +
    + AbstractCompositeCriterion.php + : + 29 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public remove(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicsetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 39 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setCriteria(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Encoder-BlockAttribute-BlockAttributeEncoderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-Criterion-LogicalOr.html similarity index 64% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Encoder-BlockAttribute-BlockAttributeEncoderInterface.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-Criterion-LogicalOr.html index 85e7c00594..146e90bd7a 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Encoder-BlockAttribute-BlockAttributeEncoderInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-Criterion-LogicalOr.html @@ -2,7 +2,7 @@ - BlockAttributeEncoderInterface | PHP API Reference (Ibexa Documentation) + LogicalOr | PHP API Reference (Ibexa Documentation) @@ -216,20 +216,20 @@ >
  • @@ -238,19 +238,28 @@
    -
    -
    -

    - BlockAttributeEncoderInterface

    - -
    - BlockAttributeEncoderInterface.php +
    +
    +
    +

    + LogicalOr

    + +
    + LogicalOr.php : - 11 + 14
    -
    Interface
    - +
    Final
    + +
    + Extends LogicalOr +
    + +
    + Implements + CriterionInterface
    + @@ -265,19 +274,20 @@

    +

    - Methods + Methods

    -

    - publiccanDecode() - +

    + public__construct() +

    -
    - BlockAttributeEncoderInterface.php +
    + AbstractCompositeCriterion.php : - 15 + 16
    @@ -293,7 +303,7 @@

    -
    public canDecode(string $type) : bool
    +
    public __construct(CriterionInterface ...$criteria)
    @@ -315,10 +325,10 @@

    Parameters

    - $type + $criteria - string + CriterionInterface - @@ -329,19 +339,17 @@

    Parameters

    -

    Return values

    -

    bool

    - +
    -

    - publiccanEncode() - +

    + publicadd() +

    -
    - BlockAttributeEncoderInterface.php +
    + AbstractCompositeCriterion.php : - 13 + 21
    @@ -357,7 +365,7 @@

    -
    public canEncode(string $type) : bool
    +
    public add(CriterionInterface ...$criteria) : void
    @@ -379,10 +387,10 @@

    Parameters

    - $type + $criteria - string + CriterionInterface - @@ -393,19 +401,54 @@

    Parameters

    + + +
    +

    + publicgetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 47 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public final getCriteria() : array<string|int, CriterionInterface>
    +
    +
    +
    +
    +

    Return values

    -

    bool

    +

    array<string|int, CriterionInterface>

    -

    - publicdecode() - +

    + publicremove() +

    -
    - BlockAttributeEncoderInterface.php +
    + AbstractCompositeCriterion.php : - 22 + 29
    @@ -421,7 +464,7 @@

    -
    public decode(string $value) : string
    +
    public remove(CriterionInterface ...$criteria) : void
    @@ -443,10 +486,10 @@

    Parameters

    - $value + $criteria - string + CriterionInterface - @@ -457,19 +500,17 @@

    Parameters

    -

    Return values

    -

    string

    - +
    -

    - publicencode() - +

    + publicsetCriteria() +

    -
    - BlockAttributeEncoderInterface.php +
    + AbstractCompositeCriterion.php : - 20 + 39
    @@ -485,7 +526,7 @@

    -
    public encode(mixed $value) : string
    +
    public setCriteria(CriterionInterface ...$criteria) : void
    @@ -507,10 +548,10 @@

    Parameters

    - $value + $criteria - mixed + CriterionInterface - @@ -521,9 +562,7 @@

    Parameters

    -

    Return values

    -

    string

    - +
    @@ -533,36 +572,41 @@

    Return values

    @@ -266,7 +265,6 @@

    -

    @@ -275,10 +273,10 @@

    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-SegmentQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-SegmentQuery.html new file mode 100644 index 0000000000..3484d7c0ea --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-SegmentQuery.html @@ -0,0 +1,494 @@ + + + + + SegmentQuery | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +
    +

    + SegmentQuery

    + +
    + SegmentQuery.php + : + 11 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $query + + +

    +
    + SegmentQuery.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public CriterionInterface|null $query = null
    +
    +
    +
    + + +
    +

    + public + $searchPhrase + + +

    +
    + SegmentQuery.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string|null $searchPhrase = null
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + SegmentQuery.php + : + 13 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct([CriterionInterface|null $query = null ][, string|null $searchPhrase = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + CriterionInterface|null + + null + + - +
    + $searchPhrase + + string|null + + null + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-SegmentSearchResult.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-SegmentSearchResult.html new file mode 100644 index 0000000000..af4756a317 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-Query-SegmentSearchResult.html @@ -0,0 +1,494 @@ + + + + + SegmentSearchResult | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +
    +

    + SegmentSearchResult

    + +
    + SegmentSearchResult.php + : + 13 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $segments + + +

    +
    + SegmentSearchResult.php + : + 19 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public array<string|int, mixed> $segments
    +
    +
    +
    + + +
    +

    + public + $totalCount + + +

    +
    + SegmentSearchResult.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $totalCount
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + SegmentSearchResult.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(array<int, Segment$segments, int $totalCount)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $segments + + array<int, Segment> + + - + + - +
    + $totalCount + + int + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceDecorator.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceDecorator.html index b4c76ff1a3..9b50a5befb 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceDecorator.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceDecorator.html @@ -239,7 +239,7 @@

    SegmentationServiceDecorator.php : - 19 + 21
    Abstract
    @@ -277,7 +277,7 @@

    SegmentationServiceDecorator.php : - 21 + 23

    @@ -316,7 +316,7 @@

    SegmentationServiceDecorator.php : - 23 + 25

    @@ -378,7 +378,7 @@

    SegmentationServiceDecorator.php : - 108 + 110
    @@ -446,6 +446,167 @@

    Parameters

    +
    +

    + publiccountSegmentsPerGroup() + +

    +
    + SegmentationServiceDecorator.php + : + 125 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public countSegmentsPerGroup([array<string|int, mixed> $sources = [] ][, string|null $searchPhrase = null ]) : array<int, int>
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $sources + + array<string|int, mixed> + + [] + + - +
    + $searchPhrase + + string|null + + null + + - +
    +

    Return values

    +

    array<int, int>

    +
    +

    segment counts keyed by segment group id, ordered by group name

    + +
    + + + +
    +

    + publiccountSegmentsPerSource() + +

    +
    + SegmentationServiceDecorator.php + : + 130 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public countSegmentsPerSource([array<string|int, mixed> $segmentGroupIds = [] ][, string|null $searchPhrase = null ]) : array<string, int>
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $segmentGroupIds + + array<string|int, mixed> + + [] + + - +
    + $searchPhrase + + string|null + + null + + - +
    +

    Return values

    +

    array<string, int>

    + +

    publiccreateSegment() @@ -454,7 +615,7 @@

    SegmentationServiceDecorator.php : - 43 + 45

    @@ -518,7 +679,7 @@

    SegmentationServiceDecorator.php : - 73 + 75
    @@ -574,6 +735,70 @@

    Return values

    SegmentGroup

    +
    +

    + publicfindSegments() + +

    +
    + SegmentationServiceDecorator.php + : + 120 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public findSegments([SegmentQuery|null $query = null ]) : SegmentSearchResult
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + SegmentQuery|null + + null + + - +
    +

    Return values

    +

    SegmentSearchResult

    + +

    publicisUserAssignedToSegment() @@ -582,7 +807,7 @@

    SegmentationServiceDecorator.php : - 103 + 105

    @@ -660,7 +885,7 @@

    SegmentationServiceDecorator.php : - 28 + 30
    @@ -725,7 +950,7 @@

    SegmentationServiceDecorator.php : - 38 + 40
    @@ -789,7 +1014,7 @@

    SegmentationServiceDecorator.php : - 63 + 65
    @@ -854,7 +1079,7 @@

    SegmentationServiceDecorator.php : - 68 + 70
    @@ -918,7 +1143,7 @@

    SegmentationServiceDecorator.php : - 88 + 90
    @@ -955,7 +1180,7 @@

    SegmentationServiceDecorator.php : - 33 + 35
    @@ -1019,7 +1244,7 @@

    SegmentationServiceDecorator.php : - 98 + 100
    @@ -1056,7 +1281,7 @@

    SegmentationServiceDecorator.php : - 58 + 60
    @@ -1120,7 +1345,7 @@

    SegmentationServiceDecorator.php : - 93 + 95
    @@ -1184,7 +1409,7 @@

    SegmentationServiceDecorator.php : - 53 + 55
    @@ -1246,7 +1471,7 @@

    SegmentationServiceDecorator.php : - 83 + 85
    @@ -1308,7 +1533,7 @@

    SegmentationServiceDecorator.php : - 113 + 115
    @@ -1384,7 +1609,7 @@

    SegmentationServiceDecorator.php : - 48 + 50
    @@ -1462,7 +1687,7 @@

    SegmentationServiceDecorator.php : - 78 + 80
    @@ -1575,6 +1800,16 @@

    Return values

    assignUserToSegment() + +
  • + + countSegmentsPerGroup() + +
  • +
  • + + countSegmentsPerSource() +
  • @@ -1585,6 +1820,11 @@

    Return values

    createSegmentGroup() +
  • +
  • + + findSegments() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceInterface.html index 3caaadc91d..28f163bdf9 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Segmentation-SegmentationServiceInterface.html @@ -239,7 +239,7 @@

    SegmentationServiceInterface.php : - 19 + 21
    Interface
    @@ -270,7 +270,7 @@

    SegmentationServiceInterface.php : - 81 + 83
    @@ -366,6 +366,167 @@

    +
    +

    + publiccountSegmentsPerGroup() + +

    +
    + SegmentationServiceInterface.php + : + 94 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public countSegmentsPerGroup([array<string|int, string> $sources = [] ][, string|null $searchPhrase = null ]) : array<int, int>
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $sources + + array<string|int, string> + + [] + + - +
    + $searchPhrase + + string|null + + null + + - +
    +

    Return values

    +

    array<int, int>

    +
    +

    segment counts keyed by segment group id, ordered by group name

    + +
    + + + +
    +

    + publiccountSegmentsPerSource() + +

    +
    + SegmentationServiceInterface.php + : + 101 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public countSegmentsPerSource([array<string|int, int> $segmentGroupIds = [] ][, string|null $searchPhrase = null ]) : array<string, int>
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $segmentGroupIds + + array<string|int, int> + + [] + + - +
    + $searchPhrase + + string|null + + null + + - +
    +

    Return values

    +

    array<string, int>

    + +

    publiccreateSegment() @@ -374,7 +535,7 @@

    SegmentationServiceInterface.php : - 35 + 37

    @@ -438,7 +599,7 @@

    SegmentationServiceInterface.php : - 53 + 55
    @@ -494,6 +655,70 @@

    Return values

    SegmentGroup

    +
    +

    + publicfindSegments() + +

    +
    + SegmentationServiceInterface.php + : + 87 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public findSegments([SegmentQuery|null $query = null ]) : SegmentSearchResult
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + SegmentQuery|null + + null + + - +
    +

    Return values

    +

    SegmentSearchResult

    + +

    publicisUserAssignedToSegment() @@ -502,7 +727,7 @@

    SegmentationServiceInterface.php : - 74 + 76

    @@ -580,7 +805,7 @@

    SegmentationServiceInterface.php : - 24 + 26
    @@ -645,7 +870,7 @@

    SegmentationServiceInterface.php : - 33 + 35
    @@ -709,7 +934,7 @@

    SegmentationServiceInterface.php : - 49 + 51
    @@ -774,7 +999,7 @@

    SegmentationServiceInterface.php : - 51 + 53
    @@ -838,7 +1063,7 @@

    SegmentationServiceInterface.php : - 62 + 64
    @@ -875,7 +1100,7 @@

    SegmentationServiceInterface.php : - 31 + 33
    @@ -939,7 +1164,7 @@

    SegmentationServiceInterface.php : - 72 + 74
    @@ -976,7 +1201,7 @@

    SegmentationServiceInterface.php : - 44 + 46
    @@ -1040,7 +1265,7 @@

    SegmentationServiceInterface.php : - 67 + 69
    @@ -1104,7 +1329,7 @@

    SegmentationServiceInterface.php : - 39 + 41
    @@ -1166,7 +1391,7 @@

    SegmentationServiceInterface.php : - 57 + 59
    @@ -1228,7 +1453,7 @@

    SegmentationServiceInterface.php : - 83 + 85
    @@ -1304,7 +1529,7 @@

    SegmentationServiceInterface.php : - 37 + 39
    @@ -1382,7 +1607,7 @@

    SegmentationServiceInterface.php : - 55 + 57
    @@ -1476,6 +1701,16 @@

    Return values

    assignUserToSegment() +
  • +
  • + + countSegmentsPerGroup() + +
  • +
  • + + countSegmentsPerSource() +
  • @@ -1486,6 +1721,11 @@

    Return values

    createSegmentGroup() +
  • +
  • + + findSegments() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsFormMapper-AttributeOptionsFormMapperInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsFormMapper-AttributeOptionsFormMapperInterface.html new file mode 100644 index 0000000000..f360c1d1f8 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsFormMapper-AttributeOptionsFormMapperInterface.html @@ -0,0 +1,413 @@ + + + + + AttributeOptionsFormMapperInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + AttributeOptionsFormMapperInterface

    + +
    + AttributeOptionsFormMapperInterface.php + : + 13 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publiccreateOptionsForm() + +

    +
    + AttributeOptionsFormMapperInterface.php + : + 21 + +
    +
    +

    Adds a form field named $name exposing the attribute type options.

    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public createOptionsForm(string $name, FormBuilderInterface<string|int, mixed> $builder, array{type_identifier: string, language_code: string, translation_mode?: bool} $context) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $name + + string + + - + + - +
    + $builder + + FormBuilderInterface<string|int, mixed> + + - + + - +
    + $context + + array{type_identifier: string, language_code: string, translation_mode?: bool} + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsValidator-AttributeOptionsValidatorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsValidator-AttributeOptionsValidatorInterface.html new file mode 100644 index 0000000000..57188e9610 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsValidator-AttributeOptionsValidatorInterface.html @@ -0,0 +1,386 @@ + + + + + AttributeOptionsValidatorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + AttributeOptionsValidatorInterface

    + +
    + AttributeOptionsValidatorInterface.php + : + 13 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicvalidateOptions() + +

    +
    + AttributeOptionsValidatorInterface.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public validateOptions(OptionsBag $options) : array<string|int, OptionsValidatorError>
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $options + + OptionsBag + + - + + - +
    +

    Return values

    +

    array<string|int, OptionsValidatorError>

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Messenger-Stamp-DeduplicateStamp.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsValidator-OptionsValidatorError.html similarity index 68% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Messenger-Stamp-DeduplicateStamp.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsValidator-OptionsValidatorError.html index 63552ee772..2c253012b1 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Messenger-Stamp-DeduplicateStamp.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Attribute-OptionsValidator-OptionsValidatorError.html @@ -2,10 +2,10 @@ - DeduplicateStamp | PHP API Reference (Ibexa Documentation) + OptionsValidatorError | PHP API Reference (Ibexa Documentation) - + @@ -110,7 +110,7 @@
    - +
    @@ -216,16 +216,20 @@ >
  • + @@ -235,60 +239,25 @@ -

    - DeduplicateStamp

    - -
    - DeduplicateStamp.php +

    + OptionsValidatorError

    + +
    + OptionsValidatorError.php : - 25 + 11
    -
    Final
    +
    Read-only
    +
    Final
    -
    - Implements - StampInterface
    -

    (c) Fabien Potencier <fabien@symfony.com>.

    - -
    - -
    -

    since Ibexa 5.0.10. Starting from Ibexa 6.0, the native DeduplicateStamp -will be used instead. Ibexa 5.0 is not prepared to handle the Symfony stamp yet, so keep using -this class until you upgrade.

    - -
    -
    -
    -

    Original code: https://github.com/symfony/symfony/blob/7.3/src/Symfony/Component/Messenger/Stamp/DeduplicateStamp.php

    - -
    - - -
    - Tags - -
    -
    -
    - Deprecated -
    -
    -
    -

    since Ibexa 5.0.10. Starting from Ibexa 6.0, the native DeduplicateStamp -will be used instead. Ibexa 5.0 is not prepared to handle the Symfony stamp yet, so keep using -this class until you upgrade.

    -
    - -
    -
    + @@ -298,20 +267,21 @@
    - -

    - Methods +

    + Properties

    -
    -

    - public__construct() - +
    +

    + public + $message + +

    -
    - DeduplicateStamp.php +
    + OptionsValidatorError.php : - 33 + 18
    @@ -327,81 +297,26 @@

    -
    public __construct(string $key[, float|null $ttl = 300.0 ][, bool $onlyDeduplicateInQueue = false ])
    +
    public string $message

    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDefault valueDescription
    - $key - - string - - - - - - -
    - $ttl - - float|null - - 300.0 - - - -
    - $onlyDeduplicateInQueue - - bool - - false - - - -
    -
    -

    - publicgetKey() - +
    +

    + public + $parameters + +

    -
    - DeduplicateStamp.php +
    + OptionsValidatorError.php : - 63 + 19
    @@ -417,28 +332,26 @@

    -
    public getKey() : Key
    +
    public array<string|int, mixed> $parameters = []

    -
    -
    -

    Return values

    -

    Key

    - + -
    -

    - publicgetTtl() - +
    +

    + public + $target + +

    -
    - DeduplicateStamp.php +
    + OptionsValidatorError.php : - 68 + 17
    @@ -454,28 +367,30 @@

    -
    public getTtl() : float|null
    +
    public string $target

    -
    -
    -

    Return values

    -

    float|null

    - + + + -
    -

    - publiconlyDeduplicateInQueue() - +

    + Methods +

    + +
    +

    + public__construct() +

    -
    - DeduplicateStamp.php +
    + OptionsValidatorError.php : - 58 + 16
    @@ -491,7 +406,7 @@

    -
    public onlyDeduplicateInQueue() : bool
    +
    public __construct(string $target, string $message[, array<string, mixed> $parameters = [] ])
    @@ -500,9 +415,62 @@

    -

    Return values

    -

    bool

    - +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $target + + string + + - + + - +
    + $message + + string + + - + + - +
    + $parameters + + array<string, mixed> + + [] + + - +
    +
    @@ -513,35 +481,44 @@

    Return values

    @@ -349,6 +349,13 @@
    ValidationFailedException +
    +
    + Throws +
    +
    + UnauthorizedException +
    @@ -360,7 +367,7 @@

    AttributeDefinitionServiceInterface.php : - 71 + 75

    @@ -425,6 +432,13 @@
    InvalidArgumentException +
    +
    + Throws +
    +
    + UnauthorizedException +
    @@ -436,7 +450,7 @@

    AttributeDefinitionServiceInterface.php : - 73 + 81

    @@ -502,7 +516,28 @@

    Parameters

    - + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + NotFoundException + +
    +
    + Throws +
    +
    + UnauthorizedException + +
    +

    @@ -512,7 +547,7 @@

    AttributeDefinitionServiceInterface.php : - 38 + 39

    @@ -611,7 +646,7 @@

    AttributeDefinitionServiceInterface.php : - 27 + 28

    @@ -703,7 +738,7 @@

    AttributeDefinitionServiceInterface.php : - 81 + 89
    @@ -781,7 +816,7 @@

    AttributeDefinitionServiceInterface.php : - 52 + 54
    @@ -845,7 +880,7 @@

    AttributeDefinitionServiceInterface.php : - 54 + 56
    @@ -909,7 +944,7 @@

    AttributeDefinitionServiceInterface.php : - 63 + 66
    @@ -1004,6 +1039,13 @@

    ValidationFailedException +
    +
    + Throws +
    +
    + UnauthorizedException +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-AttributeGroupServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-AttributeGroupServiceInterface.html index 69a735162e..4cdd29e86d 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-AttributeGroupServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-AttributeGroupServiceInterface.html @@ -237,7 +237,7 @@

    AttributeGroupServiceInterface.php : - 19 + 20
    Interface
    @@ -268,7 +268,7 @@

    AttributeGroupServiceInterface.php : - 44 + 46
    @@ -335,6 +335,13 @@

    InvalidArgumentException +
    +
    + Throws +
    +
    + UnauthorizedException +
    @@ -346,7 +353,7 @@

    AttributeGroupServiceInterface.php : - 62 + 66
    @@ -411,6 +418,13 @@

    InvalidArgumentException +
    +
    + Throws +
    +
    + UnauthorizedException +
    @@ -422,7 +436,7 @@

    AttributeGroupServiceInterface.php : - 67 + 72
    @@ -501,6 +515,13 @@

    NotFoundException +
    +
    + Throws +
    +
    + UnauthorizedException +
    @@ -512,7 +533,7 @@

    AttributeGroupServiceInterface.php : - 36 + 37
    @@ -604,7 +625,7 @@

    AttributeGroupServiceInterface.php : - 26 + 27
    @@ -696,7 +717,7 @@

    AttributeGroupServiceInterface.php : - 75 + 80
    @@ -774,7 +795,7 @@

    AttributeGroupServiceInterface.php : - 46 + 48
    @@ -838,7 +859,7 @@

    AttributeGroupServiceInterface.php : - 48 + 50
    @@ -902,7 +923,7 @@

    AttributeGroupServiceInterface.php : - 54 + 57
    @@ -990,6 +1011,13 @@

    NotFoundException +
    +
    + Throws +
    +
    + UnauthorizedException +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-SiteContextAssignmentServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-BrandContextAssignmentServiceInterface.html similarity index 72% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-SiteContextAssignmentServiceInterface.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-BrandContextAssignmentServiceInterface.html index ece79bde07..fe0697b7ef 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-SiteContextAssignmentServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-BrandContextAssignmentServiceInterface.html @@ -2,7 +2,7 @@ - SiteContextAssignmentServiceInterface | PHP API Reference (Ibexa Documentation) + BrandContextAssignmentServiceInterface | PHP API Reference (Ibexa Documentation) @@ -221,7 +221,7 @@ @@ -231,11 +231,11 @@ -

    - SiteContextAssignmentServiceInterface

    - -
    - SiteContextAssignmentServiceInterface.php +

    + BrandContextAssignmentServiceInterface

    + +
    + BrandContextAssignmentServiceInterface.php : 19 @@ -257,16 +257,74 @@

    - Methods + Methods

    +

    + publicgetAllAssignments() + +

    +
    + BrandContextAssignmentServiceInterface.php + : + 50 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getAllAssignments() : array<string|int, Assignment>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, Assignment>

    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + Exception + +
    +
    + Throws +
    +
    + Exception + +
    +
    + +

    publicgetAssignments() - +

    -
    - SiteContextAssignmentServiceInterface.php +
    + BrandContextAssignmentServiceInterface.php : 29 @@ -284,7 +342,7 @@

    -
    public getAssignments(int $contextId) : array<string|int, Assignment>
    +
    public getAssignments(int $contextId) : array<string|int, Assignment>
    @@ -321,11 +379,11 @@

    Parameters

    Return values

    -

    array<string|int, Assignment>

    +

    array<string|int, Assignment>

    Tags - +
    @@ -362,12 +420,12 @@

    publicresolveContextForSiteAccess() - +

    -
    - SiteContextAssignmentServiceInterface.php +
    + BrandContextAssignmentServiceInterface.php : - 44 + 56
    @@ -383,7 +441,7 @@

    -
    public resolveContextForSiteAccess(string $siteAccessName) : Assignment|null
    +
    public resolveContextForSiteAccess(string $siteAccessName) : Assignment|null
    @@ -420,16 +478,37 @@

    Parameters

    Return values

    -

    Assignment|null

    - +

    Assignment|null

    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + Exception + +
    +
    + Throws +
    +
    + Exception + +
    +

    publicsetAssignments() - +

    -
    - SiteContextAssignmentServiceInterface.php +
    + BrandContextAssignmentServiceInterface.php : 39 @@ -447,7 +526,7 @@

    -
    public setAssignments(int $contextId, array<string|int, AssignmentCreateStruct$assignments) : void
    +
    public setAssignments(int $contextId, array<string|int, AssignmentCreateStruct$assignments) : void
    @@ -486,7 +565,7 @@

    Parameters

    $assignments - array<string|int, AssignmentCreateStruct> + array<string|int, AssignmentCreateStruct> - @@ -500,7 +579,7 @@

    Parameters

    Tags - +
    @@ -543,29 +622,34 @@
    -

    - SiteContextInstanceServiceInterface

    - -
    - SiteContextInstanceServiceInterface.php +

    + BrandContextServiceInterface

    + +
    + BrandContextServiceInterface.php : 22 @@ -257,16 +257,16 @@

    - Methods + Methods

    -

    - publiccreateSiteContext() - +

    + publiccreateBrandContext() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 55 @@ -284,7 +284,7 @@

    -
    public createSiteContext(SiteContextCreateStruct $createStruct) : SiteContextInterface
    +
    public createBrandContext(BrandContextCreateStruct $createStruct) : BrandContextInterface
    @@ -309,7 +309,7 @@

    Parameters

    $createStruct - SiteContextCreateStruct + BrandContextCreateStruct - @@ -321,11 +321,11 @@

    Parameters

    Return values

    -

    SiteContextInterface

    +

    BrandContextInterface

    Tags - +
    @@ -367,12 +367,12 @@
    -

    - publicdeleteSiteContext() - +

    + publicdeleteBrandContext() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 77 @@ -390,7 +390,7 @@

    -
    public deleteSiteContext(SiteContextInterface $siteContext) : void
    +
    public deleteBrandContext(BrandContextInterface $brandContext) : void
    @@ -412,10 +412,10 @@

    Parameters

    - $siteContext + $brandContext - SiteContextInterface + BrandContextInterface - @@ -429,7 +429,7 @@

    Parameters

    Tags - +
    @@ -457,12 +457,12 @@
    -

    - publicdeleteSiteContextTranslation() - +

    + publicdeleteBrandContextTranslation() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 83 @@ -480,7 +480,7 @@

    -
    public deleteSiteContextTranslation(SiteContextInterface $siteContext, string $languageCode) : void
    +
    public deleteBrandContextTranslation(BrandContextInterface $brandContext, string $languageCode) : void
    @@ -502,10 +502,10 @@

    Parameters

    - $siteContext + $brandContext - SiteContextInterface + BrandContextInterface - @@ -533,7 +533,7 @@

    Parameters

    Tags - +
    @@ -554,12 +554,12 @@
    -

    - publicfindSiteContexts() - +

    + publicfindBrandContexts() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 43 @@ -577,7 +577,7 @@

    -
    public findSiteContexts([SiteContextQuery|null $query = null ][, iterable<string|int, string>|null $prioritizedLanguages = null ]) : SiteContextCollectionInterface
    +
    public findBrandContexts([BrandContextQuery|null $query = null ][, iterable<string|int, string>|null $prioritizedLanguages = null ]) : BrandContextCollectionInterface
    @@ -602,7 +602,7 @@

    Parameters

    $query - SiteContextQuery|null + BrandContextQuery|null null @@ -628,11 +628,11 @@

    Parameters

    Return values

    -

    SiteContextCollectionInterface

    +

    BrandContextCollectionInterface

    Tags - +
    @@ -660,12 +660,12 @@
    -

    - publicgetSiteContext() - +

    + publicgetBrandContext() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 31 @@ -683,7 +683,7 @@

    -
    public getSiteContext(string $identifier[, iterable<string|int, string>|null $prioritizedLanguages = null ]) : SiteContextInterface
    +
    public getBrandContext(string $identifier[, iterable<string|int, string>|null $prioritizedLanguages = null ]) : BrandContextInterface
    @@ -734,11 +734,11 @@

    Parameters

    Return values

    -

    SiteContextInterface

    +

    BrandContextInterface

    Tags - +
    @@ -766,12 +766,12 @@
    -

    - publicnewSiteContextCreateStruct() - +

    + publicnewBrandContextCreateStruct() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 57 @@ -789,7 +789,7 @@

    -
    public newSiteContextCreateStruct(string $identifier) : SiteContextCreateStruct
    +
    public newBrandContextCreateStruct(string $identifier) : BrandContextCreateStruct
    @@ -826,16 +826,16 @@

    Parameters

    Return values

    -

    SiteContextCreateStruct

    +

    BrandContextCreateStruct

    -

    - publicnewSiteContextUpdateStruct() - +

    + publicnewBrandContextUpdateStruct() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 59 @@ -853,7 +853,7 @@

    -
    public newSiteContextUpdateStruct(SiteContextInterface $siteContext) : SiteContextUpdateStruct
    +
    public newBrandContextUpdateStruct(BrandContextInterface $brandContext) : BrandContextUpdateStruct
    @@ -875,10 +875,10 @@

    Parameters

    - $siteContext + $brandContext - SiteContextInterface + BrandContextInterface - @@ -890,16 +890,16 @@

    Parameters

    Return values

    -

    SiteContextUpdateStruct

    +

    BrandContextUpdateStruct

    -

    - publicupdateSiteContext() - +

    + publicupdateBrandContext() +

    -
    - SiteContextInstanceServiceInterface.php +
    + BrandContextServiceInterface.php : 67 @@ -917,7 +917,7 @@

    -
    public updateSiteContext(SiteContextInterface $siteContext, SiteContextUpdateStruct $updateStruct) : SiteContextInterface
    +
    public updateBrandContext(BrandContextInterface $brandContext, BrandContextUpdateStruct $updateStruct) : BrandContextInterface
    @@ -939,10 +939,10 @@

    Parameters

    - $siteContext + $brandContext - SiteContextInterface + BrandContextInterface - @@ -956,7 +956,7 @@

    Parameters

    $updateStruct - SiteContextUpdateStruct + BrandContextUpdateStruct - @@ -968,11 +968,11 @@

    Parameters

    Return values

    -

    SiteContextInterface

    +

    BrandContextInterface

    Tags - +
    @@ -1015,55 +1015,55 @@
    @@ -295,7 +295,7 @@

    -
    public __construct(string $identifier[, AttributeGroupInterface|null $group = null ][, string|null $typeIdentifier = null ][, int $position = 0 ][, bool $required = false ][, bool $translatable = false ][, array<string, string|null> $descriptions = [] ])
    +
    public __construct(string $identifier[, AttributeGroupInterface|null $group = null ][, string|null $typeIdentifier = null ][, int $position = 0 ][, bool $required = false ][, bool $translatable = false ][, array<string, string|null> $descriptions = [] ][, array<string, mixed> $options = [] ])
    @@ -412,6 +412,20 @@

    Parameters

    - + + + + $options + + + array<string, mixed> + + + [] + + + - + @@ -425,7 +439,7 @@

    AttributeDefinitionCreateStruct.php : - 105 + 107

    @@ -462,7 +476,7 @@

    AttributeDefinitionCreateStruct.php : - 44 + 46

    @@ -499,7 +513,7 @@

    AttributeDefinitionCreateStruct.php : - 34 + 36

    @@ -528,6 +542,43 @@

    Return values

    string

    +
    +

    + publicgetOptions() + +

    +
    + AttributeDefinitionCreateStruct.php + : + 130 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOptions() : array<string, mixed>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string, mixed>

    + +

    publicgetPosition() @@ -536,7 +587,7 @@

    AttributeDefinitionCreateStruct.php : - 72 + 74

    @@ -573,7 +624,7 @@

    AttributeDefinitionCreateStruct.php : - 58 + 60

    @@ -610,7 +661,7 @@

    AttributeDefinitionCreateStruct.php : - 82 + 84

    @@ -647,7 +698,7 @@

    AttributeDefinitionCreateStruct.php : - 92 + 94

    @@ -684,7 +735,7 @@

    AttributeDefinitionCreateStruct.php : - 118 + 120

    @@ -760,7 +811,7 @@

    AttributeDefinitionCreateStruct.php : - 113 + 115

    @@ -822,7 +873,7 @@

    AttributeDefinitionCreateStruct.php : - 53 + 55

    @@ -884,7 +935,7 @@

    AttributeDefinitionCreateStruct.php : - 39 + 41

    @@ -938,6 +989,68 @@

    Parameters

    +
    +

    + publicsetOptions() + +

    +
    + AttributeDefinitionCreateStruct.php + : + 138 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOptions(array<string, mixed> $options) : void
    +
    +
    +
    +
    +
    +

    Parameters

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

    publicsetPosition() @@ -946,7 +1059,7 @@

    AttributeDefinitionCreateStruct.php : - 77 + 79

    @@ -1008,7 +1121,7 @@

    AttributeDefinitionCreateStruct.php : - 87 + 89

    @@ -1070,7 +1183,7 @@

    AttributeDefinitionCreateStruct.php : - 97 + 99

    @@ -1132,7 +1245,7 @@

    AttributeDefinitionCreateStruct.php : - 67 + 69

    @@ -1225,6 +1338,11 @@

    Parameters

    getIdentifier() + +
  • + + getOptions() +
  • @@ -1265,6 +1383,11 @@

    Parameters

    setIdentifier() +
  • +
  • + + setOptions() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionQuery.html index a89eebb7ef..477afb370c 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionQuery.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionQuery.html @@ -330,7 +330,7 @@

    -
    public __construct([CriterionInterface|null $query = null ][, int $offset = 0 ][, int $limit = \self::DEFAULT_LIMIT ])
    +
    public __construct([CriterionInterface|null $query = null ][, int $offset = 0 ][, int|null $limit = \self::DEFAULT_LIMIT ])
    @@ -383,7 +383,7 @@

    Parameters

    $limit - int + int|null AttributeDefinitionQuery::DEFAULT_LIMIT @@ -420,7 +420,7 @@

    -
    public getLimit() : int
    +
    public getLimit() : int|null
    @@ -430,7 +430,7 @@

    Return values

    -

    int

    +

    int|null

    @@ -531,7 +531,7 @@

    -
    public setLimit(int $limit) : void
    +
    public setLimit(int|null $limit) : void
    @@ -556,7 +556,7 @@

    Parameters

    $limit - int + int|null - diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionUpdateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionUpdateStruct.html index 98feb1c489..b1dec74df3 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionUpdateStruct.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinition-AttributeDefinitionUpdateStruct.html @@ -279,7 +279,7 @@

    AttributeDefinitionUpdateStruct.php : - 19 + 20

    @@ -295,7 +295,7 @@

    -
    public __construct([string|null $identifier = null ][, AttributeGroupInterface|null $group = null ][, string|null $typeIdentifier = null ][, int|null $position = null ][, bool|null $required = null ][, bool|null $translatable = null ][, array<string, string|null>|null $descriptions = null ])
    +
    public __construct([string|null $identifier = null ][, AttributeGroupInterface|null $group = null ][, string|null $typeIdentifier = null ][, int|null $position = null ][, bool|null $required = null ][, bool|null $translatable = null ][, array<string, string|null>|null $descriptions = null ][, array<string, mixed>|null $options = null ])
    @@ -412,6 +412,20 @@

    Parameters

    - + + + + $options + + + array<string, mixed>|null + + + null + + + - + @@ -425,7 +439,7 @@

    AttributeDefinitionUpdateStruct.php : - 93 + 95

  • @@ -462,7 +476,7 @@

    AttributeDefinitionUpdateStruct.php : - 40 + 42

    @@ -499,7 +513,7 @@

    AttributeDefinitionUpdateStruct.php : - 30 + 32

    @@ -528,6 +542,43 @@

    Return values

    string|null

    +
    +

    + publicgetOptions() + +

    +
    + AttributeDefinitionUpdateStruct.php + : + 119 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOptions() : array<string, mixed>|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string, mixed>|null

    + +

    publicgetPosition() @@ -536,7 +587,7 @@

    AttributeDefinitionUpdateStruct.php : - 60 + 62

    @@ -573,7 +624,7 @@

    AttributeDefinitionUpdateStruct.php : - 70 + 72

    @@ -610,7 +661,7 @@

    AttributeDefinitionUpdateStruct.php : - 80 + 82

    @@ -647,7 +698,7 @@

    AttributeDefinitionUpdateStruct.php : - 50 + 52

    @@ -684,7 +735,7 @@

    AttributeDefinitionUpdateStruct.php : - 106 + 108

    @@ -760,7 +811,7 @@

    AttributeDefinitionUpdateStruct.php : - 101 + 103

    @@ -822,7 +873,7 @@

    AttributeDefinitionUpdateStruct.php : - 45 + 47

    @@ -884,7 +935,7 @@

    AttributeDefinitionUpdateStruct.php : - 35 + 37

    @@ -938,6 +989,68 @@

    Parameters

    +
    +

    + publicsetOptions() + +

    +
    + AttributeDefinitionUpdateStruct.php + : + 127 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOptions(array<string, mixed>|null $options) : void
    +
    +
    +
    +
    +
    +

    Parameters

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

    publicsetPosition() @@ -946,7 +1059,7 @@

    AttributeDefinitionUpdateStruct.php : - 65 + 67

    @@ -1008,7 +1121,7 @@

    AttributeDefinitionUpdateStruct.php : - 75 + 77

    @@ -1070,7 +1183,7 @@

    AttributeDefinitionUpdateStruct.php : - 85 + 87

    @@ -1132,7 +1245,7 @@

    AttributeDefinitionUpdateStruct.php : - 55 + 57

    @@ -1225,6 +1338,11 @@

    Parameters

    getIdentifier() + +
  • + + getOptions() +
  • @@ -1265,6 +1383,11 @@

    Parameters

    setIdentifier() +
  • +
  • + + setOptions() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinitionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinitionInterface.html index 7159111252..5d88fd4f3e 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinitionInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeDefinitionInterface.html @@ -241,7 +241,7 @@

    AttributeDefinitionInterface.php : - 11 + 13
    Interface
    @@ -272,7 +272,7 @@

    AttributeDefinitionInterface.php : - 27 + 31

  • @@ -336,7 +336,7 @@

    AttributeDefinitionInterface.php : - 37 + 41

    @@ -373,7 +373,7 @@

    AttributeDefinitionInterface.php : - 17 + 19

    @@ -410,7 +410,7 @@

    AttributeDefinitionInterface.php : - 13 + 15

    @@ -447,7 +447,7 @@

    AttributeDefinitionInterface.php : - 15 + 17

    @@ -484,7 +484,7 @@

    AttributeDefinitionInterface.php : - 32 + 36

    @@ -513,6 +513,43 @@

    Return values

    array<string|int, string>

    +
    +

    + publicgetOptions() + +

    +
    + AttributeDefinitionInterface.php + : + 29 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOptions() : OptionsBag
    +
    +
    +
    +
    +
    +

    Return values

    +

    OptionsBag

    + +

    publicgetPosition() @@ -521,7 +558,7 @@

    AttributeDefinitionInterface.php : - 21 + 23

    @@ -558,7 +595,7 @@

    AttributeDefinitionInterface.php : - 19 + 21

    @@ -595,7 +632,7 @@

    AttributeDefinitionInterface.php : - 23 + 25

    @@ -632,7 +669,7 @@

    AttributeDefinitionInterface.php : - 25 + 27

    @@ -710,6 +747,11 @@

    Return values

    getLanguages() + +
  • + + getOptions() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupCreateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupCreateStruct.html index 2f5ba652b1..b095c7f9de 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupCreateStruct.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupCreateStruct.html @@ -295,7 +295,7 @@

    -
    public __construct(string $identifier[, string|null $icon = null ][, array<string, string> $labels = [] ])
    +
    public __construct(string $identifier[, array<string, string> $labels = [] ][, bool $isAiSystem = false ])
    @@ -331,13 +331,13 @@

    Parameters

    - $icon + $labels - string|null + array<string, string> - null + [] - @@ -345,13 +345,13 @@

    Parameters

    - $labels + $isAiSystem - array<string, string> + bool - [] + false - @@ -362,14 +362,14 @@

    Parameters

    -

    - publicgetIcon() - +

    + publicgetIdentifier() +

    AttributeGroupCreateStruct.php : - 32 + 22
    @@ -385,7 +385,7 @@

    -
    public getIcon() : string|null
    +
    public getIdentifier() : string
    @@ -395,18 +395,18 @@

    Return values

    -

    string|null

    +

    string

    -

    - publicgetIdentifier() - +

    + publicgetLabels() +

    AttributeGroupCreateStruct.php : - 22 + 45
    @@ -422,7 +422,7 @@

    -
    public getIdentifier() : string
    +
    public getLabels() : array<string, string>
    @@ -432,18 +432,18 @@

    Return values

    -

    string

    +

    array<string, string>

    -

    - publicgetLabels() - +

    + publicisAiSystem() +

    AttributeGroupCreateStruct.php : - 45 + 32
    @@ -459,7 +459,7 @@

    -
    public getLabels() : array<string, string>
    +
    public isAiSystem() : bool
    @@ -469,18 +469,18 @@

    Return values

    -

    array<string, string>

    +

    bool

    -

    - publicsetIcon() - +

    + publicsetIdentifier() +

    AttributeGroupCreateStruct.php : - 37 + 27
    @@ -496,7 +496,7 @@

    -
    public setIcon(string|null $icon) : void
    +
    public setIdentifier(string $identifier) : void
    @@ -518,10 +518,10 @@

    Parameters

    - $icon + $identifier - string|null + string - @@ -535,14 +535,14 @@

    Parameters

    -

    - publicsetIdentifier() - +

    + publicsetIsAiSystem() +

    AttributeGroupCreateStruct.php : - 27 + 37
    @@ -558,7 +558,7 @@

    -
    public setIdentifier(string $identifier) : void
    +
    public setIsAiSystem(bool $isAiSystem) : void
    @@ -580,10 +580,10 @@

    Parameters

    - $identifier + $isAiSystem - string + bool - @@ -758,11 +758,6 @@

    Parameters

    __construct() -
  • -
  • - - getIcon() -
  • @@ -775,14 +770,19 @@

    Parameters

  • - - setIcon() + + isAiSystem()
  • setIdentifier() +
  • +
  • + + setIsAiSystem() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupQuery.html index 75e7e8839a..d58a71762d 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupQuery.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupQuery.html @@ -330,7 +330,7 @@

    -
    public __construct([CriterionInterface|null $query = null ][, int $offset = 0 ][, int $limit = \self::DEFAULT_LIMIT ])
    +
    public __construct([CriterionInterface|null $query = null ][, int $offset = 0 ][, int|null $limit = \self::DEFAULT_LIMIT ])
    @@ -383,7 +383,7 @@

    Parameters

    $limit - int + int|null AttributeGroupQuery::DEFAULT_LIMIT @@ -420,7 +420,7 @@

    -
    public getLimit() : int
    +
    public getLimit() : int|null
    @@ -430,7 +430,7 @@

    Return values

    -

    int

    +

    int|null

    @@ -531,7 +531,7 @@

    -
    public setLimit(int $limit) : void
    +
    public setLimit(int|null $limit) : void
    @@ -556,7 +556,7 @@

    Parameters

    $limit - int + int|null - diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupUpdateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupUpdateStruct.html index b411f23514..1d0cd8bea5 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupUpdateStruct.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroup-AttributeGroupUpdateStruct.html @@ -295,7 +295,7 @@

    -
    public __construct([string|null $identifier = null ][, string|null $icon = null ][, array<string, string>|null $labels = null ])
    +
    public __construct([string|null $identifier = null ][, array<string, string>|null $labels = null ])
    @@ -328,20 +328,6 @@

    Parameters

    - - - - - $icon - - - string|null - - - null - - - - - @@ -361,43 +347,6 @@

    Parameters

    -
    -

    - publicgetIcon() - -

    -
    - AttributeGroupUpdateStruct.php - : - 32 - -
    -
    - -
    - - - - - - - -
    -
    -
    -
    -
    -
    -
    public getIcon() : string|null
    -
    -
    -
    -
    -
    -

    Return values

    -

    string|null

    - -

    publicgetIdentifier() @@ -406,7 +355,7 @@

    AttributeGroupUpdateStruct.php : - 22 + 21

    @@ -443,7 +392,7 @@

    AttributeGroupUpdateStruct.php : - 45 + 34

    @@ -472,68 +421,6 @@

    Return values

    array<string, string>|null

    -
    -

    - publicsetIcon() - -

    -
    - AttributeGroupUpdateStruct.php - : - 37 - -
    -
    - -
    - - - - - - - -
    -
    -
    -
    -
    -
    -
    public setIcon(string|null $icon) : void
    -
    -
    -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    NameTypeDefault valueDescription
    - $icon - - string|null - - - - - - -
    - -

    publicsetIdentifier() @@ -542,7 +429,7 @@

    AttributeGroupUpdateStruct.php : - 27 + 26

    @@ -604,7 +491,7 @@

    AttributeGroupUpdateStruct.php : - 58 + 47
    @@ -680,7 +567,7 @@

    AttributeGroupUpdateStruct.php : - 53 + 42
    @@ -758,11 +645,6 @@

    Parameters

    __construct() -
  • -
  • - - getIcon() -
  • @@ -773,11 +655,6 @@

    Parameters

    getLabels() -
  • -
  • - - setIcon() -
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroupInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroupInterface.html index e387c39dce..9facc3c77e 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroupInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-AttributeGroupInterface.html @@ -265,43 +265,6 @@

    -

    - publicgetIcon() - -

    -
    - AttributeGroupInterface.php - : - 17 - -
    -
    - -
    - - - - - - - -
    -
    -
    -
    -
    -
    -
    public getIcon() : string|null
    -
    -
    -
    -
    -
    -

    Return values

    -

    string|null

    - - -

    publicgetId() @@ -513,6 +476,43 @@

    Return values

    array<string|int, string>

    +
    +

    + publicisAiSystem() + +

    +
    + AttributeGroupInterface.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public isAiSystem() : bool
    +
    +
    +
    +
    +
    +

    Return values

    +

    bool

    + +
    @@ -534,11 +534,6 @@

    Return values

    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-SiteContext-Assignment-Assignment.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-BrandContext-Assignment-Assignment.html similarity index 71% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-SiteContext-Assignment-Assignment.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-BrandContext-Assignment-Assignment.html index 5bae7bf9cb..c1a4fac48d 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-SiteContext-Assignment-Assignment.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-BrandContext-Assignment-Assignment.html @@ -224,11 +224,11 @@ >
  • @@ -235,11 +235,11 @@ -

    - SiteContextAttributeValueInterface

    - -
    - SiteContextAttributeValueInterface.php +

    + BrandContextAttributeValueInterface

    + +
    + BrandContextAttributeValueInterface.php : 11 @@ -261,16 +261,16 @@

    - Methods + Methods

    publicgetDefinition() - +

    -
    - SiteContextAttributeValueInterface.php +
    + BrandContextAttributeValueInterface.php : 15 @@ -304,10 +304,10 @@

    Return values

    publicgetId() - +

    -
    - SiteContextAttributeValueInterface.php +
    + BrandContextAttributeValueInterface.php : 13 @@ -341,10 +341,10 @@

    Return values

    publicgetLanguageCode() - +

    -
    - SiteContextAttributeValueInterface.php +
    + BrandContextAttributeValueInterface.php : 17 @@ -378,10 +378,10 @@

    Return values

    publicgetValue() - +

    -
    - SiteContextAttributeValueInterface.php +
    + BrandContextAttributeValueInterface.php : 19 @@ -410,6 +410,43 @@

    +
    +

    + publicisEmpty() + +

    +
    + BrandContextAttributeValueInterface.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public isEmpty() : bool
    +
    +
    +
    +
    +
    +

    Return values

    +

    bool

    + +
    @@ -419,36 +456,41 @@

    -

    - SiteContextInterface

    - -
    - SiteContextInterface.php +

    + BrandContextInterface

    + +
    + BrandContextInterface.php : - 14 + 15
    Interface
    @@ -261,18 +261,18 @@

    - Methods + Methods

    publicgetAttributeValue() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 52 + 57
    @@ -288,7 +288,7 @@

    -
    public getAttributeValue(string $definitionIdentifier[, string|null $languageCode = null ]) : SiteContextAttributeValueInterface|null
    +
    public getAttributeValue(string $definitionIdentifier[, string|null $languageCode = null ]) : BrandContextAttributeValueInterface|null
    @@ -339,21 +339,24 @@

    Parameters

    Return values

    -

    SiteContextAttributeValueInterface|null

    +

    BrandContextAttributeValueInterface|null

    publicgetAttributeValues() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 50 + 55
    +

    Returns all attribute values grouped by definition, with each definition's +fallback-language value (per the prioritized languages the brand context was +loaded with) coming first within its group.

    @@ -366,7 +369,7 @@

    @@ -376,18 +379,18 @@

    Return values

    -

    array<string|int, SiteContextAttributeValueInterface>

    +

    array<int, BrandContextAttributeValueInterface>

    publicgetColor() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 24 + 25
    @@ -419,12 +422,12 @@

    Return values

    publicgetCreatedAt() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 57 + 62
    @@ -456,12 +459,12 @@

    Return values

    publicgetCreatedBy() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 61 + 66
    @@ -477,7 +480,7 @@

    @@ -487,18 +490,18 @@

    Return values

    -

    int

    +

    User|null

    publicgetDescription() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 30 + 31
    @@ -557,12 +560,12 @@

    Return values

    publicgetDescriptions() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 45 + 46
    @@ -594,12 +597,12 @@

    Return values

    publicgetId() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 16 + 17
    @@ -631,12 +634,12 @@

    Return values

    publicgetIdentifier() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 18 + 19
    @@ -668,12 +671,12 @@

    Return values

    publicgetLanguages() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 35 + 36
    @@ -705,12 +708,12 @@

    Return values

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 20 + 21
    @@ -742,12 +745,12 @@

    Return values

    publicgetLogoThumbnail() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 22 + 23
    @@ -779,12 +782,12 @@

    Return values

    publicgetModifiedAt() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 59 + 64
    @@ -816,12 +819,12 @@

    Return values

    publicgetModifiedBy() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 63 + 68
    @@ -837,7 +840,7 @@

    @@ -847,18 +850,18 @@

    Return values

    -

    int

    +

    User|null

    publicgetName() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 28 + 29
    @@ -917,12 +920,12 @@

    Return values

    publicgetNames() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 40 + 41
    @@ -954,12 +957,12 @@

    Return values

    publicgetRegion() - +

    -
    - SiteContextInterface.php +
    + BrandContextInterface.php : - 26 + 27
    @@ -997,99 +1000,99 @@

    Return values

    @@ -442,7 +442,7 @@

    ConfigureMenuEvent.php : - 86 + 88

    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CatalogResolverInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CatalogResolverInterface.html index f4cea16df4..3088e51e3a 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CatalogResolverInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CatalogResolverInterface.html @@ -242,7 +242,7 @@

    CatalogResolverInterface.php : - 29 + 30
    Interface
    @@ -285,7 +285,7 @@

    CatalogResolverInterface.php : - 36 + 37

    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CurrencyServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CurrencyServiceInterface.html index b80e0df2ad..d88f7e3f34 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CurrencyServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-CurrencyServiceInterface.html @@ -242,7 +242,7 @@

    CurrencyServiceInterface.php : - 18 + 21
    Interface
    @@ -288,7 +288,7 @@

    CurrencyServiceInterface.php : - 30 + 33

    @@ -326,7 +326,7 @@

    CurrencyServiceInterface.php : - 23 + 26
    @@ -404,7 +404,7 @@

    CurrencyServiceInterface.php : - 37 + 40
    @@ -446,7 +446,7 @@

    CurrencyServiceInterface.php : - 54 + 57
    @@ -502,7 +502,7 @@

    CurrencyServiceInterface.php : - 66 + 69
    @@ -567,7 +567,7 @@

    CurrencyServiceInterface.php : - 45 + 48
    @@ -659,7 +659,7 @@

    CurrencyServiceInterface.php : - 61 + 64
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-Event-CatalogResolveEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-Event-CatalogResolveEvent.html index cb93bf25e9..95c85eea60 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-Event-CatalogResolveEvent.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-Event-CatalogResolveEvent.html @@ -246,7 +246,7 @@

    CatalogResolveEvent.php : - 53 + 54
    Final
    @@ -331,7 +331,7 @@

    CatalogResolveEvent.php : - 59 + 60
    @@ -407,7 +407,7 @@

    CatalogResolveEvent.php : - 73 + 76
    @@ -444,7 +444,7 @@

    CatalogResolveEvent.php : - 68 + 71
    @@ -519,7 +519,7 @@

    CatalogResolveEvent.php : - 78 + 81
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-RegionServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-RegionServiceInterface.html index 975dcd4969..792f8ef1c2 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-RegionServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-RegionServiceInterface.html @@ -242,7 +242,7 @@

    RegionServiceInterface.php : - 19 + 21
    Interface
    @@ -295,7 +295,7 @@

    RegionServiceInterface.php : - 26 + 28
    @@ -333,7 +333,7 @@

    RegionServiceInterface.php : - 35 + 37
    @@ -389,7 +389,7 @@

    RegionServiceInterface.php : - 47 + 49
    @@ -454,7 +454,7 @@

    RegionServiceInterface.php : - 42 + 44
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-TaxonomyTreeServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-TaxonomyTreeServiceInterface.html index bdc1cebaf1..c6dcb231ca 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-TaxonomyTreeServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Storefront-Repository-TaxonomyTreeServiceInterface.html @@ -242,7 +242,7 @@

    TaxonomyTreeServiceInterface.php : - 13 + 14
    Interface
    @@ -273,7 +273,7 @@

    TaxonomyTreeServiceInterface.php : - 30 + 34
    @@ -357,7 +357,7 @@

    TaxonomyTreeServiceInterface.php : - 22 + 23
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Action-TranslateTextAction.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Action-TranslateTextAction.html index afbbcb7c4a..b295a1c142 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Action-TranslateTextAction.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Action-TranslateTextAction.html @@ -110,7 +110,7 @@
    - +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-ContentDiscoveryQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-ContentDiscoveryQuery.html new file mode 100644 index 0000000000..54fd9a5264 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-ContentDiscoveryQuery.html @@ -0,0 +1,817 @@ + + + + + ContentDiscoveryQuery | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ContentDiscoveryQuery

    + +
    + ContentDiscoveryQuery.php + : + 13 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $contentTypeIdentifier + + +

    +
    + ContentDiscoveryQuery.php + : + 20 + +
    +
    + +
    +

    -
    public getAttributeValues() : array<string|int, SiteContextAttributeValueInterface>
    +
    public getAttributeValues() : array<int, BrandContextAttributeValueInterface>
    -
    public getCreatedBy() : int
    +
    public getCreatedBy() : User|null
    -
    public getModifiedBy() : int
    +
    public getModifiedBy() : User|null
    + + + + + + +
    +
    +
    +
    +
    +
    +
    public string|null $contentTypeIdentifier = null
    +
    +
    +
    + + +
    +

    + public + $limit + + +

    +
    + ContentDiscoveryQuery.php + : + 19 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $limit = 25
    +
    +
    +
    + + +
    +

    + public + $offset + + +

    +
    + ContentDiscoveryQuery.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $offset = 0
    +
    +
    +
    + + +
    +

    + public + $scope + + +

    +
    + ContentDiscoveryQuery.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public ContentDiscoveryScope|null $scope = null
    +
    +
    +
    + + +
    +

    + public + $searchQuery + + +

    +
    + ContentDiscoveryQuery.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string|null $searchQuery = null
    +
    +
    +
    + + +
    +

    + public + $sortBy + + +

    +
    + ContentDiscoveryQuery.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string $sortBy = 'name'
    +
    +
    +
    + + +
    +

    + public + $sortDirection + + +

    +
    + ContentDiscoveryQuery.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string $sortDirection = 'asc'
    +
    +
    +
    + + +
    +

    + public + $targetLanguageCode + + +

    +
    + ContentDiscoveryQuery.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string $targetLanguageCode
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ContentDiscoveryQuery.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(string $targetLanguageCode[, ContentDiscoveryScope|null $scope = null ][, int $offset = 0 ][, int $limit = 25 ][, string|null $contentTypeIdentifier = null ][, string|null $searchQuery = null ][, string $sortBy = 'name' ][, string $sortDirection = 'asc' ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $targetLanguageCode + + string + + - + + - +
    + $scope + + ContentDiscoveryScope|null + + null + + - +
    + $offset + + int + + 0 + + - +
    + $limit + + int + + 25 + + - +
    + $contentTypeIdentifier + + string|null + + null + + - +
    + $searchQuery + + string|null + + null + + - +
    + $sortBy + + string + + 'name' + + - +
    + $sortDirection + + string + + 'asc' + + - +
    + + +
    + +
    + +
    + +
    +
    + +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-ContentDiscoveryServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-ContentDiscoveryServiceInterface.html new file mode 100644 index 0000000000..2522a23d20 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-ContentDiscoveryServiceInterface.html @@ -0,0 +1,384 @@ + + + + + ContentDiscoveryServiceInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ContentDiscoveryServiceInterface

    + +
    + ContentDiscoveryServiceInterface.php + : + 14 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicfindMissingTranslations() + +

    +
    + ContentDiscoveryServiceInterface.php + : + 21 + +
    +
    +

    Returns content items that are missing $targetLanguageCode.

    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public findMissingTranslations(ContentDiscoveryQuery $query) : SearchResult
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + ContentDiscoveryQuery + + - + + - +
    +

    Return values

    +

    SearchResult

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-JobServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-JobServiceInterface.html new file mode 100644 index 0000000000..acfd898f1d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-JobServiceInterface.html @@ -0,0 +1,397 @@ + + + + + JobServiceInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + JobServiceInterface

    + +
    + JobServiceInterface.php + : + 15 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publiccreateBulkTranslationJob() + +

    +
    + JobServiceInterface.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public createBulkTranslationJob(JobCreateStruct $createStruct) : Job
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $createStruct + + JobCreateStruct + + - + + - +
    +

    Return values

    +

    Job

    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-LanguageCoverageQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-LanguageCoverageQuery.html new file mode 100644 index 0000000000..b29c874b9e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-LanguageCoverageQuery.html @@ -0,0 +1,439 @@ + + + + + LanguageCoverageQuery | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + LanguageCoverageQuery

    + +
    + LanguageCoverageQuery.php + : + 11 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $languageCode + + +

    +
    + LanguageCoverageQuery.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string $languageCode = ''
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + LanguageCoverageQuery.php + : + 13 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct([string $languageCode = '' ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $languageCode + + string + + '' + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-ContentDiscoveryScope.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-ContentDiscoveryScope.html new file mode 100644 index 0000000000..d27b0cb615 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-ContentDiscoveryScope.html @@ -0,0 +1,711 @@ + + + + + ContentDiscoveryScope | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ContentDiscoveryScope

    + +
    + ContentDiscoveryScope.php + : + 11 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ContentDiscoveryScope.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct([int|null $sourceContentId = null ][, int|null $sourceLocationId = null ][, string|null $sourceLanguageCode = null ][, array<int, int> $contentIds = [] ][, array<int, int> $locationIds = [] ][, bool $includeSubtree = false ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $sourceContentId + + int|null + + null + + - +
    + $sourceLocationId + + int|null + + null + + - +
    + $sourceLanguageCode + + string|null + + null + + - +
    + $contentIds + + array<int, int> + + [] + + - +
    + $locationIds + + array<int, int> + + [] + + - +
    + $includeSubtree + + bool + + false + + - +
    + + +
    +

    + publicgetContentIds() + +

    +
    + ContentDiscoveryScope.php + : + 44 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getContentIds() : array<int, int>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<int, int>

    + + +
    +

    + publicgetLocationIds() + +

    +
    + ContentDiscoveryScope.php + : + 52 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getLocationIds() : array<int, int>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<int, int>

    + + +
    +

    + publicgetSourceContentId() + +

    +
    + ContentDiscoveryScope.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getSourceContentId() : int|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    int|null

    + + +
    +

    + publicgetSourceLanguageCode() + +

    +
    + ContentDiscoveryScope.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getSourceLanguageCode() : string|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    string|null

    + + +
    +

    + publicgetSourceLocationId() + +

    +
    + ContentDiscoveryScope.php + : + 31 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getSourceLocationId() : int|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    int|null

    + + +
    +

    + publicisIncludeSubtree() + +

    +
    + ContentDiscoveryScope.php + : + 57 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public isIncludeSubtree() : bool
    +
    +
    +
    +
    +
    +

    Return values

    +

    bool

    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-Job.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-Job.html new file mode 100644 index 0000000000..86d5c74629 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-Job.html @@ -0,0 +1,1307 @@ + + + + + Job | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + Job

    + +
    + Job.php + : + 13 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $cancelledAt + + +

    +
    + Job.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public DateTimeImmutable|null $cancelledAt = null
    +
    +
    +
    + + +
    +

    + public + $createdAt + + +

    +
    + Job.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public DateTimeImmutable $createdAt
    +
    +
    +
    + + +
    +

    + public + $creatorId + + +

    +
    + Job.php + : + 25 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $creatorId
    +
    +
    +
    + + +
    +

    + public + $failedItems + + +

    +
    + Job.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $failedItems = 0
    +
    +
    +
    + + +
    +

    + public + $finishedAt + + +

    +
    + Job.php + : + 29 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public DateTimeImmutable|null $finishedAt = null
    +
    +
    +
    + + +
    +

    + public + $id + + +

    +
    + Job.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $id
    +
    +
    +
    + + +
    +

    + public + $payload + + +

    +
    + Job.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public array<string|int, mixed> $payload = []
    +
    +
    +
    + + +
    +

    + public + $processedItems + + +

    +
    + Job.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $processedItems = 0
    +
    +
    +
    + + +
    +

    + public + $reviewItems + + +

    +
    + Job.php + : + 35 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $reviewItems = 0
    +
    +
    +
    + + +
    +

    + public + $scope + + +

    +
    + Job.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public Scope $scope
    +
    +
    +
    + + +
    +

    + public + $startedAt + + +

    +
    + Job.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public DateTimeImmutable|null $startedAt = null
    +
    +
    +
    + + +
    +

    + public + $status + + +

    +
    + Job.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public JobStatus $status
    +
    +
    +
    + + +
    +

    + public + $successfulItems + + +

    +
    + Job.php + : + 33 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $successfulItems = 0
    +
    +
    +
    + + +
    +

    + public + $targetLanguageCodes + + +

    +
    + Job.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public array<string|int, mixed> $targetLanguageCodes
    +
    +
    +
    + + +
    +

    + public + $title + + +

    +
    + Job.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string|null $title
    +
    +
    +
    + + +
    +

    + public + $totalItems + + +

    +
    + Job.php + : + 31 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $totalItems = 0
    +
    +
    +
    + + +
    +

    + public + $updatedAt + + +

    +
    + Job.php + : + 27 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public DateTimeImmutable $updatedAt
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + Job.php + : + 19 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(int $id, string|null $title, JobStatus $status, Scope $scope, array<int, string> $targetLanguageCodes, int $creatorId, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt[, DateTimeImmutable|null $startedAt = null ][, DateTimeImmutable|null $finishedAt = null ][, DateTimeImmutable|null $cancelledAt = null ][, int $totalItems = 0 ][, int $processedItems = 0 ][, int $successfulItems = 0 ][, int $failedItems = 0 ][, int $reviewItems = 0 ][, array<string, mixed> $payload = [] ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $id + + int + + - + + - +
    + $title + + string|null + + - + + - +
    + $status + + JobStatus + + - + + - +
    + $scope + + Scope + + - + + - +
    + $targetLanguageCodes + + array<int, string> + + - + + - +
    + $creatorId + + int + + - + + - +
    + $createdAt + + DateTimeImmutable + + - + + - +
    + $updatedAt + + DateTimeImmutable + + - + + - +
    + $startedAt + + DateTimeImmutable|null + + null + + - +
    + $finishedAt + + DateTimeImmutable|null + + null + + - +
    + $cancelledAt + + DateTimeImmutable|null + + null + + - +
    + $totalItems + + int + + 0 + + - +
    + $processedItems + + int + + 0 + + - +
    + $successfulItems + + int + + 0 + + - +
    + $failedItems + + int + + 0 + + - +
    + $reviewItems + + int + + 0 + + - +
    + $payload + + array<string, mixed> + + [] + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobCreateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobCreateStruct.html new file mode 100644 index 0000000000..0c7a48de7c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobCreateStruct.html @@ -0,0 +1,836 @@ + + + + + JobCreateStruct | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + JobCreateStruct

    + +
    + JobCreateStruct.php + : + 11 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $creatorId + + +

    +
    + JobCreateStruct.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int|null $creatorId = null
    +
    +
    +
    + + +
    +

    + public + $payload + + +

    +
    + JobCreateStruct.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public array<string|int, mixed> $payload = []
    +
    +
    +
    + + +
    +

    + public + $providerIdentifiers + + +

    +
    + JobCreateStruct.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public array<string|int, mixed> $providerIdentifiers = []
    +
    +
    +
    + + +
    +

    + public + $scope + + +

    +
    + JobCreateStruct.php + : + 19 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public Scope $scope
    +
    +
    +
    + + +
    +

    + public + $targetLanguageCodes + + +

    +
    + JobCreateStruct.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public array<string|int, mixed> $targetLanguageCodes
    +
    +
    +
    + + +
    +

    + public + $title + + +

    +
    + JobCreateStruct.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string|null $title = null
    +
    +
    +
    + + +
    +

    + public + $totalItems + + +

    +
    + JobCreateStruct.php + : + 25 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $totalItems = 0
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + JobCreateStruct.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(Scope $scope, array<int, string> $targetLanguageCodes[, int|null $creatorId = null ][, string|null $title = null ][, array<string, string> $providerIdentifiers = [] ][, array<string, mixed> $payload = [] ][, int $totalItems = 0 ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $scope + + Scope + + - + + - +
    + $targetLanguageCodes + + array<int, string> + + - + + - +
    + $creatorId + + int|null + + null + + - +
    + $title + + string|null + + null + + - +
    + $providerIdentifiers + + array<string, string> + + [] + + - +
    + $payload + + array<string, mixed> + + [] + + - +
    + $totalItems + + int + + 0 + + - +
    + + +
    +

    + publicwithCreatorId() + +

    +
    + JobCreateStruct.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public withCreatorId(int $creatorId) : self
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $creatorId + + int + + - + + - +
    +

    Return values

    +

    self

    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobItemStatus.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobItemStatus.html new file mode 100644 index 0000000000..a1ef5dcb8d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobItemStatus.html @@ -0,0 +1,595 @@ + + + + + JobItemStatus | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + JobItemStatus +

    + +
    + JobItemStatus.php + : + 11 + +
    +
    + Enum: string +
    +
    + + + + + + + + + + + +
    +

    + Cases + + +

    +
    +
    +

    + STATUS_PENDING +

    +
    + JobItemStatus.php + : + 13 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_PENDING = 'pending'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_IN_PROGRESS +

    +
    + JobItemStatus.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_IN_PROGRESS = 'in_progress'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_COMPLETED +

    +
    + JobItemStatus.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_COMPLETED = 'completed'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_FAILED +

    +
    + JobItemStatus.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_FAILED = 'failed'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_CANCELLED +

    +
    + JobItemStatus.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_CANCELLED = 'cancelled'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_NOT_CREATED +

    +
    + JobItemStatus.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_NOT_CREATED = 'not_created'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_PUBLISHED +

    +
    + JobItemStatus.php + : + 19 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_PUBLISHED = 'published'
    +
    +
    +
    + + +
    +
    + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobStatus.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobStatus.html new file mode 100644 index 0000000000..c5031d7465 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-JobStatus.html @@ -0,0 +1,517 @@ + + + + + JobStatus | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + JobStatus +

    + +
    + JobStatus.php + : + 11 + +
    +
    + Enum: string +
    +
    + + + + + + + + + + + +
    +

    + Cases + + +

    +
    +
    +

    + STATUS_PENDING +

    +
    + JobStatus.php + : + 13 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_PENDING = 'pending'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_IN_PROGRESS +

    +
    + JobStatus.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_IN_PROGRESS = 'in_progress'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_COMPLETED +

    +
    + JobStatus.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_COMPLETED = 'completed'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_FAILED +

    +
    + JobStatus.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_FAILED = 'failed'
    +
    +
    +
    + + +
    +
    +
    +

    + STATUS_CANCELLED +

    +
    + JobStatus.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    string STATUS_CANCELLED = 'cancelled'
    +
    +
    +
    + + +
    +
    + +
    +
    +
    + +
    + +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Client-ClientInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-Scope.html similarity index 67% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Client-ClientInterface.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-Scope.html index a319eb2329..397985f822 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Client-ClientInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-BulkTranslations-Values-Scope.html @@ -2,7 +2,7 @@ - ClientInterface | PHP API Reference (Ibexa Documentation) + Scope | PHP API Reference (Ibexa Documentation) @@ -216,16 +216,20 @@ > + @@ -234,19 +238,22 @@
    -
    +
    -

    - ClientInterface

    - -
    - ClientInterface.php +

    + Scope

    + +
    + Scope.php : 11
    -
    Interface
    - +
    Read-only
    +
    Final
    + + +
    @@ -261,23 +268,24 @@

    -

    - Methods +

    + Properties

    -
    -

    - publicgetServiceAlias() - +
    +

    + public + $contentIds + +

    -
    - ClientInterface.php +
    + Scope.php : - 25 + 19
    -

    Use as key.

    @@ -290,32 +298,29 @@

    -
    public getServiceAlias() : string
    +
    public array<string|int, mixed> $contentIds = []
    -
    -
    -

    Return values

    -

    string

    - + -
    -

    - publicgetServiceFullName() - +
    +

    + public + $includeSubtree + +

    -
    - ClientInterface.php +
    + Scope.php : - 30 + 21
    -

    Use for Human.

    @@ -328,28 +333,26 @@

    -
    public getServiceFullName() : string
    +
    public bool $includeSubtree = false
    -
    -
    -

    Return values

    -

    string

    - + -
    -

    - publicsetConfiguration() - +
    +

    + public + $locationIds + +

    -
    - ClientInterface.php +
    + Scope.php : - 16 + 20
    @@ -365,53 +368,26 @@

    -
    public setConfiguration(array{array-key, string} $configuration) : void
    +
    public array<string|int, mixed> $locationIds = []

    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    NameTypeDefault valueDescription
    - $configuration - - array{array-key, string} - - - - - - -
    -
    -

    - publicsupportsLanguage() - +
    +

    + public + $sourceLanguageCode + +

    -
    - ClientInterface.php +
    + Scope.php : - 20 + 18
    @@ -427,55 +403,30 @@

    -
    public supportsLanguage(string $languageCode) : bool
    +
    public string|null $sourceLanguageCode = null

    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    NameTypeDefault valueDescription
    - $languageCode - - string - - - - - - -
    -

    Return values

    -

    bool

    - + + + -
    -

    - publictranslate() - +

    + Methods +

    + +
    +

    + public__construct() +

    -
    - ClientInterface.php +
    + Scope.php : - 18 + 17
    @@ -491,7 +442,7 @@

    -
    public translate(string $payload, string|null $from, string $to) : string
    +
    public __construct([string|null $sourceLanguageCode = null ][, array<int, int> $contentIds = [] ][, array<int, int> $locationIds = [] ][, bool $includeSubtree = false ])
    @@ -513,51 +464,63 @@

    Parameters

    - $payload + $sourceLanguageCode - string + string|null - - - - + + null + - - $from + $contentIds - string|null + array<int, int> - - - - + + [] + - - $to + $locationIds - string + array<int, int> + + [] + - + + + + $includeSubtree + + + bool + + + false + - -

    Return values

    -

    string

    - +
    @@ -567,41 +530,50 @@

    Return values

    - +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Exception-ReviewItemLanguageNotFoundException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Exception-ReviewItemLanguageNotFoundException.html new file mode 100644 index 0000000000..5442bb0d72 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Exception-ReviewItemLanguageNotFoundException.html @@ -0,0 +1,394 @@ + + + + + ReviewItemLanguageNotFoundException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ReviewItemLanguageNotFoundException

    + +
    + ReviewItemLanguageNotFoundException.php + : + 14 + +
    +
    Final
    + +
    + Extends RuntimeException +
    + + + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ReviewItemLanguageNotFoundException.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(int $languageId)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $languageId + + int + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-ReviewItemServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-ReviewItemServiceInterface.html new file mode 100644 index 0000000000..966243501b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-ReviewItemServiceInterface.html @@ -0,0 +1,412 @@ + + + + + ReviewItemServiceInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ReviewItemServiceInterface

    + +
    + ReviewItemServiceInterface.php + : + 16 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicfindReviewItems() + +

    +
    + ReviewItemServiceInterface.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public findReviewItems([ReviewItemQuery|null $query = null ]) : ReviewItemList
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + ReviewItemQuery|null + + null + + - +
    +

    Return values

    +

    ReviewItemList

    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException +
    +

    if the query pagination is invalid

    + +
    + +
    +
    + Throws +
    +
    + LogicException +
    +

    if the query contains an unsupported criterion

    + +
    + +
    +
    + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-BulkTranslationContext.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-BulkTranslationContext.html new file mode 100644 index 0000000000..a29165288d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-BulkTranslationContext.html @@ -0,0 +1,659 @@ + + + + + BulkTranslationContext | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + BulkTranslationContext

    + +
    + BulkTranslationContext.php + : + 13 + +
    +
    Read-only
    +
    Final
    + + + +
    + + + + + + + + + + + + + +

    + Properties +

    + +
    +

    + public + $jobCreatorId + + +

    +
    + BulkTranslationContext.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $jobCreatorId
    +
    +
    +
    + + +
    +

    + public + $jobId + + +

    +
    + BulkTranslationContext.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $jobId
    +
    +
    +
    + + +
    +

    + public + $jobItemId + + +

    +
    + BulkTranslationContext.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public int $jobItemId
    +
    +
    +
    + + +
    +

    + public + $jobItemStatus + + +

    +
    + BulkTranslationContext.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public JobItemStatus $jobItemStatus
    +
    +
    +
    + + +
    +

    + public + $jobTitle + + +

    +
    + BulkTranslationContext.php + : + 19 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string|null $jobTitle
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + BulkTranslationContext.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(int $jobItemId, int $jobId, JobItemStatus $jobItemStatus, string|null $jobTitle, int $jobCreatorId)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $jobItemId + + int + + - + + - +
    + $jobId + + int + + - + + - +
    + $jobItemStatus + + JobItemStatus + + - + + - +
    + $jobTitle + + string|null + + - + + - +
    + $jobCreatorId + + int + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ContentTypeCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ContentTypeCriterion.html new file mode 100644 index 0000000000..b266dffc0b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ContentTypeCriterion.html @@ -0,0 +1,1184 @@ + + + + + ContentTypeCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ContentTypeCriterion

    + +
    + ContentTypeCriterion.php + : + 21 + +
    +
    Final
    + +
    + Extends FieldValueCriterion +
    + +
    + Implements + CriterionInterface
    + +
    +

    Matches translations of the given content types. Content type is only known for bulk job items, so individual translations are excluded.

    + + +
    +

    Matching is always by equality: a single value matches it, an array matches any of them. +Comparison operators are not supported, because this criterion targets a sub-select relationship field, +which is always resolved with an IN clause.

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

    + Constants +

    +
    +

    + publicCOMPARISON_CONTAINS +

    +
    + FieldValueCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_CONTAINS = 'CONTAINS'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_ENDS_WITH +

    +
    + FieldValueCriterion.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_ENDS_WITH = 'ENDS_WITH'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_EQ +

    +
    + FieldValueCriterion.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_EQ = '='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GT +

    +
    + FieldValueCriterion.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GT = '>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GTE +

    +
    + FieldValueCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GTE = '>='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_IN +

    +
    + FieldValueCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_IN = 'IN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LT +

    +
    + FieldValueCriterion.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LT = '<'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LTE +

    +
    + FieldValueCriterion.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LTE = '<='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_MEMBER_OF +

    +
    + FieldValueCriterion.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_MEMBER_OF = 'MEMBER_OF'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NEQ +

    +
    + FieldValueCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NEQ = '<>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NIN +

    +
    + FieldValueCriterion.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NIN = 'NIN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_STARTS_WITH +

    +
    + FieldValueCriterion.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_STARTS_WITH = 'STARTS_WITH'
    +
    +
    +
    + + +
    +

    + publicFIELD +

    +
    + ContentTypeCriterion.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string FIELD = 'jobItem.content_type_identifier'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ContentTypeCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(string|array<string|int, string> $value)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + string|array<string|int, string> + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicgetField() + +

    +
    + FieldValueCriterion.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getField() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetOperator() + +

    +
    + FieldValueCriterion.php + : + 68 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOperator() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValue() + +

    +
    + FieldValueCriterion.php + : + 58 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValue() : mixed
    +
    +
    +
    +
    +
    + + +
    +

    + publicsetOperator() + +

    +
    + ContentTypeCriterion.php + : + 42 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOperator(string $operator) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $operator + + string + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicsetValue() + +

    +
    + FieldValueCriterion.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setValue(mixed $value) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + mixed + + - + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-CriterionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-CriterionInterface.html new file mode 100644 index 0000000000..1015c386ea --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-CriterionInterface.html @@ -0,0 +1,309 @@ + + + + + CriterionInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    + +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-JobCreatorCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-JobCreatorCriterion.html new file mode 100644 index 0000000000..df7d209b61 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-JobCreatorCriterion.html @@ -0,0 +1,1186 @@ + + + + + JobCreatorCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + JobCreatorCriterion

    + +
    + JobCreatorCriterion.php + : + 24 + +
    +
    Final
    + +
    + Extends FieldValueCriterion +
    + +
    + Implements + CriterionInterface
    + +
    +

    Matches translations belonging to bulk jobs created by the given user, so individual translations are excluded.

    + + +
    +

    The value is a creator ID; the persistence mapper resolves it into the IDs of that user's jobs, because +core-persistence does not expand a two-level relationship path such as jobItem.job.creator_id.

    +

    Matching is always by equality: a single value matches it, an array matches any of them. +Comparison operators are not supported, because this criterion targets a sub-select relationship field, +which is always resolved with an IN clause.

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

    + Constants +

    +
    +

    + publicCOMPARISON_CONTAINS +

    +
    + FieldValueCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_CONTAINS = 'CONTAINS'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_ENDS_WITH +

    +
    + FieldValueCriterion.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_ENDS_WITH = 'ENDS_WITH'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_EQ +

    +
    + FieldValueCriterion.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_EQ = '='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GT +

    +
    + FieldValueCriterion.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GT = '>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GTE +

    +
    + FieldValueCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GTE = '>='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_IN +

    +
    + FieldValueCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_IN = 'IN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LT +

    +
    + FieldValueCriterion.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LT = '<'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LTE +

    +
    + FieldValueCriterion.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LTE = '<='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_MEMBER_OF +

    +
    + FieldValueCriterion.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_MEMBER_OF = 'MEMBER_OF'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NEQ +

    +
    + FieldValueCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NEQ = '<>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NIN +

    +
    + FieldValueCriterion.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NIN = 'NIN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_STARTS_WITH +

    +
    + FieldValueCriterion.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_STARTS_WITH = 'STARTS_WITH'
    +
    +
    +
    + + +
    +

    + publicFIELD +

    +
    + JobCreatorCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string FIELD = 'jobItem.job_id'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + JobCreatorCriterion.php + : + 33 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(int|array<string|int, int> $value)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + int|array<string|int, int> + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicgetField() + +

    +
    + FieldValueCriterion.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getField() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetOperator() + +

    +
    + FieldValueCriterion.php + : + 68 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOperator() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValue() + +

    +
    + FieldValueCriterion.php + : + 58 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValue() : mixed
    +
    +
    +
    +
    +
    + + +
    +

    + publicsetOperator() + +

    +
    + JobCreatorCriterion.php + : + 45 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOperator(string $operator) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $operator + + string + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicsetValue() + +

    +
    + FieldValueCriterion.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setValue(mixed $value) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + mixed + + - + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-JobIdCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-JobIdCriterion.html new file mode 100644 index 0000000000..ea05711034 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-JobIdCriterion.html @@ -0,0 +1,1184 @@ + + + + + JobIdCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + JobIdCriterion

    + +
    + JobIdCriterion.php + : + 21 + +
    +
    Final
    + +
    + Extends FieldValueCriterion +
    + +
    + Implements + CriterionInterface
    + +
    +

    Matches translations belonging to the given bulk translation job, so individual translations are excluded.

    + + +
    +

    Matching is always by equality: a single value matches it, an array matches any of them. +Comparison operators are not supported, because this criterion targets a sub-select relationship field, +which is always resolved with an IN clause.

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

    + Constants +

    +
    +

    + publicCOMPARISON_CONTAINS +

    +
    + FieldValueCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_CONTAINS = 'CONTAINS'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_ENDS_WITH +

    +
    + FieldValueCriterion.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_ENDS_WITH = 'ENDS_WITH'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_EQ +

    +
    + FieldValueCriterion.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_EQ = '='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GT +

    +
    + FieldValueCriterion.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GT = '>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GTE +

    +
    + FieldValueCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GTE = '>='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_IN +

    +
    + FieldValueCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_IN = 'IN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LT +

    +
    + FieldValueCriterion.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LT = '<'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LTE +

    +
    + FieldValueCriterion.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LTE = '<='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_MEMBER_OF +

    +
    + FieldValueCriterion.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_MEMBER_OF = 'MEMBER_OF'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NEQ +

    +
    + FieldValueCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NEQ = '<>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NIN +

    +
    + FieldValueCriterion.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NIN = 'NIN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_STARTS_WITH +

    +
    + FieldValueCriterion.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_STARTS_WITH = 'STARTS_WITH'
    +
    +
    +
    + + +
    +

    + publicFIELD +

    +
    + JobIdCriterion.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string FIELD = 'jobItem.job_id'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + JobIdCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(int|array<string|int, int> $value)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + int|array<string|int, int> + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicgetField() + +

    +
    + FieldValueCriterion.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getField() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetOperator() + +

    +
    + FieldValueCriterion.php + : + 68 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOperator() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValue() + +

    +
    + FieldValueCriterion.php + : + 58 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValue() : mixed
    +
    +
    +
    +
    +
    + + +
    +

    + publicsetOperator() + +

    +
    + JobIdCriterion.php + : + 42 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOperator(string $operator) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $operator + + string + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicsetValue() + +

    +
    + FieldValueCriterion.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setValue(mixed $value) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + mixed + + - + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-LogicalAnd.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-LogicalAnd.html new file mode 100644 index 0000000000..6c69852d40 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-LogicalAnd.html @@ -0,0 +1,655 @@ + + + + + LogicalAnd | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + LogicalAnd

    + +
    + LogicalAnd.php + : + 15 + +
    +
    Final
    + +
    + Extends LogicalAnd +
    + +
    + Implements + CriterionInterface
    + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + LogicalAnd.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(CriterionInterface ...$criteria)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicadd() + +

    +
    + AbstractCompositeCriterion.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public add(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicgetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 47 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public final getCriteria() : array<string|int, CriterionInterface>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, CriterionInterface>

    + + +
    +

    + publicremove() + +

    +
    + AbstractCompositeCriterion.php + : + 29 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public remove(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicsetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 39 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setCriteria(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-LogicalOr.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-LogicalOr.html new file mode 100644 index 0000000000..1badea5709 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-LogicalOr.html @@ -0,0 +1,655 @@ + + + + + LogicalOr | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + LogicalOr

    + +
    + LogicalOr.php + : + 15 + +
    +
    Final
    + +
    + Extends LogicalOr +
    + +
    + Implements + CriterionInterface
    + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + LogicalOr.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(CriterionInterface ...$criteria)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicadd() + +

    +
    + AbstractCompositeCriterion.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public add(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicgetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 47 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public final getCriteria() : array<string|int, CriterionInterface>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, CriterionInterface>

    + + +
    +

    + publicremove() + +

    +
    + AbstractCompositeCriterion.php + : + 29 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public remove(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +

    + publicsetCriteria() + +

    +
    + AbstractCompositeCriterion.php + : + 39 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setCriteria(CriterionInterface ...$criteria) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $criteria + + CriterionInterface + + - + + - +
    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ProviderCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ProviderCriterion.html new file mode 100644 index 0000000000..0e9a29a85d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ProviderCriterion.html @@ -0,0 +1,1177 @@ + + + + + ProviderCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ProviderCriterion

    + +
    + ProviderCriterion.php + : + 14 + +
    +
    Final
    + +
    + Extends FieldValueCriterion +
    + +
    + Implements + CriterionInterface
    + +
    + + + + + + + + + + + + +

    + Constants +

    +
    +

    + publicCOMPARISON_CONTAINS +

    +
    + FieldValueCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_CONTAINS = 'CONTAINS'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_ENDS_WITH +

    +
    + FieldValueCriterion.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_ENDS_WITH = 'ENDS_WITH'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_EQ +

    +
    + FieldValueCriterion.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_EQ = '='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GT +

    +
    + FieldValueCriterion.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GT = '>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GTE +

    +
    + FieldValueCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GTE = '>='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_IN +

    +
    + FieldValueCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_IN = 'IN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LT +

    +
    + FieldValueCriterion.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LT = '<'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LTE +

    +
    + FieldValueCriterion.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LTE = '<='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_MEMBER_OF +

    +
    + FieldValueCriterion.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_MEMBER_OF = 'MEMBER_OF'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NEQ +

    +
    + FieldValueCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NEQ = '<>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NIN +

    +
    + FieldValueCriterion.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NIN = 'NIN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_STARTS_WITH +

    +
    + FieldValueCriterion.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_STARTS_WITH = 'STARTS_WITH'
    +
    +
    +
    + + +
    +

    + publicFIELD +

    +
    + ProviderCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string FIELD = 'provider_identifier'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ProviderCriterion.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(string|array<string|int, string> $value[, string|null $operator = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + string|array<string|int, string> + + - + + - +
    + $operator + + string|null + + null + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicgetField() + +

    +
    + FieldValueCriterion.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getField() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetOperator() + +

    +
    + FieldValueCriterion.php + : + 68 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOperator() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValue() + +

    +
    + FieldValueCriterion.php + : + 58 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValue() : mixed
    +
    +
    +
    +
    +
    + + +
    +

    + publicsetOperator() + +

    +
    + FieldValueCriterion.php + : + 63 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOperator(string $operator) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $operator + + string + + - + + - +
    + + +
    +

    + publicsetValue() + +

    +
    + FieldValueCriterion.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setValue(mixed $value) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + mixed + + - + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ReviewStatusCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ReviewStatusCriterion.html new file mode 100644 index 0000000000..bc4b652cca --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-ReviewStatusCriterion.html @@ -0,0 +1,1177 @@ + + + + + ReviewStatusCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ReviewStatusCriterion

    + +
    + ReviewStatusCriterion.php + : + 15 + +
    +
    Final
    + +
    + Extends FieldValueCriterion +
    + +
    + Implements + CriterionInterface
    + +
    + + + + + + + + + + + + +

    + Constants +

    +
    +

    + publicCOMPARISON_CONTAINS +

    +
    + FieldValueCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_CONTAINS = 'CONTAINS'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_ENDS_WITH +

    +
    + FieldValueCriterion.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_ENDS_WITH = 'ENDS_WITH'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_EQ +

    +
    + FieldValueCriterion.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_EQ = '='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GT +

    +
    + FieldValueCriterion.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GT = '>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GTE +

    +
    + FieldValueCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GTE = '>='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_IN +

    +
    + FieldValueCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_IN = 'IN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LT +

    +
    + FieldValueCriterion.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LT = '<'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LTE +

    +
    + FieldValueCriterion.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LTE = '<='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_MEMBER_OF +

    +
    + FieldValueCriterion.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_MEMBER_OF = 'MEMBER_OF'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NEQ +

    +
    + FieldValueCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NEQ = '<>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NIN +

    +
    + FieldValueCriterion.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NIN = 'NIN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_STARTS_WITH +

    +
    + FieldValueCriterion.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_STARTS_WITH = 'STARTS_WITH'
    +
    +
    +
    + + +
    +

    + publicFIELD +

    +
    + ReviewStatusCriterion.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string FIELD = 'review_status'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ReviewStatusCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(AutoTranslationReviewStatus|array<string|int, AutoTranslationReviewStatus$value[, string|null $operator = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + AutoTranslationReviewStatus|array<string|int, AutoTranslationReviewStatus> + + - + + - +
    + $operator + + string|null + + null + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicgetField() + +

    +
    + FieldValueCriterion.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getField() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetOperator() + +

    +
    + FieldValueCriterion.php + : + 68 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOperator() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValue() + +

    +
    + FieldValueCriterion.php + : + 58 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValue() : mixed
    +
    +
    +
    +
    +
    + + +
    +

    + publicsetOperator() + +

    +
    + FieldValueCriterion.php + : + 63 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOperator(string $operator) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $operator + + string + + - + + - +
    + + +
    +

    + publicsetValue() + +

    +
    + FieldValueCriterion.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setValue(mixed $value) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + mixed + + - + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-TargetLanguageCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-TargetLanguageCriterion.html new file mode 100644 index 0000000000..ee3315af5d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Criterion-TargetLanguageCriterion.html @@ -0,0 +1,1181 @@ + + + + + TargetLanguageCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + + +
    + +
    + + + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + TargetLanguageCriterion

    + +
    + TargetLanguageCriterion.php + : + 14 + +
    +
    Final
    + +
    + Extends FieldValueCriterion +
    + +
    + Implements + CriterionInterface
    + +
    + + + + + + + + + + + + +

    + Constants +

    +
    +

    + publicCOMPARISON_CONTAINS +

    +
    + FieldValueCriterion.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_CONTAINS = 'CONTAINS'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_ENDS_WITH +

    +
    + FieldValueCriterion.php + : + 36 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_ENDS_WITH = 'ENDS_WITH'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_EQ +

    +
    + FieldValueCriterion.php + : + 14 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_EQ = '='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GT +

    +
    + FieldValueCriterion.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GT = '>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_GTE +

    +
    + FieldValueCriterion.php + : + 24 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_GTE = '>='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_IN +

    +
    + FieldValueCriterion.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_IN = 'IN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LT +

    +
    + FieldValueCriterion.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LT = '<'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_LTE +

    +
    + FieldValueCriterion.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_LTE = '<='
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_MEMBER_OF +

    +
    + FieldValueCriterion.php + : + 32 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_MEMBER_OF = 'MEMBER_OF'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NEQ +

    +
    + FieldValueCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NEQ = '<>'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_NIN +

    +
    + FieldValueCriterion.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_NIN = 'NIN'
    +
    +
    +
    + + +
    +

    + publicCOMPARISON_STARTS_WITH +

    +
    + FieldValueCriterion.php + : + 34 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string COMPARISON_STARTS_WITH = 'STARTS_WITH'
    +
    +
    +
    + + +
    +

    + publicFIELD +

    +
    + TargetLanguageCriterion.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public string FIELD = 'target_language_id'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + TargetLanguageCriterion.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(string|array<string|int, string> $value[, string|null $operator = null ])
    +
    +
    +
    +
    +
    +

    Parameters

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

    language code(s), resolved to language IDs by the persistence mapper

    + +
    + +
    + $operator + + string|null + + null + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + InvalidArgumentException + +
    +
    + +
    +

    + publicgetField() + +

    +
    + FieldValueCriterion.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getField() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetOperator() + +

    +
    + FieldValueCriterion.php + : + 68 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOperator() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetValue() + +

    +
    + FieldValueCriterion.php + : + 58 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getValue() : mixed
    +
    +
    +
    +
    +
    + + +
    +

    + publicsetOperator() + +

    +
    + FieldValueCriterion.php + : + 63 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setOperator(string $operator) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $operator + + string + + - + + - +
    + + +
    +

    + publicsetValue() + +

    +
    + FieldValueCriterion.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public setValue(mixed $value) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $value + + mixed + + - + + - +
    + + +
    +
    +
    + + +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-SiteContext-Assignment-AssignmentType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Origin.html similarity index 82% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-SiteContext-Assignment-AssignmentType.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Origin.html index 03a68ba72f..e24475e498 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-SiteContext-Values-SiteContext-Assignment-AssignmentType.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-Origin.html @@ -2,7 +2,7 @@ - AssignmentType | PHP API Reference (Ibexa Documentation) + Origin | PHP API Reference (Ibexa Documentation) @@ -216,24 +216,20 @@ > - @@ -242,13 +238,14 @@
    -
    -

    - AssignmentType +
    +

    +

    + Origin

    - -
    - AssignmentType.php + +
    + Origin.php : 11 @@ -271,16 +268,16 @@

    Cases - +

    -

    - SITE_ACCESS +

    + BULK

    -
    - AssignmentType.php +
    + Origin.php : 13 @@ -298,7 +295,7 @@

    -
    string SITE_ACCESS = 'site_access'
    +
    string BULK = 'bulk'
    @@ -310,11 +307,11 @@

    -

    - SITE_ACCESS_GROUP +

    + INDIVIDUAL

    -
    - AssignmentType.php +
    + Origin.php : 14 @@ -332,7 +329,7 @@

    -
    string SITE_ACCESS_GROUP = 'site_access_group'
    +
    string INDIVIDUAL = 'individual'
    @@ -353,25 +350,25 @@

    + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ReviewItem.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public __construct(int $autoTranslationId, int $contentId, int $versionNo, string $sourceLanguageCode, string $targetLanguageCode, string $providerIdentifier, AutoTranslationReviewStatus $reviewStatus[, BulkTranslationContext|null $bulkContext = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $autoTranslationId + + int + + - + + - +
    + $contentId + + int + + - + + - +
    + $versionNo + + int + + - + + - +
    + $sourceLanguageCode + + string + + - + + - +
    + $targetLanguageCode + + string + + - + + - +
    + $providerIdentifier + + string + + - + + - +
    + $reviewStatus + + AutoTranslationReviewStatus + + - + + - +
    + $bulkContext + + BulkTranslationContext|null + + null + + - +
    + + +
    +

    + publicgetOrigin() + +

    +
    + ReviewItem.php + : + 26 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +
    +
    +
    public getOrigin() : Origin
    +
    +
    +
    +
    +
    +

    Return values

    +

    Origin

    + + +
    + +
    + + +
    + +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Encoder-Field-FieldEncoderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-ReviewItemList.html similarity index 64% rename from docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Encoder-Field-FieldEncoderInterface.html rename to docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-ReviewItemList.html index bcdaf2866d..1b889da911 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-AutomatedTranslation-Encoder-Field-FieldEncoderInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-ReviewQueue-Values-ReviewItemList.html @@ -2,7 +2,7 @@ - FieldEncoderInterface | PHP API Reference (Ibexa Documentation) + ReviewItemList | PHP API Reference (Ibexa Documentation) @@ -216,20 +216,20 @@ > @@ -238,19 +238,25 @@
    -
    +
    -

    - FieldEncoderInterface

    - -
    - FieldEncoderInterface.php +

    + ReviewItemList

    + +
    + ReviewItemList.php : - 14 + 17
    -
    Interface
    - +
    Read-only
    +
    Final
    + + +
    + Implements + Countable, IteratorAggregate
    +
    @@ -265,19 +271,21 @@

    -

    - Methods +

    + Properties

    -
    -

    - publiccanDecode() - +
    +

    + public + $items + +

    -
    - FieldEncoderInterface.php +
    + ReviewItemList.php : - 18 + 21
    @@ -293,55 +301,26 @@

    -
    public canDecode(string $type) : bool
    +
    public array<string|int, mixed> $items = []

    -
    -
    -

    Parameters

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

    Return values

    -

    bool

    - + -
    -

    - publiccanEncode() - +
    +

    + public + $totalCount + +

    -
    - FieldEncoderInterface.php +
    + ReviewItemList.php : - 16 + 22
    @@ -357,55 +336,30 @@

    -
    public canEncode(Field $field) : bool
    +
    public int $totalCount = 0

    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    NameTypeDefault valueDescription
    - $field - - Field - - - - - - -
    -

    Return values

    -

    bool

    - + -
    -

    - publicdecode() - + + +

    + Methods +

    + +
    +

    + public__construct() +

    -
    - FieldEncoderInterface.php +
    + ReviewItemList.php : - 25 + 20
    @@ -421,7 +375,7 @@

    -
    public decode(string $value, mixed $previousFieldValue) : Value
    +
    public __construct([array<int, ReviewItem$items = [] ][, int $totalCount = 0 ])
    @@ -443,47 +397,45 @@

    Parameters

    - $value + $items - string + array<int, ReviewItem> - - - - + + [] + - - $previousFieldValue + $totalCount - mixed + int - - - - + + 0 + - -

    Return values

    -

    Value

    - +
    -

    - publicencode() - +

    + publiccount() +

    -
    - FieldEncoderInterface.php +
    + ReviewItemList.php : - 20 + 31
    @@ -499,7 +451,7 @@

    -
    public encode(Field $field) : string
    +
    public count() : int
    @@ -508,35 +460,45 @@

    -

    Parameters

    - - +

    Return values

    +

    int

    + + +
    +

    + publicgetIterator() + +

    +
    + ReviewItemList.php + : + 26 + +
    +
    + +
    +
    + - - - - + + - - - - - - - - - +
    NameTypeDefault valueDescription +
    +
    +
    +
    +
    +
    public getIterator() : Traversable<int, ReviewItem>
    +
    +
    - $field - - Field - - - - - - -
    +
    +
    +

    Return values

    -

    string

    +

    Traversable<int, ReviewItem>

    @@ -547,36 +509,50 @@

    Return values

    - +
    diff --git a/docs/api/php_api/php_api_reference/index.html b/docs/api/php_api/php_api_reference/index.html index 54f16951a0..6e18bbeb09 100644 --- a/docs/api/php_api/php_api_reference/index.html +++ b/docs/api/php_api/php_api_reference/index.html @@ -1766,193 +1766,6 @@
  • - AutomatedTranslation - - - -
  • - - -
  • - -
  • - Interfaces, classes, traits, and enums + Interfaces, classes, traits, and enums

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-automatedtranslation-encoder.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-fieldtypepage-pagestructure.html similarity index 94% rename from docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-automatedtranslation-encoder.html rename to docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-fieldtypepage-pagestructure.html index 8c76de9175..acd564873f 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-automatedtranslation-encoder.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-fieldtypepage-pagestructure.html @@ -2,7 +2,7 @@ - Encoder | PHP API Reference (Ibexa Documentation) + PageStructure | PHP API Reference (Ibexa Documentation) @@ -214,12 +214,12 @@ > @@ -227,33 +227,26 @@
    - -
    -
    + +
    +
    +

    - Encoder + PageStructure

    - +

    - Namespaces + Namespaces

    @@ -231,27 +231,26 @@
    - -
    -
    + +

    - Field + OptionsFormMapper

    - +

    - Interfaces, classes, traits, and enums + Interfaces, classes, traits, and enums

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-automatedtranslation-encoder-blockattribute.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute-optionsvalidator.html similarity index 93% rename from docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-automatedtranslation-encoder-blockattribute.html rename to docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute-optionsvalidator.html index f0aa6e2f93..2f3cee01ff 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-automatedtranslation-encoder-blockattribute.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute-optionsvalidator.html @@ -2,7 +2,7 @@ - BlockAttribute | PHP API Reference (Ibexa Documentation) + OptionsValidator | PHP API Reference (Ibexa Documentation) @@ -214,16 +214,16 @@ > @@ -231,27 +231,33 @@
    - -
    -
    + +

    - BlockAttribute + OptionsValidator

    - +
    - +

    - Interfaces, classes, traits, and enums + Interfaces, classes, traits, and enums

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute.html index 89ae7b1a22..ea8744e3ca 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-attribute.html @@ -227,7 +227,7 @@
    - +

    Attribute @@ -247,6 +247,22 @@

    FormTypeMapper + +
  • + + + + OptionsFormMapper + + +
  • +
  • + + + + OptionsValidator + +
  • diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-event.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-event.html index a709a786f6..356e9dc143 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-event.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-event.html @@ -227,7 +227,7 @@
    - +

    Event @@ -243,6 +243,13 @@

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-values-sitecontext-query-criterion.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-values-brandcontext-query-criterion.html similarity index 96% rename from docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-values-sitecontext-query-criterion.html rename to docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-values-brandcontext-query-criterion.html index ce74c22555..3fa1003d85 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-values-sitecontext-query-criterion.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-sitecontext-values-brandcontext-query-criterion.html @@ -222,11 +222,11 @@ >

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-event.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-event.html index 8023a6078b..f3be052d48 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-event.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-event.html @@ -108,7 +108,7 @@
    - +
    @@ -231,7 +231,7 @@
    - +

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-exception.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-exception.html index a46e205b98..982fca2d8b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-exception.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-exception.html @@ -108,7 +108,7 @@

    - +
    @@ -231,7 +231,7 @@
    - +

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-service.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-service.html index b77d431535..4d99d1f199 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-service.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-service.html @@ -108,7 +108,7 @@

    - +
    @@ -231,7 +231,7 @@
    - +

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values-content.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values-content.html index 07e72b54c2..fdbe64189e 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values-content.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values-content.html @@ -108,7 +108,7 @@

    - +
    @@ -235,7 +235,7 @@
    - +

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values.html index 0ca0b4102e..228f298bd7 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside-values.html @@ -108,7 +108,7 @@

    - +
    @@ -231,7 +231,7 @@
    - +

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside.html index feab2ead7a..630c445a94 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement-sidebyside.html @@ -108,7 +108,7 @@

    - +
    @@ -227,7 +227,7 @@
    - +

    diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement.html index 1be1af2f3e..c46ab98958 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-translationsmanagement.html @@ -108,7 +108,7 @@

    - +
    @@ -223,7 +223,7 @@
    - +

    @@ -244,6 +244,14 @@

    AutoTranslate + +
  • + + + + BulkTranslations + +
  • @@ -252,6 +260,14 @@

    Exception +

  • +
  • + + + + ReviewQueue + +
  • diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-attribute.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-attribute.html index db51dbdc46..d60f812b7f 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-attribute.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-attribute.html @@ -227,7 +227,7 @@
    - +

    Attribute diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-event.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-event.html index fd43522f48..40d99ba99e 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-event.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-event.html @@ -227,7 +227,7 @@
    - +

    Event diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-exception.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-exception.html index 657609ab20..cd11785e13 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-exception.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-exception.html @@ -227,7 +227,7 @@
    - +

    Exception diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-renderer.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-renderer.html index eddd196fd2..9960b22603 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-renderer.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents-renderer.html @@ -227,7 +227,7 @@
    - +

    Renderer diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents.html index 095ee34a5c..c52edd234a 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-twigcomponents.html @@ -223,7 +223,7 @@
    - +

    TwigComponents diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-controller.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-controller.html index f67e3db7bd..c5a7e48e4a 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-controller.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-controller.html @@ -227,7 +227,7 @@
    - +

    Controller diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-exception.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-exception.html index 525e8d93bb..818d4e3f7e 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-exception.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-exception.html @@ -231,7 +231,7 @@
    - +

    Exception diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-persistence.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-persistence.html index 7604d45667..bfb908a78b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-persistence.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-persistence.html @@ -231,7 +231,7 @@
    - +

    Persistence diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-query.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-query.html index e4da460925..25b41aa517 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-query.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation-query.html @@ -231,7 +231,7 @@
    - +

    Query diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation.html index 0d915a21fe..df8adbf10b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-invitation.html @@ -227,7 +227,7 @@
    - +

    Invitation diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-notification.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-notification.html index 07fa45a844..6c05aa541e 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-notification.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-notification.html @@ -227,7 +227,7 @@
    - +

    Notification diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-passwordreset.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-passwordreset.html index 6d5ce3f749..ec70bdd126 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-passwordreset.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-passwordreset.html @@ -227,7 +227,7 @@
    - +

    PasswordReset diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-usersetting.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-usersetting.html index d3182f087b..898765133c 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-usersetting.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user-usersetting.html @@ -227,7 +227,7 @@
    - +

    UserSetting diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user.html index 0ea36f6e43..6d49acea6b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-user.html @@ -223,7 +223,7 @@
    - +

    User diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-engine.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-engine.html index 92c68b0e87..6d60a3aa3d 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-engine.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-engine.html @@ -227,7 +227,7 @@
    - +

    Engine diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-fieldtype.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-fieldtype.html index cb2f6f547d..737a5a2052 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-fieldtype.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-fieldtype.html @@ -227,7 +227,7 @@
    - +

    FieldType diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-result.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-result.html index 147ce8790a..756bb42dd5 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-result.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-result.html @@ -227,7 +227,7 @@
    - +

    Result diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-service.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-service.html index e49b00048f..23181edfe2 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-service.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison-service.html @@ -227,7 +227,7 @@
    - +

    Service diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison.html index 8ab184b47d..a605dd838f 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-versioncomparison.html @@ -223,7 +223,7 @@
    - +

    VersionComparison diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event-action.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event-action.html index 1b44cd0d16..c13bfe504b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event-action.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event-action.html @@ -231,7 +231,7 @@
    - +

    Action diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event.html index c936655e03..5ba1b8330c 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-event.html @@ -227,7 +227,7 @@
    - +

    Event diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory-workflowdefinitionmetadata.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory-workflowdefinitionmetadata.html index 59a2a705e5..7395b08666 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory-workflowdefinitionmetadata.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory-workflowdefinitionmetadata.html @@ -231,7 +231,7 @@
    - +

    WorkflowDefinitionMetadata diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory.html index 6a4066f603..47cd8a804b 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-factory.html @@ -227,7 +227,7 @@
    - +

    Factory diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence-handler.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence-handler.html index 78c78bbbac..d6bbd32183 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence-handler.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence-handler.html @@ -231,7 +231,7 @@
    - +

    Handler diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence.html index c830b8f000..51362bf188 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-persistence.html @@ -227,7 +227,7 @@
    - +

    Persistence diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-provider.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-provider.html index bae884c399..1b131aff04 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-provider.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-provider.html @@ -227,7 +227,7 @@
    - +

    Provider diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-registry.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-registry.html index 3061f4ad43..394d7b2024 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-registry.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-registry.html @@ -227,7 +227,7 @@
    - +

    Registry diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-service.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-service.html index 6dce0224fe..681d9b5941 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-service.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-service.html @@ -227,7 +227,7 @@
    - +

    Service diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy-matcher.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy-matcher.html index 12f7fd6d2e..bb420cec50 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy-matcher.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy-matcher.html @@ -231,7 +231,7 @@
    - +

    Matcher diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy.html index 8f1032157f..2bf91c8a9a 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow-supportstrategy.html @@ -227,7 +227,7 @@
    - +

    SupportStrategy diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow.html index 5332bef727..e50bcd718f 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-workflow.html @@ -223,7 +223,7 @@
    - +

    Workflow diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts.html index b0ea27fcf5..32c70d8ec3 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts.html @@ -219,7 +219,7 @@
    - +

    Contracts @@ -247,14 +247,6 @@

    AdminUi -

  • -
  • - - - - AutomatedTranslation - -
  • diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa.html b/docs/api/php_api/php_api_reference/namespaces/ibexa.html index 9d473c790f..754c623b82 100644 --- a/docs/api/php_api/php_api_reference/namespaces/ibexa.html +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa.html @@ -215,7 +215,7 @@
    - +

    Ibexa diff --git a/docs/api/php_api/php_api_reference/reports/deprecated.html b/docs/api/php_api/php_api_reference/reports/deprecated.html index a9cc0b844b..b31c187912 100644 --- a/docs/api/php_api/php_api_reference/reports/deprecated.html +++ b/docs/api/php_api/php_api_reference/reports/deprecated.html @@ -1767,193 +1767,6 @@
  • - -
  • - - -
  • - -
  • Page

    Page structure

    Lists the layouts and blocks available for building Pages, with the zones of every layout and the views and attributes of every block.

    +
    query Parameters
    contentTypeIdentifier
    string
    Example: contentTypeIdentifier=landing_page

    Identifier of a content type holding a Page. When given, only the layouts and blocks allowed for that content type are returned. When omitted or empty, the whole catalogue is returned.

    +

    Responses

    Response samples

    Content type
    {
    • "PageStructure": {
      }
    }

    Segmentation

    List all segments grouped by segment group ExperienceCommerce

    Lists all segments grouped by their segment groups.

    +
    query Parameters
    groups[]
    Array of strings

    Segment group identifiers to filter by.

    +
    sources[]
    Array of strings

    Segment sources to filter by.

    +
    search
    string

    Case-insensitive phrase matched against segment name/identifier and segment group name. A group name match keeps all segments of that group.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "totalCount": 3,
    • "filters": {
      },
    • "groups": [
      ]
    }

    List segment groups ExperienceCommerce

    Lists segment groups.

    Responses

    Response samples

    Content type
    {
    • "SegmentGroupList": {
      }
    }

    Load segment group ExperienceCommerce

    /api/ibexa/v2/segment_groups

    Response samples

    Content type
    {
    • "SegmentGroupList": {
      }
    }
  • Load segment group ExperienceCommerce

    Loads segment group.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "SegmentGroup": {
      }
    }

    List segment group's segments ExperienceCommerce

    /api/ibexa/v2/segment_groups/{identifier}

    Response samples

    Content type
    {
    • "SegmentGroup": {
      }
    }

    List segment group's segments ExperienceCommerce

    Lists segment group's segments.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "SegmentList": {
      }
    }

    Load segment ExperienceCommerce

    /api/ibexa/v2/segment_groups/{identifier}/segments

    Response samples

    Content type
    {
    • "SegmentList": {
      }
    }

    Load segment ExperienceCommerce

    Loads the identified segment.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Segment": {
      }
    }

    Corporate Account

    Root Resource ExperienceCommerce

    /api/ibexa/v2/segments/{identifier}

    Response samples

    Content type
    {
    • "Segment": {
      }
    }

    Corporate Account

    Root Resource ExperienceCommerce

    Provides basic information about Corporate Account endpoints and configuration.

    Responses

    Response samples

    Content type
    {
    • "CorporateAccountRoot": {
      }
    }

    Read list of companies ExperienceCommerce

    /api/ibexa/v2/corporate

    Response samples

    Content type
    {
    • "CorporateAccountRoot": {
      }
    }

    Read list of companies ExperienceCommerce

    Returns paginated list of available companies.

    Responses

    Response samples

    Content type
    {
    • "CompanyList": {
      }
    }

    Create a company ExperienceCommerce

    /api/ibexa/v2/corporate/companies

    Response samples

    Content type
    {
    • "CompanyList": {
      }
    }

    Create a company ExperienceCommerce

    Creates a CompanyCreateController resource.

    header Parameters
    X-CSRF-Token
    required
    string

    Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

    @@ -3534,7 +3560,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the user is not authorized to create this Company.

    Request samples

    Content type
    {
    • "CompanyCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Get company ExperienceCommerce

    /api/ibexa/v2/corporate/companies

    Request samples

    Content type
    {
    • "CompanyCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Get company ExperienceCommerce

    Returns the company by given company ID.

    path Parameters
    companyId
    required
    string
    header Parameters
    If-None-match
    string

    ETag

    @@ -3546,7 +3572,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The company does not exist.

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Delete company ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Delete company ExperienceCommerce

    The given company is deleted.

    path Parameters
    companyId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

    @@ -3576,7 +3602,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the user is not authorized to create this company.

    Request samples

    Content type
    {
    • "CompanyUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Read list of company members ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}

    Request samples

    Content type
    {
    • "CompanyUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Company": {
      }
    }

    Read list of company members ExperienceCommerce

    Returns paginated list of a given company members.

    path Parameters
    companyId
    required
    string
    query Parameters
    filter[DateMetadataCriterion][Target]
    string
    Enum: "created" "modified" "published"
    filter[DateMetadataCriterion][Operator]
    string
    Enum: "eq" "gt" "gte" "lt" "lte"
    filter[DateMetadataCriterion][Value]
    integer

    DateTime as a UNIX timestamp

    @@ -3588,7 +3614,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The identifier do not match any company.

    Response samples

    Content type
    {
    • "MemberList": {
      }
    }

    Create a company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members

    Response samples

    Content type
    {
    • "MemberList": {
      }
    }

    Create a company member ExperienceCommerce

    Creates a company member.

    path Parameters
    companyId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

    @@ -3604,7 +3630,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the user is not authorized to create a company member.

    Request samples

    Content type
    {
    • "MemberCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Get company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members

    Request samples

    Content type
    {
    • "MemberCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Get company member ExperienceCommerce

    Returns the company member by given member ID.

    path Parameters
    companyId
    required
    string
    memberId
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Delete company member ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members/{memberId}

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Delete company member ExperienceCommerce

    The given company member is deleted.

    path Parameters
    companyId
    required
    string
    memberId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

    @@ -3644,7 +3670,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the user is not authorized to create this company member.

    Request samples

    Content type
    {
    • "MemberUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Read list of sales representatives ExperienceCommerce

    /api/ibexa/v2/corporate/companies/{companyId}/members/{memberId}

    Request samples

    Content type
    {
    • "MemberUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Member": {
      }
    }

    Read list of sales representatives ExperienceCommerce

    Returns paginated list of available sales representatives.

    Responses

    Response samples

    Content type
    {
    • "SalesRepresentativesList": {
      }
    }

    Activity Log

    List of activity log groups ExperienceCommerce

    /api/ibexa/v2/corporate/sales-representatives

    Response samples

    Content type
    {
    • "SalesRepresentativesList": {
      }
    }

    Activity Log

    List of activity log groups ExperienceCommerce

    Lists last activity log groups and their entries.

    Responses

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    List of activity log groups ExperienceCommerce

    /api/ibexa/v2/activity-log-group/list

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    List of activity log groups ExperienceCommerce

    Lists last activity log groups and their entries.

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF Token needed on all unsafe HTTP methods with session.

    @@ -3674,7 +3700,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the user is not authorized to list activities.

    Request samples

    Content type
    {
    • "ActivityLogGroupListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    Cart

    Create Cart Commerce

    /api/ibexa/v2/activity-log-group/list

    Request samples

    Content type
    {
    • "ActivityLogGroupListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActivityLogGroupList": {
      }
    }

    Cart

    Create Cart Commerce

    Creates Cart from payload.

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -3688,7 +3714,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The input does not match the input schema definition.

    Request samples

    Content type
    {
    • "CartCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Filter carts Commerce

    /api/ibexa/v2/cart

    Request samples

    Content type
    {
    • "CartCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Filter carts Commerce

    Executes a query and returns a View including the results.

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -3700,7 +3726,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    OK - returns a view and its results

    Request samples

    Content type
    {
    • "CartViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CartView": {
      }
    }

    Get Cart Commerce

    /api/ibexa/v2/cart/view

    Request samples

    Content type
    {
    • "CartViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "CartView": {
      }
    }

    Get Cart Commerce

    Gets Cart by its identifier.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Delete Cart Commerce

    /api/ibexa/v2/cart/{identifier}

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Delete Cart Commerce

    Deletes Cart by its identifier.

    path Parameters
    identifier
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -3736,7 +3762,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The identifier do not match any cart.

    Request samples

    Content type
    {
    • "CartMetadataUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Empty Cart Commerce

    /api/ibexa/v2/cart/{identifier}

    Request samples

    Content type
    {
    • "CartMetadataUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Empty Cart Commerce

    Empties the given Cart.

    path Parameters
    identifier
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -3766,7 +3792,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The identifier do not match any cart.

    Request samples

    Content type
    {
    • "CartEntryAdd": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Remove Entry from Cart Commerce

    /api/ibexa/v2/cart/{identifier}/entry

    Request samples

    Content type
    {
    • "CartEntryAdd": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Remove Entry from Cart Commerce

    Removes the given entry from the given Cart.

    path Parameters
    identifier
    required
    string
    entryId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -3780,7 +3806,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the identifiers don't match any cart or entry.

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Update Entry from Cart Commerce

    /api/ibexa/v2/cart/{identifier}/entry/{entryId}

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Update Entry from Cart Commerce

    Updates the given entry from the given Cart.

    path Parameters
    identifier
    required
    string
    entryId
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -3796,7 +3822,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the identifiers don't match any cart or entry.

    Request samples

    Content type
    {
    • "CartEntryUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Move Selected Cart Entries to Default Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/entry/{entryId}

    Request samples

    Content type
    {
    • "CartEntryUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Move Selected Cart Entries to Default Shopping List Commerce

    Moves selected entries from the given Cart to the default Shopping List (save for later). After moving, selected entries are removed from the cart.

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -3816,7 +3842,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the cart identifier doesn't match any existing resource.

    Request samples

    Content type
    {
    • "CartEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Selected Cart Entries to Specific Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/move-entries-to-shopping-list

    Request samples

    Content type
    {
    • "CartEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Selected Cart Entries to Specific Shopping List Commerce

    Moves selected entries from the given Cart to the specified Shopping List (save for later). After moving, selected entries are removed from the cart.

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -3838,7 +3864,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the cart or shopping list don't match any existing resource.

    Request samples

    Content type
    {
    • "CartEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Default Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/move-entries-to-shopping-list/{shoppingListIdentifier}

    Request samples

    Content type
    {
    • "CartEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Default Shopping List Commerce

    Moves all entries from the given Cart to the default Shopping List (save for later). After moving, entries are removed from the cart.

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -3852,7 +3878,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the cart identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Specific Shopping List Commerce

    /api/ibexa/v2/cart/{identifier}/move-to-shopping-list

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Move Cart to Specific Shopping List Commerce

    Moves all entries from the given Cart to the specified Shopping List (save for later). After moving, entries are removed from the cart.

    path Parameters
    identifier
    required
    string

    The Cart identifier

    @@ -3868,7 +3894,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the cart or shopping list identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Cart Summary Commerce

    /api/ibexa/v2/cart/{identifier}/move-to-shopping-list/{shoppingListIdentifier}

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Cart Summary Commerce

    Gets a summary of the given Cart.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "CartSummary": {
      }
    }

    Shopping List

    List shopping lists CommerceLTS Update

    /api/ibexa/v2/cart/{identifier}/summary

    Response samples

    Content type
    {
    • "CartSummary": {
      }
    }

    Shopping List

    List shopping lists CommerceLTS Update

    Returns a list of shopping lists owned by the current user.

    query Parameters
    limit
    integer
    Default: 25

    The maximum number of shopping lists to return. Default is 25.

    @@ -3908,7 +3934,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The user is not authorized to list shopping lists.

    Response samples

    Content type
    {
    • "ShoppingListCollection": {
      }
    }

    Create shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list

    Response samples

    Content type
    {
    • "ShoppingListCollection": {
      }
    }

    Create shopping list CommerceLTS Update

    Creates a new shopping list for the current user. The list will be owned by the authenticated user.

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    @@ -3928,7 +3954,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list limit exceeded for the current user.

    Request samples

    Content type
    {
    • "ShoppingListCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to default shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list

    Request samples

    Content type
    {
    • "ShoppingListCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to default shopping list CommerceLTS Update

    Adds one or more product entries to the default shopping list. If the default shopping list does not exist, it will be created automatically.

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF Token is needed to execute this unsafe request.

    @@ -3948,7 +3974,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list entry limit exceeded.

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Get shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/default/entries

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Get shopping list CommerceLTS Update

    Gets a shopping list by its identifier.

    path Parameters
    identifier
    required
    string

    The shopping list identifier (UUID)

    @@ -3960,7 +3986,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the identifier does not match any shopping list.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Delete shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Delete shopping list CommerceLTS Update

    Deletes a shopping list by its identifier. The default shopping list cannot be deleted.

    path Parameters
    identifier
    required
    string

    The shopping list identifier (UUID).

    @@ -4000,7 +4026,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - The shopping list does not exist.

    Request samples

    Content type
    {
    • "ShoppingListUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add Selected Entries from Shopping List to Default Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}

    Request samples

    Content type
    {
    • "ShoppingListUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add Selected Entries from Shopping List to Default Cart CommerceLTS Update

    Adds selected entries from the given Shopping List to the default Cart (creates a new Cart if not found).

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4020,7 +4046,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shopping list or entry identifiers don't match any existing resource.

    Request samples

    Content type
    {
    • "ShoppingListEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Selected Entries from Shopping List to Specific Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-entries-to-cart

    Request samples

    Content type
    {
    • "ShoppingListEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Selected Entries from Shopping List to Specific Cart CommerceLTS Update

    Adds selected entries from the given Shopping List to the specified Cart.

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4042,7 +4068,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shopping list, cart, or entry identifiers don't match any existing resource.

    Request samples

    Content type
    {
    • "ShoppingListEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Default Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-entries-to-cart/{cartIdentifier}

    Request samples

    Content type
    {
    • "ShoppingListEntryIdentifiers": {
      }
    }

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Default Cart CommerceLTS Update

    Adds all entries from the given Shopping List to the default Cart (creates a new Cart if not found).

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4056,7 +4082,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shopping list identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Specific Cart CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-to-cart

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Add Shopping List to Specific Cart CommerceLTS Update

    Adds all entries from the given Shopping List to the specified Cart.

    path Parameters
    identifier
    required
    string

    The Shopping List identifier

    @@ -4072,7 +4098,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shopping list or cart identifier doesn't match any existing resource.

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Clear shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/add-to-cart/{cartIdentifier}

    Response samples

    Content type
    {
    • "Cart": {
      }
    }

    Clear shopping list CommerceLTS Update

    Removes all entries from a shopping list while keeping the list itself.

    path Parameters
    identifier
    required
    string

    The unique identifier (UUID) of the shopping list.

    @@ -4088,7 +4114,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list not found.

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/clear

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Add entries to shopping list CommerceLTS Update

    Adds one or more product entries to an existing shopping list.

    path Parameters
    identifier
    required
    string

    The unique identifier (UUID) of the shopping list.

    @@ -4112,7 +4138,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list entry limit exceeded.

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Remove entries from shopping list CommerceLTS Update

    /api/ibexa/v2/shopping-list/{identifier}/entries

    Request samples

    Content type
    {
    • "ShoppingListEntriesAdd": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Remove entries from shopping list CommerceLTS Update

    Removes one or more product entries from an existing shopping list by their identifiers.

    path Parameters
    identifier
    required
    string

    The unique identifier (UUID) of the shopping list.

    @@ -4134,7 +4160,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - Shopping list not found.

    Request samples

    Content type
    {
    • "ShoppingListEntriesRemove": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Orders

    Cancel order Commerce

    /api/ibexa/v2/shopping-list/{identifier}/entries/remove

    Request samples

    Content type
    {
    • "ShoppingListEntriesRemove": {
      }
    }

    Response samples

    Content type
    {
    • "ShoppingList": {
      }
    }

    Orders

    Cancel order Commerce

    Cancels the given order.

    path Parameters
    id
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4158,7 +4184,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the order does not exist.

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Load order by ID Commerce

    /api/ibexa/v2/orders/order/{identifier}

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Load order by ID Commerce

    Loads an order by its numerical ID.

    path Parameters
    id
    required
    string

    Responses

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Update order Commerce

    /api/ibexa/v2/orders/order/{id}

    Response samples

    Content type
    {
    • "Order": {
      }
    }

    Update order Commerce

    Updates an order.

    path Parameters
    id
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4188,7 +4214,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the order cannot be cancelled due to not-allowed workflow transition

    Request samples

    Content type
    application/vnd.ibexa.api.OrderUpdate+json
    {
    • "OrderUpdate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Order+json
    {
    • "Order": {
      }
    }

    Load orders Commerce

    /api/ibexa/v2/orders/order/{id}

    Request samples

    Content type
    application/vnd.ibexa.api.OrderUpdate+json
    {
    • "OrderUpdate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Order+json
    {
    • "Order": {
      }
    }

    Load orders Commerce

    Loads a list of orders.

    Responses

    Response samples

    Content type
    {
    • "OrderList": {
      }
    }

    Create order Commerce

    /api/ibexa/v2/orders/orders

    Response samples

    Content type
    {
    • "OrderList": {
      }
    }

    Create order Commerce

    Creates a new order.

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4214,7 +4240,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - a order with this identifier already exists.

    Request samples

    Content type
    application/vnd.ibexa.api.OrderCreate+json
    {
    • "OrderCreate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Order+json
    {
    • "Order": {
      }
    }

    Payments

    Create payment method Commerce

    /api/ibexa/v2/orders/orders

    Request samples

    Content type
    application/vnd.ibexa.api.OrderCreate+json
    {
    • "OrderCreate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Order+json
    {
    • "Order": {
      }
    }

    Payments

    Create payment method Commerce

    Creates a PaymentMethodCreateController resource.

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4230,7 +4256,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the payment methods does not exist.

    Request samples

    Content type
    {
    • "PaymentMethodCreateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    List payment methods Commerce

    /api/ibexa/v2/payment-method

    Request samples

    Content type
    {
    • "PaymentMethodCreateStruct": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    List payment methods Commerce

    Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.

    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4242,7 +4268,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the input does not match the input schema definition.

    Request samples

    Content type
    {
    • "PaymentMethodViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethodView": {
      }
    }

    Load payment method by identifier Commerce

    /api/ibexa/v2/payment-method/view

    Request samples

    Content type
    {
    • "PaymentMethodViewInput": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethodView": {
      }
    }

    Load payment method by identifier Commerce

    Loads an payment method by its identifier.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Delete payment method Commerce

    /api/ibexa/v2/payment-method/{identifier}

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Delete payment method Commerce

    Removes the PaymentMethodDeleteController resource.

    path Parameters
    identifier
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4280,7 +4306,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the payment methods does not exist.

    Request samples

    Content type
    {
    • "PaymentMethodUpdateStructParser": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Load payment method by id Commerce

    /api/ibexa/v2/payment-method/{identifier}

    Request samples

    Content type
    {
    • "PaymentMethodUpdateStructParser": {
      }
    }

    Response samples

    Content type
    {
    • "PaymentMethod": {
      }
    }

    Load payment method by id Commerce

    Loads an payment method by its id.

    path Parameters
    id
    required
    string

    Responses

    Response samples

    Content type
    application/vnd.ibexa.api.PaymentMethod+json
    {
    • "PaymentMethod": {
      }
    }

    Shipping

    Create shipment Commerce

    /api/ibexa/v2/payment-method/{id}

    Response samples

    Content type
    application/vnd.ibexa.api.PaymentMethod+json
    {
    • "PaymentMethod": {
      }
    }

    Shipping

    Create shipment Commerce

    Creates a shipment.

    path Parameters
    orderIdentifier
    required
    string

    The order's identifier to create a shipment for.

    @@ -4314,7 +4340,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Not supported - 400 Bad Request is returned on unprocessable input.

    Request samples

    Content type
    {
    • "ShipmentCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipments Commerce

    /api/ibexa/v2/orders/order/{orderIdentifier}/shipments

    Request samples

    Content type
    {
    • "ShipmentCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipments Commerce

    Loads a list of shipments.

    Responses

    Response samples

    Content type
    {
    • "ShipmentRefList": {
      }
    }

    Load a single shipment based on its identifier Commerce

    /api/ibexa/v2/shipments

    Response samples

    Content type
    {
    • "ShipmentRefList": {
      }
    }

    Load a single shipment based on its identifier Commerce

    Loads a single shipment based on its identifier.

    path Parameters
    identifier
    required
    string

    The shipment identifier.

    @@ -4336,7 +4362,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shipment does not exist.

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Delete shipment Commerce

    /api/ibexa/v2/shipments/{identifier}

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Delete shipment Commerce

    Deletes a shipment.

    path Parameters
    identifier
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string

    The CSRF token.

    @@ -4370,7 +4396,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the shipment cannot be cancelled due to not-allowed workflow transition

    Request samples

    Content type
    {
    • "ShipmentUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipping methods types Commerce

    /api/ibexa/v2/shipments/{identifier}

    Request samples

    Content type
    {
    • "ShipmentUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Shipment": {
      }
    }

    Load shipping methods types Commerce

    Loads shipping methods types.

    Responses

    Response samples

    Content type
    {
    • "ShippingMethodTypesList": {
      }
    }

    Load shipping method type based on its identifier Commerce

    /api/ibexa/v2/shipping/method-types

    Response samples

    Content type
    {
    • "ShippingMethodTypesList": {
      }
    }

    Load shipping method type based on its identifier Commerce

    Loads shipping methods type based on their identifiers.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "ShippingMethodType": {
      }
    }

    Load shipping methods Commerce

    /api/ibexa/v2/shipping/method-types/{identifier}

    Response samples

    Content type
    {
    • "ShippingMethodType": {
      }
    }

    Load shipping methods Commerce

    Loads shipping methods.

    Responses

    Response samples

    Content type
    {
    • "ShippingMethodRefList": {
      }
    }

    Load shipping method based on its identifier Commerce

    /api/ibexa/v2/shipping/methods

    Response samples

    Content type
    {
    • "ShippingMethodRefList": {
      }
    }

    Load shipping method based on its identifier Commerce

    Loads shipping method based on its identifier.

    path Parameters
    identifier
    required
    string

    Responses

    Response samples

    Content type
    {
    • "ShippingMethod": {
      }
    }

    Collaboration Sessions

    Create collaboration session

    /api/ibexa/v2/shipping/methods/{identifier}

    Response samples

    Content type
    {
    • "ShippingMethod": {
      }
    }

    Collaboration Sessions

    Create collaboration session

    Creates a new collaboration session with participants and returns the session details.

    Request Body schema:
    optional

    Session creation payload

    @@ -4420,7 +4446,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the user is not authorized to create sessions.

    Request samples

    Content type
    {
    • "ExampleSessionCreate": {
      }
    }

    Response samples

    Content type
    {
    • "CollaborationSession": {
      }
    }

    Get collaboration session

    /api/ibexa/v2/collaboration/sessions

    Request samples

    Content type
    {
    • "ExampleSessionCreate": {
      }
    }

    Response samples

    Content type
    {
    • "CollaborationSession": {
      }
    }

    Get collaboration session

    Retrieves a collaboration session by its token.

    path Parameters
    sessionToken
    required
    string

    The session token to retrieve.

    @@ -4432,7 +4458,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session does not exist.

    Response samples

    Content type
    {
    • "CollaborationSession": {
      }
    }

    Delete collaboration session

    /api/ibexa/v2/collaboration/sessions/{sessionToken}

    Response samples

    Content type
    {
    • "CollaborationSession": {
      }
    }

    Delete collaboration session

    Deletes a collaboration session and removes all associated data.

    path Parameters
    sessionToken
    required
    string

    The session token to delete.

    @@ -4460,7 +4486,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session does not exist.

    Request samples

    Content type
    {
    • "ExampleSessionUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "CollaborationSession": {
      }
    }

    Create invitation in collaboration session

    /api/ibexa/v2/collaboration/sessions/{sessionToken}

    Request samples

    Content type
    {
    • "ExampleSessionUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "CollaborationSession": {
      }
    }

    Create invitation in collaboration session

    Creates an invitation for a participant to join a collaboration session.

    path Parameters
    sessionToken
    required
    string

    The session token.

    @@ -4476,7 +4502,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session does not exist.

    Request samples

    Content type
    {
    • "InvitationCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Invitation": {
      }
    }

    List collaboration session participants

    /api/ibexa/v2/collaboration/sessions/{sessionToken}/invitations

    Request samples

    Content type
    {
    • "InvitationCreate": {
      }
    }

    Response samples

    Content type
    {
    • "Invitation": {
      }
    }

    List collaboration session participants

    Retrieves a list of all participants in a collaboration session.

    path Parameters
    sessionToken
    required
    string

    The session token.

    @@ -4488,7 +4514,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session does not exist.

    Response samples

    Content type
    {
    • "ParticipantList": {
      }
    }

    Add participants to collaboration session

    /api/ibexa/v2/collaboration/sessions/{sessionToken}/participants

    Response samples

    Content type
    {
    • "ParticipantList": {
      }
    }

    Add participants to collaboration session

    Adds new participants to an existing collaboration session.

    path Parameters
    sessionToken
    required
    string

    The session token.

    @@ -4504,7 +4530,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session does not exist.

    Request samples

    Content type
    {
    • "ParticipantListCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ParticipantList": {
      }
    }

    Remove participant from collaboration session

    /api/ibexa/v2/collaboration/sessions/{sessionToken}/participants

    Request samples

    Content type
    {
    • "ParticipantListCreate": {
      }
    }

    Response samples

    Content type
    {
    • "ParticipantList": {
      }
    }

    Remove participant from collaboration session

    Removes a participant from a collaboration session.

    path Parameters
    sessionToken
    required
    string

    The session token.

    @@ -4536,13 +4562,13 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the session or participant does not exist.

    Request samples

    Content type
    {
    • "ExternalParticipantUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Participant": {
      }
    }

    Connector AI

    Get action types list.

    /api/ibexa/v2/collaboration/sessions/{sessionToken}/participants/{participantId}

    Request samples

    Content type
    {
    • "ExternalParticipantUpdate": {
      }
    }

    Response samples

    Content type
    {
    • "Participant": {
      }
    }

    Connector AI

    Get action types list.

    Returns action types list.

    Responses

    Response samples

    Content type
    {
    • "ActionTypeList": {
      }
    }

    Get an action type by its unique identifier.

    /api/ibexa/v2/ai/action-types

    Response samples

    Content type
    {
    • "ActionTypeList": {
      }
    }

    Get an action type by its unique identifier.

    Returns an action type by its unique string identifier.

    path Parameters
    identifier
    required
    string
    Example: generate_alt_text

    Responses

    Response samples

    Content type
    {
    • "ActionType": {
      }
    }

    Get action configuration list.

    /api/ibexa/v2/ai/action-types/{identifier}

    Response samples

    Content type
    {
    • "ActionType": {
      }
    }

    Get action configuration list.

    Returns action configuration list.

    Responses

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Query action configuration list.

    /api/ibexa/v2/ai/actions

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Query action configuration list.

    Returns action configuration list based on the given query.

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF token obtained during the authentication.

    @@ -4566,7 +4592,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Action configuration list is returned in JSON or XML

    Request samples

    Content type
    {
    • "ActionConfigurationListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Execute the given AI action

    /api/ibexa/v2/ai/actions

    Request samples

    Content type
    {
    • "ActionConfigurationListInput": {
      }
    }

    Response samples

    Content type
    {
    • "ActionConfigurationList": {
      }
    }

    Execute the given AI action

    Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.

    path Parameters
    actionConfigurationIdentifier
    required
    string
    Examples:
    • rewrite_with_friendly_tone -
    • rewrite_with_professional_tone -
    • summarize_text -
    • expand_text -
    • shorten_text -
    • proofread -
    • improve_readability -
    • gen_alt_text -

    Configured action name (obtain by listing the configured actions via GET /api/ibexa/v2/ai/actions endpoint).

    @@ -4580,7 +4606,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - if the provided input or action configuration is invalid or the given action cannot be performed for any reason.

    Request samples

    Content type
    {
    • "GenerateAltText": {
      }
    }

    Response samples

    Content type
    {
    • "AltText": {
      }
    }

    Get an action configuration by its unique identifier.

    /api/ibexa/v2/ai/actions/{actionConfigurationIdentifier}/execute

    Request samples

    Content type
    {
    • "GenerateAltText": {
      }
    }

    Response samples

    Content type
    {
    • "AltText": {
      }
    }

    Get an action configuration by its unique identifier.

    Returns an action configuration by its unique string identifier.

    path Parameters
    identifier
    required
    string
    Example: rewrite_with_friendly_tone

    Responses

    Response samples

    Content type
    {
    • "ActionConfiguration": {
      }
    }

    Discounts

    Get discounts Commerce

    /api/ibexa/v2/ai/actions/{identifier}

    Response samples

    Content type
    {
    • "ActionConfiguration": {
      }
    }

    Discounts

    Get discounts Commerce

    Returns a list of all defined discounts

    query Parameters
    offset
    integer
    limit
    integer
    Example: limit=25

    Responses

    Response samples

    Content type
    application/vnd.ibexa.api.DiscountList+json
    {
    • "DiscountList": {
      }
    }

    Create a discount Commerce

    /api/ibexa/v2/discounts

    Response samples

    Content type
    application/vnd.ibexa.api.DiscountList+json
    {
    • "DiscountList": {
      }
    }

    Create a discount Commerce

    Creates a new discount

    header Parameters
    X-CSRF-Token
    required
    string

    CSRF token obtained during the authentication.

    @@ -4610,7 +4636,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the input data is not valid.

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountCreate+json
    {
    • "DiscountCreate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Get a discount item by its unique identifier. Commerce

    /api/ibexa/v2/discounts

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountCreate+json
    {
    • "DiscountCreate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Get a discount item by its unique identifier. Commerce

    Returns a discount item by its unique string identifier.

    path Parameters
    identifier
    required
    string
    Example: my_discount_identifier

    Responses

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Delete a discount item Commerce

    /api/ibexa/v2/discounts/{identifier}

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Delete a discount item Commerce

    Deletes an existing discount item by its unique identifier

    path Parameters
    identifier
    required
    string
    Example: my_discount_identifier
    header Parameters
    X-CSRF-Token
    required
    string

    CSRF token obtained during the authentication.

    @@ -4648,7 +4674,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - the input data is not valid.

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountUpdate+json
    {
    • "DiscountUpdate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Disables a discount Commerce

    /api/ibexa/v2/discounts/{identifier}

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountUpdate+json
    {
    • "DiscountUpdate": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Disables a discount Commerce

    Disables a discount item by its unique identifier

    path Parameters
    identifier
    required
    string
    Example: my_discount_identifier
    header Parameters
    X-CSRF-Token
    required
    string

    CSRF token obtained during the authentication.

    @@ -4682,7 +4708,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Error - a discount of the given ID is not found.

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Apply discount code Commerce

    /api/ibexa/v2/discounts/{id}

    Response samples

    Content type
    application/vnd.ibexa.api.Discount+json
    {
    • "Discount": {
      }
    }

    Apply discount code Commerce

    Apply a discount code on a cart given by its identifier.

    path Parameters
    cartIdentifier
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string
    Request Body schema: application/vnd.ibexa.api.DiscountCode+json
    optional

    The discount code to apply

    @@ -4694,7 +4720,7 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Too Many Requests - rate limit exceeded, next requests are temporarily blocked as a security measure.

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountCode+json
    {
    • "DiscountCode": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.DiscountCode+json
    {
    • "DiscountCode": {
      }
    }

    Drop discount code Commerce

    /api/ibexa/v2/discounts_codes/{cartIdentifier}/apply

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountCode+json
    {
    • "DiscountCode": {
      }
    }

    Response samples

    Content type
    application/vnd.ibexa.api.DiscountCode+json
    {
    • "DiscountCode": {
      }
    }

    Drop discount code Commerce

    Unapply a discount code from a cart given by its identifier.

    path Parameters
    cartIdentifier
    required
    string
    header Parameters
    X-CSRF-Token
    required
    string
    Request Body schema: application/vnd.ibexa.api.DiscountCode+json
    optional

    The discount code to drop

    @@ -4704,9 +4730,33 @@ " class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">

    Not Found - the cart does not exist.

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountCode+json
    {
    • "DiscountCode": {
      }
    }
    +
    /api/ibexa/v2/discounts_codes/{cartIdentifier}/drop

    Request samples

    Content type
    application/vnd.ibexa.api.DiscountCode+json
    {
    • "DiscountCode": {
      }
    }

    Translations Management

    List missing translations

    Returns missing translations with server-side filtering, sorting and pagination.

    +
    query Parameters
    targetLanguage
    string
    contentType
    string
    search
    string
    sort
    string
    Enum: "name" "content_type"
    direction
    string
    Enum: "asc" "desc"
    page
    integer >= 1
    limit
    integer >= 1

    Responses

    Response samples

    Content type
    application/json
    {
    • "totalCount": 0,
    • "page": 0,
    • "limit": 0,
    • "rows": [
      ]
    }

    List missing translation ids

    Returns up to N missing translation content ids for current filter and sorting context.

    +
    query Parameters
    targetLanguage
    string
    contentType
    string
    search
    string
    sort
    string
    Enum: "name" "content_type"
    direction
    string
    Enum: "asc" "desc"
    limit
    integer [ 1 .. 500 ]

    Responses

    Response samples

    Content type
    application/json
    {
    • "ids": [
      ],
    • "returnedCount": 0,
    • "totalCount": 0,
    • "limited": true
    }

    Read bulk translation setup state

    Returns the setup state used by the Translation setup modal.

    +
    query Parameters
    content_ids[]
    Array of integers
    source_language
    string
    target_language
    string
    provider
    string
    setup_search
    string
    setup_items_ct
    string
    setup_items_page
    integer >= 1
    setup_duplicates_search
    string
    setup_duplicates_ct
    string
    setup_duplicates_page
    integer >= 1

    Responses

    Response samples

    Content type
    application/json
    {
    • "configuration": {
      },
    • "summary": {
      },
    • "sections": {
      },
    • "selection": {
      },
    • "actions": {
      }
    }