BookmarkService uses RouteParserTrait
This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Constants
- GROUP_DEFAULT = 0
- GROUP_SUPERGLOBAL = -100
Properties
- $bookmarkGroupVoter : BookmarkGroupVoter
- $bookmarkRepository : BookmarkRepository
- $bookmarkVoter : BookmarkVoter
- $iconFactory : IconFactory
- $moduleProvider : ModuleProvider
- $router : Router
- $uriBuilder : UriBuilder
Methods
- __construct() : mixed
- createBookmark() : int|false
- createGroup() : BookmarkGroup|null
- deleteBookmark() : array{success: bool, error?: string}
- deleteBookmarks() : bool
- deleteGroup() : bool
- getBookmark() : Bookmark|null
- getBookmarks() : array<string|int, Bookmark>
- getGroups() : array<string|int, BookmarkGroup>
- hasBookmark() : bool
- isEnabled() : bool
- moveBookmarks() : bool
- reorderBookmarks() : bool
- reorderGroups() : bool
- updateBookmark() : array{success: bool, error?: string}
- updateGroup() : bool
- getRouter() : Router
Constants
GROUP_DEFAULT
public
mixed
GROUP_DEFAULT
= 0
GROUP_SUPERGLOBAL
public
mixed
GROUP_SUPERGLOBAL
= -100
Properties
$bookmarkGroupVoter read-only
protected
BookmarkGroupVoter
$bookmarkGroupVoter
$bookmarkRepository read-only
protected
BookmarkRepository
$bookmarkRepository
$bookmarkVoter read-only
protected
BookmarkVoter
$bookmarkVoter
$iconFactory read-only
protected
IconFactory
$iconFactory
$moduleProvider read-only
protected
ModuleProvider
$moduleProvider
$router read-only
protected
Router
$router
$uriBuilder read-only
protected
UriBuilder
$uriBuilder
Methods
__construct()
public
__construct(BookmarkRepository $bookmarkRepository, BookmarkVoter $bookmarkVoter, BookmarkGroupVoter $bookmarkGroupVoter, IconFactory $iconFactory, ModuleProvider $moduleProvider, Router $router, UriBuilder $uriBuilder) : mixed
Parameters
- $bookmarkRepository : BookmarkRepository
- $bookmarkVoter : BookmarkVoter
- $bookmarkGroupVoter : BookmarkGroupVoter
- $iconFactory : IconFactory
- $moduleProvider : ModuleProvider
- $router : Router
- $uriBuilder : UriBuilder
createBookmark()
public
createBookmark(string $routeIdentifier[, string $arguments = '' ][, string $title = '' ]) : int|false
Parameters
- $routeIdentifier : string
- $arguments : string = ''
- $title : string = ''
Return values
int|false —The ID of the newly created bookmark, or false on failure
createGroup()
public
createGroup(string $label) : BookmarkGroup|null
Parameters
- $label : string
Return values
BookmarkGroup|nulldeleteBookmark()
public
deleteBookmark(int $id) : array{success: bool, error?: string}
Parameters
- $id : int
Return values
array{success: bool, error?: string}deleteBookmarks()
public
deleteBookmarks(array<string|int, int> $bookmarkIds) : bool
Parameters
- $bookmarkIds : array<string|int, int>
Return values
booldeleteGroup()
public
deleteGroup(string $uuid) : bool
Parameters
- $uuid : string
Return values
boolgetBookmark()
public
getBookmark(int $id) : Bookmark|null
Parameters
- $id : int
Return values
Bookmark|nullgetBookmarks()
public
getBookmarks() : array<string|int, Bookmark>
Return values
array<string|int, Bookmark>getGroups()
public
getGroups() : array<string|int, BookmarkGroup>
Return values
array<string|int, BookmarkGroup>hasBookmark()
public
hasBookmark(string $routeIdentifier, string $arguments) : bool
Parameters
- $routeIdentifier : string
- $arguments : string
Return values
boolisEnabled()
public
isEnabled() : bool
Return values
boolmoveBookmarks()
public
moveBookmarks(array<string|int, int> $bookmarkIds, int|string $groupId) : bool
Parameters
- $bookmarkIds : array<string|int, int>
- $groupId : int|string
Return values
boolreorderBookmarks()
public
reorderBookmarks(array<string|int, int> $bookmarkIds) : bool
Parameters
- $bookmarkIds : array<string|int, int>
Return values
boolreorderGroups()
public
reorderGroups(array<string|int, string> $uuids) : bool
Parameters
- $uuids : array<string|int, string>
Return values
boolupdateBookmark()
public
updateBookmark(int $id, string $title, int|string $groupId) : array{success: bool, error?: string}
Parameters
- $id : int
- $title : string
- $groupId : int|string
Return values
array{success: bool, error?: string}updateGroup()
public
updateGroup(string $uuid, string $label) : bool
Parameters
- $uuid : string
- $label : string
Return values
boolgetRouter()
protected
getRouter() : Router