Handler
Handler.php
:
13
Methods¶
countUserBookmarks()
¶
Handler.php
:
68
Count bookmarks owned by user.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $userId | int | - | - |
Return values
int
create()
¶
Handler.php
:
22
Create a new bookmark.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $createStruct | CreateStruct | - | - |
Return values
delete()
¶
Handler.php
:
31
Delete a bookmark.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $bookmarkId | int | - | - |
Tags
loadByUserIdAndLocationId()
¶
Handler.php
:
41
Get bookmark by user id and location id.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $userId | int | - | - |
| $locationIds | array<string|int, mixed> | - | - |
Return values
array<string|int, Bookmark>
loadUserBookmarks()
¶
Handler.php
:
59
Loads bookmarks owned by user.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $userId | int | - | - |
| $offset | int | 0 |
the start offset for paging |
| $limit | int | -1 |
the number of bookmarked locations returned |
Return values
array<string|int, Bookmark>
loadUserIdsByLocation()
¶
Handler.php
:
48
Get user ids who have bookmarked given location.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $location | Location | - | - |
Return values
array<string|int, int>
locationSwapped()
¶
Handler.php
:
78
Notifies the underlying engine that a location was swapped.
|
|
|
This method triggers the change of the bookmarked locations.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $location1Id | int | - |
ID of first location |
| $location2Id | int | - |
ID of second location |