BookmarkService

readonly class \TYPO3\CMS\Backend\Backend\Bookmark\BookmarkService

Uses
RouteParserTrait

Attributes

#[Autoconfigure]
$public: true

Table of Contents

Constants

GROUP_DEFAULT  : mixed = 0
GROUP_SUPERGLOBAL  : mixed = -100

Properties

$bookmarkGroupVoter  : BookmarkGroupVoter
$bookmarkRepository  : BookmarkRepository
$bookmarkVoter  : BookmarkVoter
$iconFactory  : IconFactory
$moduleProvider  : ModuleProvider
$router  : Router
$tcaSchemaFactory  : TcaSchemaFactory
$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()  : Bookmark[]
getGroups()  : 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

Methods

__construct()

public __construct(BookmarkRepository $bookmarkRepository, BookmarkVoter $bookmarkVoter, BookmarkGroupVoter $bookmarkGroupVoter, IconFactory $iconFactory, ModuleProvider $moduleProvider, Router $router, UriBuilder $uriBuilder, TcaSchemaFactory $tcaSchemaFactory) : mixed

Parameters

$bookmarkRepository : BookmarkRepository
$bookmarkVoter : BookmarkVoter
$bookmarkGroupVoter : BookmarkGroupVoter
$iconFactory : IconFactory
$moduleProvider : ModuleProvider
$router : Router
$uriBuilder : UriBuilder
$tcaSchemaFactory : TcaSchemaFactory

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

deleteBookmark()

public deleteBookmark(int $id) : array{success: bool, error?: string}

Parameters

$id : int

Return values

array{success: bool, error?: string}

deleteBookmarks()

public deleteBookmarks(int[] $bookmarkIds) : bool

Parameters

$bookmarkIds : int[]

Return values

bool

deleteGroup()

public deleteGroup(string $uuid) : bool

Parameters

$uuid : string

Return values

bool

hasBookmark()

public hasBookmark(string $routeIdentifier, string $arguments) : bool

Parameters

$routeIdentifier : string
$arguments : string

Return values

bool

isEnabled()

public isEnabled() : bool

Return values

bool

moveBookmarks()

public moveBookmarks(int[] $bookmarkIds, int|string $groupId) : bool

Parameters

$bookmarkIds : int[]
$groupId : int|string

Return values

bool

reorderBookmarks()

public reorderBookmarks(int[] $bookmarkIds) : bool

Parameters

$bookmarkIds : int[]

Return values

bool

reorderGroups()

public reorderGroups(string[] $uuids) : bool

Parameters

$uuids : string[]

Return values

bool

updateBookmark()

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

bool
On this page