1. class
  2. Filament
  3. \
  4. FilamentManager

FilamentManager

class FilamentManager (View source)

Properties

protected string|null $currentDomain
protected Panel|null $currentPanel
protected bool $isServing
protected bool $isCurrentPanelBooted
protected Model|null $tenant

Methods

__construct()

No description

Guard
auth()

No description

void
bootCurrentPanel()

No description

array
buildNavigation()

No description

string
getAuthGuard()

No description

string|null
getAuthPasswordBroker()

No description

Htmlable
getBrandName()

No description

Htmlable|null
getBrandLogo()

No description

string|null
getBrandLogoHeight()

No description

string
getCollapsedSidebarWidth()

No description

Panel|null
getCurrentPanel()

No description

Htmlable|null
getDarkModeBrandLogo()

No description

string|null
getDatabaseNotificationsPollingInterval()

No description

string
getDefaultAvatarProvider()

No description

Panel
getDefaultPanel()

No description

string|null
getEmailVerificationPromptUrl(array $parameters = [])

No description

string
getEmailVerifiedMiddleware()

No description

string|null
getFavicon()

No description

string
getFontFamily()

No description

Htmlable
getFontHtml()

No description

string
getFontProvider()

No description

string|null
getFontUrl()

No description

string
getGlobalSearchDebounce()

No description

array
getGlobalSearchKeyBindings()

No description

string|null
getGlobalSearchFieldSuffix()

No description

GlobalSearchProvider|null
getGlobalSearchProvider()

No description

string|null
getHomeUrl()

No description

string|null
getId()

No description

string|null
getLoginUrl(array $parameters = [])

No description

string
getLogoutUrl(array $parameters = [])

No description

MaxWidth|string|null
getMaxContentWidth()

No description

string|null
getModelResource(Model $model)

No description

string
getNameForDefaultAvatar(Authenticatable $record)

No description

array
getNavigation()

No description

array
getNavigationGroups()

No description

array
getNavigationItems()

No description

array
getClusteredComponents(string|null $cluster)

No description

array
getPages()

No description

Panel
getPanel(string|null $id = null, bool $isStrict = true)

No description

array
getPanels()

No description

Plugin
getPlugin(string $id)

No description

string|null
getProfileUrl(array $parameters = [])

No description

bool
isProfilePageSimple()

No description

string|null
getRegistrationUrl(array $parameters = [])

No description

string|null
getRequestPasswordResetUrl(array $parameters = [])

No description

string
getResetPasswordUrl(string $token, Authenticatable $user, array $parameters = [])

No description

array
getResources()

No description

string
getResourceUrl(Model $model, string $name = 'index', array $parameters = [], bool $isAbsolute = true, Model|null $tenant = null)

No description

string
getSidebarWidth()

No description

Model|null
getTenant()

No description

string
getTenantAvatarUrl(Model $tenant)

No description

Provider|null
getTenantBillingProvider()

No description

string|null
getTenantBillingUrl(array $parameters = [], Model|null $tenant = null)

No description

array
getTenantMenuItems()

No description

string|null
getTenantModel()

No description

string
getTenantName(Model $tenant)

No description

string
getTenantOwnershipRelationshipName()

No description

string|null
getProfilePage()

No description

string|null
getTenantProfilePage()

No description

string|null
getTenantProfileUrl(array $parameters = [])

No description

string|null
getTenantRegistrationPage()

No description

string|null
getTenantRegistrationUrl(array $parameters = [])

No description

Theme
getTheme()

No description

string
getUserAvatarUrl(Authenticatable $user)

No description

Model|null
getUserDefaultTenant(Authenticatable $user)

No description

array
getUserMenuItems()

No description

string
getUserName(Authenticatable $user)

No description

array
getUserTenants(Authenticatable $user)

No description

string|null
getUrl(Model|null $tenant = null)

No description

string
getVerifyEmailUrl(Authenticatable $user, array $parameters = [])

No description

array
getWidgets()

No description

bool
hasBreadcrumbs()

No description

bool
hasBroadcasting()

No description

bool
hasCollapsibleNavigationGroups()

No description

bool
hasDarkMode()

No description

bool
hasDarkModeForced()

No description

bool
hasDatabaseNotifications()

No description

bool
hasLazyLoadedDatabaseNotifications()

No description

bool
hasEmailVerification()

No description

bool
hasLogin()

No description

