Dashboard\Classes\DashManager\HasDataSources

Protected Properties

protected array $dataSources

dataSources registered with registerDataSourceClass, keyed by class name

Public Methods

public getDataSource()

public getDataSource(string $className): ?ReportDataSourceBase 

getDataSource returns a data source instance by its class name.

public getDefaultWidgetConfigs()

public getDefaultWidgetConfigs(): array 

getDefaultWidgetConfigs returns the default widget configuration for data source dimensions that have a defined type.

public listDataSourceClasses()

public listDataSourceClasses(): array 

listDataSourceClasses returns class and display names of the data sources available to the current user.

public registerDataSourceClass()

public registerDataSourceClass(
    string $className,
    string $displayName,
    array $permissions = []
): void 

registerDataSourceClass registers a report data source.

Protected Methods

protected hasDataSourcePermissions()

protected hasDataSourcePermissions($permissions): bool 

hasDataSourcePermissions checks the current user on every call, since the manager is shared between requests.