BookmarkService
BookmarkService.php
:
20
Interface
Bookmark Service.
Service to handle bookmarking of Content item Locations. It works in the context of a current User (obtained from the PermissionResolver).
Methods¶
createBookmark()
¶
BookmarkService.php
:
31
Add location to bookmarks.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $location | Location | - | - |
Tags
deleteBookmark()
¶
BookmarkService.php
:
42
Delete given location from bookmarks.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $location | Location | - | - |
Tags
isBookmarked()
¶
BookmarkService.php
:
63
Return true if location is bookmarked.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $location | Location | - | - |
Return values
bool
loadBookmarks()
¶
BookmarkService.php
:
54
List bookmarked locations.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $offset | int | 0 |
the start offset for paging |
| $limit | int | 25 |
the number of bookmarked locations returned |