bool
hasNavigation()

No description

bool
hasPasswordReset()

No description

bool
hasPlugin(string $id)

No description

bool
hasProfile()

No description

bool
hasRegistration()

No description

bool
hasTenantMenu()

No description

bool
hasTenancy()

No description

bool
hasTenantBilling()

No description

bool
hasTenantProfile()

No description

bool
hasTenantRegistration()

No description

bool
hasTopbar()

No description

bool
hasTopNavigation()

No description

bool
hasUnsavedChangesAlerts()

No description

bool
isGlobalSearchEnabled()

No description

bool
isServing()

No description

bool
isSidebarCollapsibleOnDesktop()

No description

bool
isSidebarFullyCollapsibleOnDesktop()

No description

void
registerPanel(Panel $panel)

No description

Htmlable
renderHook(string $name) deprecated

No description

void
serving(Closure $callback)

No description

void
currentDomain(string|null $domain)

No description

void
setCurrentPanel(Panel|null $panel)

No description

void
setServingStatus(bool $condition = true)

No description

void
setTenant(Model|null $tenant, bool $isQuiet = false)

No description

void
registerNavigationGroups(array $groups) deprecated

No description

void
registerNavigationItems(array $items) deprecated

No description

void
registerPages(array $pages) deprecated

No description

void
registerRenderHook(string $name, Closure $hook) deprecated

No description

void
registerResources(array $resources) deprecated

No description

void
registerScripts(array $scripts, bool $shouldBeLoadedBeforeCoreScripts = false) deprecated

No description

void
registerScriptData(array $data) deprecated

No description

void
registerStyles(array $styles) deprecated

No description

void
registerTheme(Htmlable|null $theme) deprecated

No description

void
registerViteTheme(string|array $theme, string|null $buildDirectory = null) deprecated

No description

void
registerUserMenuItems(array $items) deprecated

No description

void
registerWidgets(array $widgets) deprecated

No description

ThemeMode
getDefaultThemeMode()

No description

bool
arePasswordsRevealable()

No description

string
getCurrentDomain(string|null $testingDomain = null)

No description

Details

at line 47
__construct()

No description

at line 54
Guard auth()

No description

Return Value

Guard

at line 59
void bootCurrentPanel()

No description

Return Value

void

at line 73
array buildNavigation()

No description

Return Value

array

at line 78
string getAuthGuard()

No description

Return Value

string

at line 83
string|null getAuthPasswordBroker()

No description

Return Value

string|null

at line 88
Htmlable getBrandName()

No description

Return Value

Htmlable

No description

Return Value

Htmlable|null

at line 98
string|null getBrandLogoHeight()

No description

Return Value

string|null

at line 103
string getCollapsedSidebarWidth()

No description

Return Value

string

at line 108
Panel|null getCurrentPanel()

No description

Return Value

Panel|null

No description

Return Value

Htmlable|null

at line 118
string|null getDatabaseNotificationsPollingInterval()

No description

Return Value

string|null

at line 123
string getDefaultAvatarProvider()

No description

Return Value

string

at line 131
Panel getDefaultPanel()

No description

Return Value

Panel

Exceptions

NoDefaultPanelSetException

at line 139
string|null getEmailVerificationPromptUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 144
string getEmailVerifiedMiddleware()

No description

Return Value

string

at line 149
string|null getFavicon()

No description

Return Value

string|null

at line 154
string getFontFamily()

No description

Return Value

string

at line 159
Htmlable getFontHtml()

No description

Return Value

Htmlable

at line 164
string getFontProvider()

No description

Return Value

string

at line 169
string|null getFontUrl()

No description

Return Value

string|null

at line 174
string getGlobalSearchDebounce()

No description

Return Value

string

at line 182
array getGlobalSearchKeyBindings()

No description

Return Value

array

at line 187
string|null getGlobalSearchFieldSuffix()

No description

Return Value

string|null

at line 192
GlobalSearchProvider|null getGlobalSearchProvider()

No description

Return Value

GlobalSearchProvider|null

at line 197
string|null getHomeUrl()

No description

Return Value

string|null

at line 202
string|null getId()

No description

Return Value

string|null

at line 210
string|null getLoginUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 218
string getLogoutUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string

at line 223
MaxWidth|string|null getMaxContentWidth()

No description

Return Value

MaxWidth|string|null

at line 228
string|null getModelResource(Model $model)

No description

