Skip to content

Commit cf48275

Browse files
fixes after review
1 parent e8017de commit cf48275

File tree

5 files changed

+53
-43
lines changed

5 files changed

+53
-43
lines changed

docs/content_management/collaborative_editing/collaborative_editing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
description: Collaborative editing enables multiple users to work on the same content simultaneously.
33
page_type: landing_page
4+
editions:
5+
- lts-update
46
month_change: true
57
---
68

@@ -12,7 +14,7 @@ This feature allows multiple users to work together on the same content item in
1214
Users can invite both internal and external collaborators to a session, giving them access for editing or previewing.
1315

1416
Additionaly, they can collaborate using a Real-time collaboration, an advanced part of the collaboration feature, to write and review content in a live mode thanks to CKEditor.
15-
Real-time collaboration syncs changes instantly and shows user avatars and colored tags to indicate who is editing each part of the content.
17+
Real-time collaboration syncs changes instantly and shows user avatars and colored tags to indicate who is editing specific part of the Rich Text field.
1618

1719
This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.
1820

docs/content_management/collaborative_editing/collaborative_editing_api.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
22
description: Use PHP API to manage invitations and sessions while using collaborative editing feature.
3-
month_change: false
3+
editions:
4+
- lts-update
5+
month_change: true
46
---
57

68
# Collaborative editing API
79

810
[[= product_name =]]'s Collaborative editing API provides two services for managing sessions and invitations, which differ in function:
911

10-
- [`InvitationServiceInterface`](../api/php_api/php_api_reference/classes/Ibexa-Contracts-(?)-InvitationServiceInterface.html) is used to request product data
11-
- [`SessionServiceInterface`](../api/php_api/php_api_reference/classes/Ibexa-Contracts-(?)-SessionServiceInterface.html) is used to modify products
12+
- [`InvitationServiceInterface`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html) is used to manage collaboration sessions invitations
13+
- [`SessionServiceInterface`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html) is used to manage collaboration sessions
1214

1315
``` php
1416

docs/content_management/collaborative_editing/install_collaborative_editing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
description: Install the Collaborative editing LTS update.
3-
month_change: false
3+
editions:
4+
- lts-update
5+
month_change: true
46
---
57

68
# Install Collaborative editing
@@ -36,7 +38,7 @@ php bin/console ibexa:doctrine:schema:dump-sql vendor/ibexa/share/src/bundle/Res
3638

3739
### Modify the bundles file
3840

39-
Then, in the `config/bundles.php` file, add the following code:
41+
Then, if not using Symfony Flex, add the following code to the `config/bundles.php` file:
4042

4143
``` php
4244
<?php

docs/content_management/collaborative_editing/invitation_api.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
22
description: You can use the PHP API to create new invitation, update existing one, read or delete it.
3+
editions:
4+
- lts-update
5+
month_change: true
36
---
47

58
# Invitation API
69

7-
[`InvitationService`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html) enables you to read, add, update, and remove invitation for collaborative editing session.
10+
[`InvitationService`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html) enables you to read, add, update, and remove invitation for collaborative editing session.
811

912
## Create invitation
1013

11-
You can create new invitation for the collaborative session using the [`InvitationService::createInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_createInvitation) method:
14+
You can create new invitation for the collaborative session using the [`InvitationService::createInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation) method:
1215

1316
``` php
1417
{
@@ -24,7 +27,7 @@ You can create new invitation for the collaborative session using the [`Invitati
2427

2528
## Get invitation by ID
2629

27-
You can get an invitation by ID with [`InvitationService::getInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation):
30+
You can get an invitation by ID with [`InvitationService::getInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_getInvitation):
2831

2932
``` php
3033
$this->invitationService->getInvitation(1);
@@ -58,21 +61,21 @@ You can select the parameter that you can read from an invitation:
5861

5962
## Get invitation by participant
6063

61-
You can get an invitation by participant with [`InvitationService::getInvitationByParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_getInvitationByParticipant):
64+
You can get an invitation by participant with [`InvitationService::getInvitationByParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_getInvitationByParticipant):
6265

6366
``` php
6467
$this->innerService->getInvitationByParticipant($participant);
6568
```
6669

6770
## Find invitations
6871

69-
You can find an invitation with [`InvitationService::findInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation).
72+
You can find an invitation with [`InvitationService::findInvitations`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_findInvitations).
7073

7174
To learn more about the available search options, see Search Criteria and Sort Clauses for Collaborative editing.
7275

7376
## Update invitation
7477

75-
You can update existing invitation with [`InvitationService::updateInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation):
78+
You can update existing invitation with [`InvitationService::updateInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_updateInvitation):
7679

