Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/rest_api/rest_api_usage/rest_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ This script:

### Search (`/views`)

The `/views` route allows you to [search in the repository](search.md). It works similarly to its [PHP API counterpart](search_api.md).
The `/views` route allows you to [search in the repository](search.md).

The model allows combining criteria using the logical operators `AND`, `OR` and `NOT`.

Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/content_api/browsing_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@
- use the `RelationListIteratorAdapter`
within a `BatchIterator` which allow traversing the whole relation list

See [Processing large result sets](search_api.md#process-large-result-sets) for more information about the `BatchIterator`.

Check failure on line 106 in docs/content_management/content_api/browsing_content.md

View workflow job for this annotation

GitHub Actions / markdownlint

Multiple consecutive blank lines

docs/content_management/content_api/browsing_content.md:106 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md012.md

Check failure on line 107 in docs/content_management/content_api/browsing_content.md

View workflow job for this annotation

GitHub Actions / markdownlint

Multiple consecutive blank lines

docs/content_management/content_api/browsing_content.md:107 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 3] https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/md012.md
You can get the current version's `VersionInfo` using `ContentService::loadVersionInfo`.

``` php
Expand Down Expand Up @@ -218,7 +218,7 @@

!!! note

Refer to [Searching](search_api.md) for information on more complex search queries.
Refer to [Search](../../search/search.md) for information on more complex search queries.

## Getting parent location

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/content_api/managing_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ $trashService->recover($trashItem, $newParent);
```