Parameters

Model $model

Return Value

string|null

at line 233
string getNameForDefaultAvatar(Authenticatable $record)

No description

Parameters

Authenticatable $record

Return Value

string

at line 245
array getNavigation()

No description

Return Value

array

at line 253
array getNavigationGroups()

No description

Return Value

array

at line 261
array getNavigationItems()

No description

Return Value

array

at line 269
array getClusteredComponents(string|null $cluster)

No description

Parameters

string|null $cluster

Return Value

array

at line 277
array getPages()

No description

Return Value

array

at line 282
Panel getPanel(string|null $id = null, bool $isStrict = true)

No description

Parameters

string|null $id
bool $isStrict

Return Value

Panel

at line 290
array getPanels()

No description

Return Value

array

at line 295
Plugin getPlugin(string $id)

No description

Parameters

string $id

Return Value

Plugin

at line 303
string|null getProfileUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 308
bool isProfilePageSimple()

No description

Return Value

bool

at line 316
string|null getRegistrationUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 324
string|null getRequestPasswordResetUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 332
string getResetPasswordUrl(string $token, Authenticatable $user, array $parameters = [])

No description

Parameters

string $token
Authenticatable $user
array $parameters

Return Value

string

at line 340
array getResources()

No description

Return Value

array

at line 348
string getResourceUrl(Model $model, string $name = 'index', array $parameters = [], bool $isAbsolute = true, Model|null $tenant = null)

No description

Parameters

Model $model
string $name
array $parameters
bool $isAbsolute
Model|null $tenant

Return Value

string

at line 353
string getSidebarWidth()

No description

Return Value

string

at line 358
Model|null getTenant()

No description

Return Value

Model|null

at line 363
string getTenantAvatarUrl(Model $tenant)

No description

Parameters

Model $tenant

Return Value

string

at line 378
Provider|null getTenantBillingProvider()

No description

Return Value

Provider|null

at line 386
string|null getTenantBillingUrl(array $parameters = [], Model|null $tenant = null)

No description

Parameters

array $parameters
Model|null $tenant

Return Value

string|null

at line 394
array getTenantMenuItems()

No description

Return Value

array

at line 399
string|null getTenantModel()

No description

Return Value

string|null

at line 404
string getTenantName(Model $tenant)

No description

Parameters

Model $tenant

Return Value

string

at line 413
string getTenantOwnershipRelationshipName()

No description

Return Value

string

at line 418
string|null getProfilePage()

No description

Return Value

string|null

at line 423
string|null getTenantProfilePage()

No description

Return Value

string|null

at line 431
string|null getTenantProfileUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 438
string|null getTenantRegistrationPage()

No description

Return Value

string|null

at line 446
string|null getTenantRegistrationUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 451
Theme getTheme()

No description

Return Value

Theme