7780
``` php
7881
$invitation = $this->invitationService->getInvitation(1);
@@ -83,7 +86,7 @@ You can update existing invitation with [`InvitationService::updateInvitation`](
8386

8487
## Delete invitation
8588

86-
You can delete an invitation with [`InvitationService::deleteInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation):
89+
You can delete an invitation with [`InvitationService::deleteInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_deleteInvitation):
8790

8891
``` php
8992
$invitation = $this->invitationService->getInvitation(1);

docs/content_management/collaborative_editing/session_api.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,48 @@
11
---
2-
description: You can use the PHP API to create new session, update existing one, find or delete it, and add or remove participants.
2+
description: You can use the PHP API to create a new session, update an existing one, find or delete it, and add or remove participants.
3+
editions:
4+
- lts-update
5+
month_change: true
36
---
47

58
# Session API
69

7-
[`SessionService`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html) enables you work with the collaborative session, for example, create a new one, update or delete existing one, and add or remove new participants to join collaborative session.
10+
[`SessionService`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html) enables you work with the collaborative session. You can, for example, create a new one, update or delete an existing one, and add or remove participants taking part in the session.
811

912
## Create session
1013

11-
You can create new collaboration session with given id with [`SessionService::createSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_createSession):
14+
You can create new collaboration session with [`SessionService::createSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_createSession):
1215

1316
``` php
1417
$this->innerService->createSession($createStruct);
1518
```
1619
## Get session
1720

18-
You can return existing collaboration session with [`SessionService::getSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_getSession):
21+
You can get an existing collaboration session with [`SessionService::getSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_getSession):
1922

20-
- using given id:
23+
- using given id - with [`SessionService::getSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_getSession)
2124

22-
``` php
23-
$this->innerService->getSession($id);
24-
```
25-
26-
- using given token:
25+
- using given token - with [`SessionService::getSessionByToken`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_getSessionByToken)
2726

28-
``` php
29-
$this->innerService->getSessionByToken($token);
30-
```
27+
## Find sessions
3128

32-
- matching the given query:
33-
34-
``` php
35-
$this->innerService->findSessions($query);
36-
```
37-
38-
## Find session
39-
40-
You can find an existing session with [`SessionService::findSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_findSession) by:
29+
You can find an existing session with [`SessionService::findSessions`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_findSessions) by:
4130

4231
``` php
4332
$this->innerService->findSessions($query);
4433
```
4534

4635
## Update session
4736

48-
You can update existing invitation with [`SessionService::updateSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_updateSession):
37+
You can update existing invitation with [`SessionService::updateSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateSession):
4938

5039
``` php
5140
$this->innerService->updateSession($session, $updateStruct);
5241
```
5342

5443
## Delete session
5544

56-
You can delete session with [`SessionService::deleteSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_deleteSession):
45+
You can delete session with [`SessionService::deleteSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_deleteSession):
5746

5847
``` php
5948
$this->innerService->deleteSession($session);
@@ -63,30 +52,42 @@ You can delete session with [`SessionService::deleteSession`](../../api/php_api/
6352

6453
## Add participant
6554

66-
You can add participant to the collaboration session with [`SessionService::addParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_addParticipant):
55+
You can add participant to the collaboration session with [`SessionService::addParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_addParticipant):
6756

6857
``` php
69-
$this->innerService->addParticipant($session, $createStruct);
58+
{
59+
$session = $this->sessionService->getSession(1);
60+
$participant = $sessionService->addParticipant($session, $createStruct);
61+
$createStruct = new ParticipantCreateStruct($user);
62+
}
7063
```
7164

7265
## Update participant
7366

74-
You can update participant added to the collaboration session with [`SessionService::updateParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_updateParticipant):
67+
You can update participant added to the collaboration session with [`SessionService::updateParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateParticipant):
7568

7669
``` php
7770
$this->innerService->updateParticipant($session, $participant, $updateStruct);
7871
```
7972
## Remove participant
8073

81-
You can remove participant from the collaboration session with [`SessionService::removeParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_removeParticipant):
74+
You can remove participant from the collaboration session with [`SessionService::removeParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_removeParticipant):
8275

8376
``` php
8477
$this->innerService->removeParticipant($session, $participant);
8578
```
8679

87-
## Check session Owner
80+
## Check session owner
81+
82+
You can check the owner of the collaboration session with [`SessionService::isSessionOwner`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceDecorator.html#method_isSessionOwner):
83+
84+
``` php
85+
$this->innerService->isSessionOwner($session, $user);
86+
```
87+
88+
## Check session participant
8889

89-
You can check the Owner of the collaboration session with [`SessionService::removeParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_removeParticipant):
90+
You can check the participant of the collaboration session with [`SessionService::isSessionParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_isSessionParticipant):
9091

9192
``` php
9293
$this->innerService->isSessionOwner($session, $user);

0 commit comments

Comments
 (0)