TYPO3\CMS\Dashboard\DashboardRepository Class Reference

Public Member Functions
	__construct (protected readonly ConnectionPool $connectionPool, protected readonly WidgetRegistry $widgetRegistry, protected readonly ContainerInterface $container)
	getDashboardsForUser (int $userId)
	create (DashboardPreset $dashboardPreset, int $userId, string $title='')
int null	updateDashboardSettings (string $identifier, array $values)
	getDashboardByIdentifier (string $identifier)
	updateWidgetConfig (Dashboard $dashboard, array $widgets)
	delete (Dashboard $dashboard)

Protected Member Functions
	checkAllowedFields (array $values)
	createFromRow (array $row)
	getQueryBuilder ()

Protected Attributes
array	$allowedFields = ['title']
array	$widgets = []

Private Attributes
const	TABLE = 'be_dashboards'

Detailed Description

Definition at line 29 of file DashboardRepository.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Dashboard\DashboardRepository::__construct	(	protected readonly ConnectionPool	$connectionPool,
		protected readonly WidgetRegistry	$widgetRegistry,
		protected readonly ContainerInterface	$container
	)

Definition at line 43 of file DashboardRepository.php.

Member Function Documentation

checkAllowedFields()

TYPO3\CMS\Dashboard\DashboardRepository::checkAllowedFields ( array  $values )

protected

Definition at line 118 of file DashboardRepository.php.

References TYPO3\CMS\Dashboard\DashboardRepository\$allowedFields.

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\updateDashboardSettings().

create()

TYPO3\CMS\Dashboard\DashboardRepository::create	(	DashboardPreset	$dashboardPreset,
		int	$userId,
		string	$title = ''
	)

Definition at line 67 of file DashboardRepository.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Dashboard\DashboardRepository\$widgets, TYPO3\CMS\Dashboard\DashboardRepository\getDashboardByIdentifier(), TYPO3\CMS\Dashboard\DashboardPreset\getDefaultWidgets(), TYPO3\CMS\Dashboard\DashboardPreset\getIdentifier(), TYPO3\CMS\Dashboard\DashboardRepository\getQueryBuilder(), and TYPO3\CMS\Dashboard\DashboardPreset\getTitle().

createFromRow()

TYPO3\CMS\Dashboard\DashboardRepository::createFromRow ( array  $row )

protected

Definition at line 168 of file DashboardRepository.php.

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\getDashboardByIdentifier(), and TYPO3\CMS\Dashboard\DashboardRepository\getDashboardsForUser().

delete()

TYPO3\CMS\Dashboard\DashboardRepository::delete

(

Dashboard

$dashboard

)

Definition at line 158 of file DashboardRepository.php.

References TYPO3\CMS\Dashboard\DashboardRepository\getQueryBuilder().

getDashboardByIdentifier()

TYPO3\CMS\Dashboard\DashboardRepository::getDashboardByIdentifier

(

string

$identifier

)

Definition at line 130 of file DashboardRepository.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Dashboard\DashboardRepository\createFromRow(), and TYPO3\CMS\Dashboard\DashboardRepository\getQueryBuilder().

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\create().

getDashboardsForUser()

TYPO3\CMS\Dashboard\DashboardRepository::getDashboardsForUser

(

int

$userId

)

Definition at line 49 of file DashboardRepository.php.

References TYPO3\CMS\Dashboard\DashboardRepository\createFromRow(), and TYPO3\CMS\Dashboard\DashboardRepository\getQueryBuilder().

getQueryBuilder()

TYPO3\CMS\Dashboard\DashboardRepository::getQueryBuilder ( )

protected

Definition at line 180 of file DashboardRepository.php.

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\create(), TYPO3\CMS\Dashboard\DashboardRepository\delete(), TYPO3\CMS\Dashboard\DashboardRepository\getDashboardByIdentifier(), TYPO3\CMS\Dashboard\DashboardRepository\getDashboardsForUser(), TYPO3\CMS\Dashboard\DashboardRepository\updateDashboardSettings(), and TYPO3\CMS\Dashboard\DashboardRepository\updateWidgetConfig().

updateDashboardSettings()

int null TYPO3\CMS\Dashboard\DashboardRepository::updateDashboardSettings	(	string	$identifier,
		array	$values
	)

Returns

‪int|null

Definition at line 94 of file DashboardRepository.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Dashboard\DashboardRepository\checkAllowedFields(), and TYPO3\CMS\Dashboard\DashboardRepository\getQueryBuilder().

updateWidgetConfig()

TYPO3\CMS\Dashboard\DashboardRepository::updateWidgetConfig	(	Dashboard	$dashboard,
		array	$widgets
	)

Parameters

string[]

$widgets

Definition at line 148 of file DashboardRepository.php.

References TYPO3\CMS\Dashboard\DashboardRepository\$widgets, TYPO3\CMS\Dashboard\Dashboard\getIdentifier(), and TYPO3\CMS\Dashboard\DashboardRepository\getQueryBuilder().

Member Data Documentation

$allowedFields

array TYPO3\CMS\Dashboard\DashboardRepository::$allowedFields = ['title']

protected

Definition at line 36 of file DashboardRepository.php.

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\checkAllowedFields().

$widgets

array TYPO3\CMS\Dashboard\DashboardRepository::$widgets = []

protected

Definition at line 41 of file DashboardRepository.php.

Referenced by TYPO3\CMS\Dashboard\DashboardRepository\create(), and TYPO3\CMS\Dashboard\DashboardRepository\updateWidgetConfig().

TABLE

const TYPO3\CMS\Dashboard\DashboardRepository::TABLE = 'be_dashboards'

private

Definition at line 31 of file DashboardRepository.php.