at line 456
string getUserAvatarUrl(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

string

at line 471
Model|null getUserDefaultTenant(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

Model|null

at line 490
array getUserMenuItems()

No description

Return Value

array

at line 495
string getUserName(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

string

at line 507
array getUserTenants(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

array

at line 518
string|null getUrl(Model|null $tenant = null)

No description

Parameters

Model|null $tenant

Return Value

string|null

at line 526
string getVerifyEmailUrl(Authenticatable $user, array $parameters = [])

No description

Parameters

Authenticatable $user
array $parameters

Return Value

string

at line 534
array getWidgets()

No description

Return Value

array

at line 539
bool hasBreadcrumbs()

No description

Return Value

bool

at line 544
bool hasBroadcasting()

No description

Return Value

bool

at line 549
bool hasCollapsibleNavigationGroups()

No description

Return Value

bool

at line 554
bool hasDarkMode()

No description

Return Value

bool

at line 559
bool hasDarkModeForced()

No description

Return Value

bool

at line 564
bool hasDatabaseNotifications()

No description

Return Value

bool

at line 569
bool hasLazyLoadedDatabaseNotifications()

No description

Return Value

bool

at line 574
bool hasEmailVerification()

No description

Return Value

bool

at line 579
bool hasLogin()

No description

Return Value

bool

at line 584
bool hasNavigation()

No description

Return Value

bool

at line 589
bool hasPasswordReset()

No description

Return Value

bool

at line 594
bool hasPlugin(string $id)

No description

Parameters

string $id

Return Value

bool

at line 599
bool hasProfile()

No description

Return Value

bool

at line 604
bool hasRegistration()

No description

Return Value

bool

at line 609
bool hasTenantMenu()

No description

Return Value

bool

at line 614
bool hasTenancy()

No description

Return Value

bool

at line 619
bool hasTenantBilling()

No description

Return Value

bool

at line 624
bool hasTenantProfile()

No description

Return Value

bool

at line 629
bool hasTenantRegistration()

No description

Return Value

bool

at line 634
bool hasTopbar()

No description

Return Value

bool

at line 639
bool hasTopNavigation()

No description

Return Value

bool

at line 644
bool hasUnsavedChangesAlerts()

No description

Return Value

bool

at line 649
bool isGlobalSearchEnabled()

No description

Return Value

bool

at line 664
bool isServing()

No description

Return Value

bool

at line 669
bool isSidebarCollapsibleOnDesktop()

No description

Return Value

bool

at line 674
bool isSidebarFullyCollapsibleOnDesktop()

No description

Return Value

bool

at line 679
void registerPanel(Panel $panel)

No description

Parameters

Panel $panel

Return Value

void

at line 687
Htmlable renderHook(string $name) deprecated

deprecated Use the `\Filament\Support\Facades\FilamentView::renderHook()` method instead.

No description

Parameters

string $name

Return Value

Htmlable

at line 692
void serving(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 697
void currentDomain(string|null $domain)

No description

Parameters

string|null $domain

Return Value

void

at line 702
void setCurrentPanel(Panel|null $panel)

No description

Parameters

Panel|null $panel

Return Value

void

at line 707
void setServingStatus(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

at line 712
void setTenant(Model|null $tenant, bool $isQuiet = false)

No description

Parameters

Model|null $tenant
bool $isQuiet

Return Value

void

at line 726
void registerNavigationGroups(array $groups) deprecated

deprecated Use the `navigationGroups()` method on the panel configuration instead.

No description

Parameters

array $groups

Return Value

void

at line 740
void registerNavigationItems(array $items) deprecated

deprecated Use the `navigationItems()` method on the panel configuration instead.

No description

Parameters

array $items

Return Value

void

at line 754
void registerPages(array $pages) deprecated

deprecated Use the `pages()` method on the panel configuration instead.

No description

Parameters

array $pages

Return Value

void

at line 766
void registerRenderHook(string $name, Closure $hook) deprecated

deprecated Use the `renderHook()` method on the panel configuration instead.

No description

Parameters

string $name
Closure $hook

Return Value

void

at line 776
void registerResources(array $resources) deprecated

deprecated Use the `resources()` method on the panel configuration instead.

No description

Parameters

array $resources

Return Value

void

at line 790
void registerScripts(array $scripts, bool $shouldBeLoadedBeforeCoreScripts = false) deprecated

deprecated Register scripts using the `FilamentAsset` facade instead.

No description

Parameters

array $scripts
bool $shouldBeLoadedBeforeCoreScripts

Return Value

void

at line 800
void registerScriptData(array $data) deprecated

deprecated Register script data using the `FilamentAsset` facade instead.

No description

Parameters

array $data

Return Value

void

at line 810
void registerStyles(array $styles) deprecated

deprecated Register styles using the `FilamentAsset` facade instead.

No description

Parameters

array $styles

Return Value

void

at line 818
void registerTheme(Htmlable|null $theme) deprecated

deprecated Use the `theme()` method on the panel configuration instead.

No description

Parameters

Htmlable|null $theme

Return Value

void

at line 832
void registerViteTheme(string|array $theme, string|null $buildDirectory = null) deprecated

deprecated Use the `viteTheme()` method on the panel configuration instead.

No description

Parameters

string|array $theme
string|null $buildDirectory

Return Value

void

at line 846
void registerUserMenuItems(array $items) deprecated

deprecated Use the `userMenuItems()` method on the panel configuration instead.

No description

Parameters

array $items

Return Value

void

at line 860
void registerWidgets(array $widgets) deprecated

deprecated Use the `widgets()` method on the panel configuration instead.

No description

Parameters

array $widgets

Return Value

void

at line 869
ThemeMode getDefaultThemeMode()

No description

Return Value

ThemeMode

at line 874
bool arePasswordsRevealable()

No description

Return Value

bool

at line 879
string getCurrentDomain(string|null $testingDomain = null)

No description

Parameters

string|null $testingDomain

Return Value

string