1. class
  2. Filament
  3. \
  4. Resources
  5. \
  6. Resource

Resource

abstract class Resource (View source)

Traits

Macroable

Properties

static protected string|null $breadcrumb
static protected Cluster> $cluster
static protected bool $isDiscovered
static protected bool $isGloballySearchable
static protected string|null deprecated $label
static protected string|null $modelLabel
static protected string|null $model
static protected string|null $navigationBadgeTooltip
static protected string|null $navigationGroup
static protected string|null $navigationParentItem
static protected string|null $navigationIcon
static protected string|null $activeNavigationIcon
static protected string|null $navigationLabel
static protected int|null $navigationSort
static protected string|null $recordRouteKeyName
static protected bool $shouldRegisterNavigation
static protected string|null deprecated $pluralLabel
static protected string|null $pluralModelLabel
static protected string|null $recordTitleAttribute
static protected string|null $slug
static protected bool $isScopedToTenant
static protected string|null $tenantOwnershipRelationshipName
static protected string|null $tenantRelationshipName
static protected string $routeMiddleware
static protected string $withoutRouteMiddleware
static protected int $globalSearchResultsLimit
static protected bool $shouldCheckPolicyExistence
static protected bool $shouldSkipAuthorization
static protected bool|null $isGlobalSearchForcedCaseInsensitive
static protected SubNavigationPosition $subNavigationPosition
static protected bool $hasTitleCaseModelLabel

Methods

static Form
form(Form $form)

No description

static Infolist
infolist(Infolist $infolist)

No description

static bool
canAccess()

No description

static void
registerNavigationItems()

No description

static array
getNavigationItems()

No description

static SubNavigationPosition
getSubNavigationPosition()

No description

static Table
table(Table $table)

No description

static Model|null
resolveRecordRouteBinding(int|string $key)

No description

static bool
can(string $action, Model|null $record = null)

No description

static Response|null
authorize(string $action, Model|null $record = null)

No description

static void
checkPolicyExistence(bool $condition = true)

No description

static void
skipAuthorization(bool $condition = true)

No description

static bool
shouldCheckPolicyExistence()

No description

static bool
shouldSkipAuthorization()

No description

static bool
canViewAny()

No description

static bool
canCreate()

No description

static bool
canEdit(Model $record)

No description

static bool
canDelete(Model $record)

No description

static bool
canDeleteAny()

No description

static bool
canForceDelete(Model $record)

No description

static bool
canForceDeleteAny()

No description

static bool
canReorder()

No description

static bool
canReplicate(Model $record)

No description

static bool
canRestore(Model $record)

No description

static bool
canRestoreAny()

No description

static bool
canView(Model $record)

No description

static void
authorizeViewAny()

No description

static void
authorizeCreate()

No description

static void
authorizeEdit(Model $record)

No description

static void
authorizeView(Model $record)

No description

static bool
canGloballySearch()

No description

static string
getBreadcrumb()

No description

static Builder
getEloquentQuery()

No description

static Builder
scopeEloquentQueryToTenant(Builder $query, Model|null $tenant)

No description

static array
getGloballySearchableAttributes()

No description

static array
getGlobalSearchResultActions(Model $record)

No description

static array
getGlobalSearchResultDetails(Model $record)

No description

static Htmlable
getGlobalSearchResultTitle(Model $record)

No description

static string|null
getGlobalSearchResultUrl(Model $record)

No description

static int
getGlobalSearchResultsLimit()

No description

static void
modifyGlobalSearchQuery(Builder $query, string $search)

No description

static Collection
getGlobalSearchResults(string $search)

No description

static string|null
getLabel() deprecated

No description

static string
getModelLabel()

No description

static string
getTitleCaseModelLabel()

No description

static string
getModel()

No description

static array
getPages()

No description

static string|null
getPluralLabel() deprecated

No description

static string
getPluralModelLabel()

No description

static string
getTitleCasePluralModelLabel()

No description

