Copied!

Handler

Handler.php : 13

Methods

publiccountUserBookmarks()

Handler.php : 68

Count bookmarks owned by user.

public countUserBookmarks(int $userId) : int

Parameters

Name Type Default value Description
$userId int - -

Return values

int

publiccreate()

Handler.php : 22

Create a new bookmark.

public create(CreateStruct $createStruct) : Bookmark

Parameters

Name Type Default value Description
$createStruct CreateStruct - -

Return values

Bookmark

publicdelete()

Handler.php : 31

Delete a bookmark.

public delete(int $bookmarkId) : void

Parameters

Name Type Default value Description
$bookmarkId int - -
Tags
Throws
NotFoundException

publicloadByUserIdAndLocationId()

Handler.php : 41

Get bookmark by user id and location id.

public loadByUserIdAndLocationId(int $userId, array<string|int, mixed> $locationIds) : array<string|int, Bookmark>

Parameters

Name Type Default value Description
$userId int - -
$locationIds array<string|int, mixed> - -

Return values

array<string|int, Bookmark>

publicloadUserBookmarks()

Handler.php : 59

Loads bookmarks owned by user.

public loadUserBookmarks(int $userId[, int $offset = 0 ][, int $limit = -1 ]) : array<string|int, Bookmark>

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>

publicloadUserIdsByLocation()

Handler.php : 48

Get user ids who have bookmarked given location.

public loadUserIdsByLocation(Location $location) : array<string|int, int>

Parameters

Name Type Default value Description
$location Location - -

Return values

array<string|int, int>

publiclocationSwapped()

Handler.php : 78

Notifies the underlying engine that a location was swapped.

public locationSwapped(int $location1Id, int $location2Id) : void

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