You can also search through Trash items and sort the results using several public PHP API Search Criteria and Sort Clauses that have been exposed for `TrashService` queries.
For more information, see [Search in trash](search_api.md#search-in-trash).
For more information, see [Search in trash](../../search/search_in_trash_reference.md).

## Content types

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can use `SectionService` to retrieve section information such as whether it'

## Listing content in a section

To list content items assigned to a section you need to make a [query](search_api.md) for content belonging to this section, by applying the `SearchService`.
To list content items assigned to a section you need to make a query for content belonging to this section.
You can also use the query to get the total number of assigned content items:

``` php
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/taxonomy/taxonomy_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ and a `position` parameter, which is either `TaxonomyServiceInterface::MOVE_POSI

## Search

You can search for content based on its taxonomy entry assignments by using the standard [`SearchService`](search_api.md) with taxonomy-specific Search Criteria:
You can search for content based on its taxonomy entry assignments by using taxonomy-specific Search Criteria:

| Criterion | Description |
|---|---|
Expand Down
1 change: 0 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@
<div class="col-12 col-lg-6 col-fhd-3">
<ul>
<li><a href="content_management/rich_text/rich_text/">RichText and Online Editor</a></li>
<li><a href="search/search_api/">Search API</a></li>
</ul>
</div>
<div class="col-12 col-lg-6 col-fhd-3">
Expand Down
14 changes: 0 additions & 14 deletions docs/search/activity_log_search_reference/action_criterion.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,3 @@ matches activity log group that has a log entry with one of the given actions.

- `actions` - list of action name strings.
A set of built-in names is available as `ActivityLogServiceInterface`'s `ACTION_` prefixed constants.

## Example

``` php
use Ibexa\Contracts\ActivityLog\ActivityLogServiceInterface;
use Ibexa\Contracts\ActivityLog\Values\ActivityLog as ActivityLog;

$query = new ActivityLog\Query([
new ActivityLog\Criterion\ActionCriterion([
ActivityLogServiceInterface::ACTION_DELETE,
ActivityLogServiceInterface::ACTION_TRASH,
]),
]);
```
12 changes: 0 additions & 12 deletions docs/search/activity_log_search_reference/logged_at_criterion.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,3 @@ The `LoggedAtCriterion` Activity Log Criterion matches activity log group that h
| Less than or equal | `<=` | `LoggedAtCriterion::LTE` |
| Greater than | `>` | `LoggedAtCriterion::GT` |
| Greater than or equal | `>=` | `LoggedAtCriterion::GTE` |

## Example

The following example is to match all activity log groups that aren't older than a day:

``` php
use Ibexa\Contracts\ActivityLog\Values\ActivityLog as ActivityLog;

$query = new ActivityLog\Query([
new ActivityLog\Criterion\LoggedAtCriterion(new \DateTime('- 1 day'), ActivityLog\Criterion\LoggedAtCriterion::GTE),
]);
```
18 changes: 0 additions & 18 deletions docs/search/activity_log_search_reference/object_criterion.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,3 @@ The `ObjectCriterion` Activity Log Criterion matches log group with a log entry

- `objectClass` - a class of the object concerned by the searched log entries
- `ids` - an optional list of object IDs

## Examples

``` php
use Ibexa\Contracts\ActivityLog\Values\ActivityLog as ActivityLog;

$query = new ActivityLog\Query([
new ActivityLog\Criterion\ObjectCriterion(Ibexa\Contracts\Core\Repository\Values\Content\Content::class),
]);
```

``` php
use Ibexa\Contracts\ActivityLog\Values\ActivityLog as ActivityLog;

$query = new ActivityLog\Query([
new ActivityLog\Criterion\ObjectCriterion(Ibexa\Contracts\ProductCatalog\Values\ProductVariantInterface::class, ['123', '234', '345']),
]);
```
10 changes: 0 additions & 10 deletions docs/search/activity_log_search_reference/object_name_criterion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,3 @@ The `ObjectNameCriterion` Activity Log Criterion matches log groups that have a
- `ObjectNameCriterion::OPERATOR_STARTS_WITH`
- `ObjectNameCriterion::OPERATOR_ENDS_WITH`
- `ObjectNameCriterion::OPERATOR_EQUALS`

## Example

``` php
use Ibexa\Contracts\ActivityLog\Values\ActivityLog as ActivityLog;

$query = new ActivityLog\Query([
new ActivityLog\Criterion\ObjectNameCriterion('Ibexa', ActivityLog\Criterion\ObjectNameCriterion::OPERATOR_CONTAINS),
]);
```
10 changes: 0 additions & 10 deletions docs/search/activity_log_search_reference/user_criterion.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,3 @@ The `UserCriterion` Activity Log Criterion matches log groups that have an activ
## Argument

- `ids` - list of user IDs

## Example

``` php
use Ibexa\Contracts\ActivityLog\Values\ActivityLog as ActivityLog;

$query = new ActivityLog\Query([
new ActivityLog\Criterion\UserCriterion([10, 14]),
]);
```
2 changes: 1 addition & 1 deletion docs/search/aggregation_reference/aggregation_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Aggregation reference

[Aggregation](search_api.md#aggregation) is used to group search results into categories.
Aggregation is used to group search results into categories.

Check notice on line 8 in docs/search/aggregation_reference/aggregation_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/search/aggregation_reference/aggregation_reference.md#L8 <Ibexa.Passive>

Try to avoid passive tense, when possible.
Raw output
{"message":"Try to avoid passive tense, when possible.","location":{"path":"docs/search/aggregation_reference/aggregation_reference.md","range":{"start":{"line":8,"column":13},"end":{"line":8,"column":20}}},"severity":"INFO","code":{"value":"Ibexa.Passive"}}

There are three types of aggregations:

Expand Down
12 changes: 0 additions & 12 deletions docs/search/aggregation_reference/authorterm_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,3 @@ The field-based AuthorTermAggregation aggregates search results by the value of
## Arguments

[[= include_file('docs/snippets/aggregation_arguments.md') =]]

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\AuthorTermAggregation('author', 'article', 'authors');
```

[[= include_file('docs/snippets/search_term_aggregation_settings.md') =]]
14 changes: 0 additions & 14 deletions docs/search/aggregation_reference/basepricestats_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,3 @@ You can use the provided getters to access the values:

- `name` - name of the Aggregation
- `\Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface` - currency of the price

## Example

``` php
use Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface;
use Ibexa\Contracts\ProductCatalog\Values\Product\ProductQuery;
use Ibexa\Contracts\ProductCatalog\Values\Product\Query\Aggregation\BasePriceStatsAggregation;

/** @var CurrencyInterface $currency */
$query = new ProductQuery();
$query->setAggregations([
new BasePriceStatsAggregation('base_price_stats_aggregation', $currency),
]);
```
12 changes: 0 additions & 12 deletions docs/search/aggregation_reference/checkboxterm_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,3 @@ The field-based CheckboxTermAggregation aggregates search results by the value o
## Arguments

[[= include_file('docs/snippets/aggregation_arguments.md') =]]

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\CheckboxTermAggregation('checkbox', 'article', 'enable_comments');
```

[[= include_file('docs/snippets/search_term_aggregation_settings.md') =]]
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,3 @@ The ContentTypeGroupTermAggregation aggregates search results by the content ite
## Arguments

- `name` - name of the Aggregation object

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;

$query = new Query();
$query->aggregations[] = new Aggregation\ContentTypeGroupTermAggregation('content_type_group');
```

[[= include_file('docs/snippets/search_term_aggregation_settings.md') =]]
12 changes: 0 additions & 12 deletions docs/search/aggregation_reference/contenttypeterm_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,3 @@ The ContentTypeTermAggregation aggregates search results by the content item's c
## Arguments

- `name` - name of the Aggregation object

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;

$query = new Query();
$query->aggregations[] = new Aggregation\ContentTypeTermAggregation('content_type');
```

[[= include_file('docs/snippets/search_term_aggregation_settings.md') =]]
12 changes: 0 additions & 12 deletions docs/search/aggregation_reference/countryterm_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,3 @@ The field-based CountryTermAggregation aggregates search results by the value of
## Arguments

[[= include_file('docs/snippets/aggregation_arguments.md') =]]

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\CountryTermAggregation('country', 'article', 'country');
```

[[= include_file('docs/snippets/search_term_aggregation_settings.md') =]]
18 changes: 0 additions & 18 deletions docs/search/aggregation_reference/custompricestats_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,3 @@ The CustomPriceStatsAggregation aggregates search results by the value of the cu
- `name` - name of the Aggregation
- `\Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface` - currency of the price
- `\Ibexa\Contracts\ProductCatalog\Values\CustomerGroupInterface|null` - customer group that defines custom pricing, by default it's the one assigned to current user

## Example

``` php
use Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface;
use Ibexa\Contracts\ProductCatalog\Values\CustomerGroupInterface;
use Ibexa\Contracts\ProductCatalog\Values\Product\ProductQuery;
use Ibexa\Contracts\ProductCatalog\Values\Product\Query\Aggregation\CustomPriceStatsAggregation;

/**
* @var CurrencyInterface $currency
* @var CustomerGroupInterface $customerGroup
*/
$query = new ProductQuery();
$query->setAggregations([
new CustomPriceStatsAggregation('custom_price_stats_aggregation', $currency, $customerGroup),
]);
```
19 changes: 0 additions & 19 deletions docs/search/aggregation_reference/datemetadatarange_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,3 @@ The DateMetadataRangeAggregation aggregates search results by the value of the c
- `name` - name of the Aggregation object
- `type` - string representing the type of the Aggregation (`MODIFIED` or `PUBLISHED`)
- `ranges` - array of Range objects that define the borders of the specific range sets

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range;

$query = new Query();
$query->aggregations[] = new Aggregation\DateMetadataRangeAggregation(
'date_metadata',
Aggregation\DateMetadataRangeAggregation::PUBLISHED,
[
Range::ofDateTime(null, new DateTime('2020-06-01')),
Range::ofDateTime(new DateTime('2020-06-01'), new DateTime('2020-12-31')),
Range::ofDateTime(new DateTime('2020-12-31'), null),
]
);
```
20 changes: 0 additions & 20 deletions docs/search/aggregation_reference/daterange_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,3 @@ The field-based DateRangeAggregation aggregates search results by the value of t
[[= include_file('docs/snippets/aggregation_arguments.md') =]]

- `ranges` - array of Range objects that define the borders of the specific range sets

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\DateRangeAggregation(
'date',
'event',
'event_date',
[
Range::ofDateTime(null, new DateTime('2020-06-01')),
Range::ofDateTime(new DateTime('2020-06-01'), new DateTime('2020-12-31')),
Range::ofDateTime(new DateTime('2020-12-31'), null),
]
);
```
20 changes: 0 additions & 20 deletions docs/search/aggregation_reference/datetimerange_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,3 @@ The field-based DateTimeRangeAggregation aggregates search results by the value
[[= include_file('docs/snippets/aggregation_arguments.md') =]]

- `ranges` - array of Range objects that define the borders of the specific range sets

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\DateTimeRangeAggregation(
'date',
'event',
'event_date',
[
Range::ofDateTime(null, new DateTime('2020-06-01')),
Range::ofDateTime(new DateTime('2020-06-01'), new DateTime('2020-12-31')),
Range::ofDateTime(new DateTime('2020-12-31'), null),
]
);
```
20 changes: 0 additions & 20 deletions docs/search/aggregation_reference/floatrange_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,3 @@ The field-based FloatRangeAggregation aggregates search results by the value of
[[= include_file('docs/snippets/aggregation_arguments.md') =]]

- `ranges` - array of Range objects that define the borders of the specific range sets

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\FloatRangeAggregation(
'float',
'product',
'weight',
[
Range::ofFloat(null, 0.25),
Range::ofFloat(0.25, 0.75),
Range::ofFloat(0.75, null),
]
);
```
10 changes: 0 additions & 10 deletions docs/search/aggregation_reference/floatstats_aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,3 @@ You can use the provided getters to access the values:
## Arguments

[[= include_file('docs/snippets/aggregation_arguments.md') =]]

## Example

``` php
use Ibexa\Contracts\Core\Repository\Values\Content\Query;
use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;

$query = new Query();
$query->aggregations[] = new Aggregation\Field\FloatStatsAggregation('float', 'product', 'weight');
```
Loading
Loading