static void
titleCaseModelLabel(bool $condition = true)

No description

static bool
hasTitleCaseModelLabel()

No description

static string|null
getRecordTitleAttribute()

No description

static Htmlable|null
getRecordTitle(Model|null $record)

No description

static array
getRelations()

No description

static array
getWidgets()

No description

static string
getRouteBaseName(string|null $panel = null)

No description

static string|null
getRecordRouteKeyName()

No description

static void
registerRoutes(Panel $panel)

No description

static void
routes(Panel $panel)

No description

static string
getRelativeRouteName()

No description

static string
getRoutePrefix()

No description

static string|array
getRouteMiddleware(Panel $panel)

No description

static string|array
getWithoutRouteMiddleware(Panel $panel)

No description

static string
getEmailVerifiedMiddleware(Panel $panel)

No description

static bool
isEmailVerificationRequired(Panel $panel)

No description

static string
getTenantSubscribedMiddleware(Panel $panel)

No description

static bool
isTenantSubscriptionRequired(Panel $panel)

No description

static string
getSlug()

No description

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

No description

static bool
hasPage(string $page)

No description

static bool
hasRecordTitle()

No description

static bool|null
isGlobalSearchForcedCaseInsensitive()

No description

static void
applyGlobalSearchAttributeConstraints(Builder $query, string $search)

No description

static Builder
applyGlobalSearchAttributeConstraint(Builder $query, string $search, array $searchAttributes, bool $isFirst)

No description

static Builder
getGlobalSearchEloquentQuery()

No description

static string|null
getNavigationGroup()

No description

static string|null
getNavigationParentItem()

No description

static void
navigationGroup(string|null $group)

No description

static void
navigationParentItem(string|null $item)

No description

static Htmlable|null
getNavigationIcon()

No description

static void
navigationIcon(string|null $icon)

No description

static Htmlable|null
getActiveNavigationIcon()

No description

static string
getNavigationLabel()

No description

static string|null
getNavigationBadge()

No description

static string|null
getNavigationBadgeTooltip()

No description

static string|array|null
getNavigationBadgeColor()

No description

static int|null
getNavigationSort()

No description

static void
navigationLabel(string|null $label)

No description

static void
navigationSort(int|null $sort)

No description

static string
getNavigationUrl()

No description

static bool
shouldRegisterNavigation()

No description

static bool
isDiscovered()

No description

static void
scopeToTenant(bool $condition = true)

No description

static bool
isScopedToTenant()

No description

static string
getTenantOwnershipRelationshipName()

No description

static Relation
getTenantOwnershipRelationship(Model $record)

No description

static string
getTenantRelationshipName()

No description

static Relation
getTenantRelationship(Model $tenant)

No description

static array
getRecordSubNavigation(Page $page)

No description

static string|null
getCluster()

No description

Details

at line 126
static Form form(Form $form)

No description

Parameters

Form $form

Return Value

Form

at line 131
static Infolist infolist(Infolist $infolist)

No description

Parameters

Infolist $infolist

Return Value

Infolist

at line 136
static bool canAccess()

No description

Return Value

bool

at line 141
static void registerNavigationItems()

No description

Return Value

void

at line 162
static array getNavigationItems()

No description

Return Value

array

at line 178
static SubNavigationPosition getSubNavigationPosition()

No description

Return Value

SubNavigationPosition

at line 183
static Table table(Table $table)

No description

Parameters

Table $table

Return Value

Table

at line 188
static Model|null resolveRecordRouteBinding(int|string $key)

No description

Parameters

int|string $key

Return Value

Model|null

at line 195
static bool can(string $action, Model|null $record = null)

No description

Parameters

string $action
Model|null $record

Return Value

bool

at line 213
static Response|null authorize(string $action, Model|null $record = null)

No description

Parameters

string $action
Model|null $record

Return Value

Response|null

Exceptions

AuthorizationException

at line 228
static void checkPolicyExistence(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

at line 233
static void skipAuthorization(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

at line 238
static bool shouldCheckPolicyExistence()

No description

Return Value

bool

at line 243
static bool shouldSkipAuthorization()

No description

Return Value

bool

at line 248
static bool canViewAny()

No description

Return Value

bool

at line 253
static bool canCreate()

No description

Return Value

bool

at line 258
static bool canEdit(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 263
static bool canDelete(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 268
static bool canDeleteAny()

No description

Return Value

bool

at line 273
static bool canForceDelete(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 278
static bool canForceDeleteAny()

No description

Return Value

bool

at line 283
static bool canReorder()

No description

Return Value

bool

at line 288
static bool canReplicate(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 293
static bool canRestore(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 298
static bool canRestoreAny()

No description

Return Value

bool

at line 303
static bool canView(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 308
static void authorizeViewAny()

No description

Return Value

void

at line 313
static void authorizeCreate()

No description

Return Value

void

at line 318
static void authorizeEdit(Model $record)

No description

Parameters

Model $record

Return Value

void

at line 323
static void authorizeView(Model $record)

No description

Parameters

Model $record

Return Value

void

at line 328
static bool canGloballySearch()

No description

Return Value

bool

at line 333
static string getBreadcrumb()

No description

Return Value

string

at line 338
static Builder getEloquentQuery()

No description

Return Value

Builder

at line 352
static Builder scopeEloquentQueryToTenant(Builder $query, Model|null $tenant)

No description

Parameters

Builder $query
Model|null $tenant

Return Value

Builder

at line 378
static array getGloballySearchableAttributes()

No description

Return Value

array

at line 392
static array getGlobalSearchResultActions(Model $record)

No description

Parameters

Model $record

Return Value

array

at line 400
static array getGlobalSearchResultDetails(Model $record)

No description

Parameters

Model $record

Return Value

array

at line 405
static Htmlable getGlobalSearchResultTitle(Model $record)

No description

Parameters

Model $record

Return Value

Htmlable

at line 410
static string|null getGlobalSearchResultUrl(Model $record)

No description

Parameters

Model $record

Return Value

string|null

at line 441
static int getGlobalSearchResultsLimit()

No description

Return Value

int

at line 446
static void modifyGlobalSearchQuery(Builder $query, string $search)

No description

Parameters

Builder $query
string $search

Return Value

void

at line 448
static Collection getGlobalSearchResults(string $search)

No description

Parameters

string $search

Return Value

Collection

at line 479
static string|null getLabel() deprecated

deprecated Use `getModelLabel()` instead.

No description

Return Value

string|null

at line 484
static string getModelLabel()

No description

Return Value

string

at line 489
static string getTitleCaseModelLabel()

No description

Return Value

string

at line 498
static string getModel()

No description

Return Value

string

at line 508
static array getPages()

No description

Return Value

array

at line 516
static string|null getPluralLabel() deprecated

deprecated Use `getPluralModelLabel()` instead.

No description

Return Value

string|null

at line 521
static string getPluralModelLabel()

No description

Return Value

string

at line 534
static string getTitleCasePluralModelLabel()

No description

Return Value

string

at line 543
static void titleCaseModelLabel(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

at line 548
static bool hasTitleCaseModelLabel()

No description

Return Value

bool

at line 553
static string|null getRecordTitleAttribute()

No description

Return Value

string|null

at line 558
static Htmlable|null getRecordTitle(Model|null $record)

No description

Parameters

Model|null $record

Return Value

Htmlable|null

at line 566
static array getRelations()

No description

Return Value

array

at line 574
static array getWidgets()

No description

Return Value

array

at line 579
static string getRouteBaseName(string|null $panel = null)

No description

Parameters

string|null $panel

Return Value

string

at line 594
static string|null getRecordRouteKeyName()

No description

Return Value

string|null

at line 599
static void registerRoutes(Panel $panel)

No description

Parameters

Panel $panel

Return Value

void

at line 612
static void routes(Panel $panel)

No description

Parameters

Panel $panel

Return Value

void

at line 625
static string getRelativeRouteName()

No description

Return Value

string

at line 630
static string getRoutePrefix()

No description

Return Value

string

at line 638
static string|array getRouteMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string|array

| array

at line 646
static string|array getWithoutRouteMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string|array

| array

at line 651
static string getEmailVerifiedMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string

at line 656
static bool isEmailVerificationRequired(Panel $panel)

No description

Parameters

Panel $panel

Return Value

bool

at line 661
static string getTenantSubscribedMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string

at line 666
static bool isTenantSubscriptionRequired(Panel $panel)

No description

Parameters

Panel $panel

Return Value

bool

at line 671
static string getSlug()

No description

Return Value

string

at line 693
static string getUrl(string $name = 'index', array $parameters = [], bool $isAbsolute = true, string|null $panel = null, Model|null $tenant = null)

No description

Parameters

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

Return Value

string

at line 704
static bool hasPage(string $page)

No description

Parameters

string $page

Return Value

bool

at line 709
static bool hasRecordTitle()

No description

Return Value

bool

at line 714
static bool|null isGlobalSearchForcedCaseInsensitive()

No description

Return Value

bool|null

at line 719
static protected void applyGlobalSearchAttributeConstraints(Builder $query, string $search)

No description

Parameters

Builder $query
string $search

Return Value

void

at line 745
static protected Builder applyGlobalSearchAttributeConstraint(Builder $query, string $search, array $searchAttributes, bool $isFirst)

No description

Parameters

Builder $query
string $search
array $searchAttributes
bool $isFirst

Return Value

Builder

at line 780
static Builder getGlobalSearchEloquentQuery()

No description

Return Value

Builder

at line 785
static string|null getNavigationGroup()

No description

Return Value

string|null

at line 790
static string|null getNavigationParentItem()

No description

Return Value

string|null

at line 795
static void navigationGroup(string|null $group)

No description

Parameters

string|null $group

Return Value

void

at line 800
static void navigationParentItem(string|null $item)

No description

Parameters

string|null $item

Return Value

void

at line 805
static Htmlable|null getNavigationIcon()

No description

Return Value

Htmlable|null

at line 810
static void navigationIcon(string|null $icon)

No description

Parameters

string|null $icon

Return Value

void

at line 815
static Htmlable|null getActiveNavigationIcon()

No description

Return Value

Htmlable|null

at line 820
static string getNavigationLabel()

No description

Return Value

string

at line 825
static string|null getNavigationBadge()

No description

Return Value

string|null

at line 830
static string|null getNavigationBadgeTooltip()

No description

Return Value

string|null

at line 838
static string|array|null getNavigationBadgeColor()

No description

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string} | null

at line 843
static int|null getNavigationSort()

No description

Return Value

int|null

at line 848
static void navigationLabel(string|null $label)

No description

Parameters

string|null $label

Return Value

void

at line 853
static void navigationSort(int|null $sort)

No description

Parameters

int|null $sort

Return Value

void

at line 858
static string getNavigationUrl()

No description

Return Value

string

at line 863
static bool shouldRegisterNavigation()

No description

Return Value

bool

at line 868
static bool isDiscovered()

No description

Return Value

bool

at line 873
static void scopeToTenant(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

at line 878
static bool isScopedToTenant()

No description

Return Value

bool

at line 883
static string getTenantOwnershipRelationshipName()

No description

Return Value

string

at line 888
static Relation getTenantOwnershipRelationship(Model $record)

No description

Parameters

Model $record

Return Value

Relation

at line 902
static string getTenantRelationshipName()

No description

Return Value

string

at line 910
static Relation getTenantRelationship(Model $tenant)

No description

Parameters

Model $tenant

Return Value

Relation

at line 927
static array getRecordSubNavigation(Page $page)

No description

Parameters

Page $page

Return Value

array

at line 935
static string|null getCluster()

No description

Return Value

string|null

| null