A

AdminServiceProviderClass in namespace Flarum\Admin
AdminPayloadClass in namespace Flarum\Admin\Content
WhenSavingSettings::afterSave() — Method in class WhenSavingSettings
AnnouncementsFetcherClass in namespace Flarum\Announcements
AnnouncementsServiceProviderClass in namespace Flarum\Announcements
ApiKeyClass in namespace Flarum\Api
$ApiKey#allowed_ipsProperty in class ApiKey
ApiKeyFactoryClass in namespace Flarum\Api
ApiServiceProviderClass in namespace Flarum\Api
$Client#actorProperty in class Client
AbstractDeleteControllerClass in namespace Flarum\Api\Controller
$HasAuthorization#authenticatedProperty in class HasAuthorization
$HasAuthorization#abilityProperty in class HasAuthorization
$HasAuthorization#adminProperty in class HasAuthorization
HasAuthorization::authenticated() — Method in class HasAuthorization
HasAuthorization::admin() — Method in class HasAuthorization
$HasHooks#afterProperty in class HasHooks
HasHooks::after() — Method in class HasHooks
IncludesData::addDefaultInclude() — Method in class IncludesData
SavesAndValidatesData::assertDataValid() — Method in class SavesAndValidatesData
Assert that the field values within a data object pass validation.
$Endpoint#actionProperty in class Endpoint
Endpoint::action() — Method in class Endpoint
Index::applySorts() — Method in class Index
Index::applyFilters() — Method in class Index
AbstractDatabaseResourceClass in namespace Flarum\Api\Resource
AbstractResourceClass in namespace Flarum\Api\Resource
AccessTokenResourceClass in namespace Flarum\Api\Resource
$Bootable#apiProperty in class Bootable
AttachableClass in namespace Flarum\Api\Resource\Contracts
EloquentBuffer::add() — Method in class EloquentBuffer
$ForumResource#assetsFilesystemProperty in class ForumResource
ArrClass in namespace Flarum\Api\Schema
AttributeClass in namespace Flarum\Api\Schema
GetsRelationAggregates::avgRelation() — Method in class GetsRelationAggregates
DateTime::after() — Method in class DateTime
DateTime::afterOrEqual() — Method in class DateTime
ArrClass in namespace Flarum\Api\Schema\Type
Serializer::addPrimary() — Method in class Serializer
Add a primary resource to the document.
Serializer::addIncluded() — Method in class Serializer
Add an included resource to the document.
$SortColumn#aliasProperty in class SortColumn
SortColumn::ascendingAlias() — Method in class SortColumn
AbstractCommandClass in namespace Flarum\Console
AbstractModelClass in namespace Flarum\Database
Base model class, building on Eloquent.
$AbstractModel#afterSaveCallbacksProperty in class AbstractModel
An array of callbacks to be run once after the model is saved.
$AbstractModel#afterDeleteCallbacksProperty in class AbstractModel
An array of callbacks to be run once after the model is deleted.
AbstractModel::afterSave() — Method in class AbstractModel
Register a callback to be run once after the model is saved.
AbstractModel::afterDelete() — Method in class AbstractModel
Register a callback to be run once after the model is deleted.
Migration::addColumns() — Method in class Migration
Migration::addSettings() — Method in class Migration
Add default values for config values.
Migration::addPermissions() — Method in class Migration
AuthorFilterClass in namespace Flarum\Discussion\Search\Filter
ApiResourceClass in namespace Flarum\Extend
AuthClass in namespace Flarum\Extend
Auth::addPasswordChecker() — Method in class Auth
Add a new password checker.
$Console#addCommandsProperty in class Console
Middleware::add() — Method in class Middleware
Adds a new middleware to the frontend.
ModelUrl::addSlugDriver() — Method in class ModelUrl
Add a slug driver.
SearchDriver::addSearcher() — Method in class SearchDriver
Add a filter to this searcher. Filters are used to filter search queries.
SearchDriver::addFilter() — Method in class SearchDriver
Add a filter to this searcher. Filters are used to filter search queries.
SearchDriver::addMutator() — Method in class SearchDriver
Add a callback through which to run all search queries after filters have been applied.
Theme::addCustomLessFunction() — Method in class Theme
This method allows you to add custom Less functions.
Theme::addCustomLessVariable() — Method in class Theme
Defines a new Less variable to be accessible in all Less files.
User::avatarDriver() — Method in class User
Add an avatar driver.
AbandonedExtensionsFetcherClass in namespace Flarum\Extension
BisectState::advance() — Method in class BisectState
$Extension#abandonedProperty in class Extension
Whether the composer package is marked as abandoned.
$Extension#authorsProperty in class Extension
$Extension#autoloadProperty in class Extension
$Extension#autoloadDevProperty in class Extension
Extension::assignId() — Method in class Extension
Assigns the id for the extension used globally.
Formatter::addConfigurationCallback() — Method in class Formatter
Formatter::addParsingCallback() — Method in class Formatter
Formatter::addUnparsingCallback() — Method in class Formatter
Formatter::addRenderingCallback() — Method in class Formatter
AssertRegisteredClass in namespace Flarum\Forum\Content
AbstractImageValidatorClass in namespace Flarum\Foundation
AbstractImageValidator::assertImageValid() — Method in class AbstractImageValidator
AbstractImageValidator::assertValid() — Method in class AbstractImageValidator
Throw an exception if a model is not valid.
AbstractImageValidator::assertFileRequired() — Method in class AbstractImageValidator
AbstractImageValidator::assertFileMimes() — Method in class AbstractImageValidator
AbstractImageValidator::assertFileSize() — Method in class AbstractImageValidator
AbstractServiceProviderClass in namespace Flarum\Foundation
AbstractValidatorClass in namespace Flarum\Foundation
AbstractValidator::addConfiguration() — Method in class AbstractValidator
AbstractValidator::assertValid() — Method in class AbstractValidator
Throw an exception if a model is not valid.
AppInterfaceClass in namespace Flarum\Foundation
ApplicationClass in namespace Flarum\Foundation
ApplicationInfoProviderClass in namespace Flarum\Foundation
AssetsPublishCommandClass in namespace Flarum\Foundation\Console
ApplicationBootedClass in namespace Flarum\Foundation\Event
The "application booted" event is fired after the application has finished booting and all extension boot callbacks have been run, but before any requests have been handled.
AddLocaleAssetsClass in namespace Flarum\Frontend
AddTranslationsClass in namespace Flarum\Frontend
AssetManagerClass in namespace Flarum\Frontend
$AssetManager#assetsProperty in class AssetManager
AssetManager::all() — Method in class AssetManager
AssetsClass in namespace Flarum\Frontend
A factory class for creating frontend asset compilers.
Assets::addLessImportOverrides() — Method in class Assets
Assets::addFileSourceOverrides() — Method in class Assets
CompilerInterface::addSources() — Method in class CompilerInterface
HasSources::addSources() — Method in class HasSources
HasSources::allowedSourceTypes() — Method in class HasSources
FileVersioner::allRevisions() — Method in class FileVersioner
JsDirectoryCompiler::allowedSourceTypes() — Method in class JsDirectoryCompiler
RevisionCompiler::allowedSourceTypes() — Method in class RevisionCompiler
SourceCollector::addFile() — Method in class SourceCollector
SourceCollector::addString() — Method in class SourceCollector
SourceCollector::addDirectory() — Method in class SourceCollector
VersionerInterface::allRevisions() — Method in class VersionerInterface
AssetsClass in namespace Flarum\Frontend\Content
$Assets#assetsProperty in class Assets
Assets::assembleCompilers() — Method in class Assets
Assembles JS and CSS compilers to be used to generate frontend assets.
Assets::addAssetsToDocument() — Method in class Assets
Adds URLs of frontend JS and CSS to the Document class.
$Document#appViewProperty in class Document
The name of the frontend app view to display.
FrontendServiceProvider::addBaseCss() — Method in class FrontendServiceProvider
AccessTokenClass in namespace Flarum\Http
AccessTokenFactoryClass in namespace Flarum\Http
AccessTokenPolicyClass in namespace Flarum\Http\Access
ActorReferenceClass in namespace Flarum\Http
AbstractHtmlControllerClass in namespace Flarum\Http\Controller
AccessTokenSearcherClass in namespace Flarum\Http\Filter
AccessTokenTypeFilterClass in namespace Flarum\Http\Filter
Filters an access tokens request by the token type.
AuthenticateWithHeaderClass in namespace Flarum\Http\Middleware
AuthenticateWithSessionClass in namespace Flarum\Http\Middleware
RouteCollection::addRoute() — Method in class RouteCollection
RouteCollection::applyRoutes() — Method in class RouteCollection
UrlGenerator::addCollection() — Method in class UrlGenerator
Register a named route collection for URL generation.
AdminUserClass in namespace Flarum\Install
$FileDataProvider#adminUserProperty in class FileDataProvider
Installation::adminUser() — Method in class Installation
Installation::accessToken() — Method in class Installation
LocaleManager::addLocale() — Method in class LocaleManager
LocaleManager::addTranslations() — Method in class LocaleManager
LocaleManager::addJsFile() — Method in class LocaleManager
LocaleManager::addCssFile() — Method in class LocaleManager
Repository::all() — Method in class Repository
Get all context data.
Repository::add() — Method in class Repository
Add a context value.
Repository::addHidden() — Method in class Repository
Add a hidden context value.
Repository::allHidden() — Method in class Repository
Get all hidden context data.
DriverInterface::availableSettings() — Method in class DriverInterface
Provide a list of settings for this driver.
LogDriver::availableSettings() — Method in class LogDriver
Provide a list of settings for this driver.
MailgunDriver::availableSettings() — Method in class MailgunDriver
Provide a list of settings for this driver.
NullDriver::availableSettings() — Method in class NullDriver
Provide a list of settings for this driver.
PostmarkDriver::availableSettings() — Method in class PostmarkDriver
Provide a list of settings for this driver.
SendmailDriver::availableSettings() — Method in class SendmailDriver
Provide a list of settings for this driver.
SmtpDriver::availableSettings() — Method in class SmtpDriver
Provide a list of settings for this driver.
AlertableInterfaceClass in namespace Flarum\Notification
The notification Alert driver only picks up notifications that implement this interface.
AlertNotificationDriverClass in namespace Flarum\Notification\Driver
NotificationServiceProvider::addType() — Method in class NotificationServiceProvider
NotificationSyncer::addNotificationDriver() — Method in class NotificationSyncer
AbstractEventPostClass in namespace Flarum\Post
AuthorFilterClass in namespace Flarum\Post\Filter
RegisteredTypesScope::apply() — Method in class RegisteredTypesScope
Apply the scope to a given Eloquent query builder.
AbstractJobClass in namespace Flarum\Queue
DatabaseWorkerArgs::args() — Method in class DatabaseWorkerArgs
Listener::addEnvironment() — Method in class Listener
Listener::artisanBinary() — Method in class Listener
AbstractDriverClass in namespace Flarum\Search
AbstractFulltextFilterClass in namespace Flarum\Search
AbstractSearcherClass in namespace Flarum\Search\Database
AbstractSearcher::applySort() — Method in class AbstractSearcher
AbstractSearcher::applyOffset() — Method in class AbstractSearcher
AbstractSearcher::applyLimit() — Method in class AbstractSearcher
FilterManager::add() — Method in class FilterManager
FilterManager::apply() — Method in class FilterManager
FilterManager::applyFilters() — Method in class FilterManager
FilterManager::applyFulltext() — Method in class FilterManager
SearchResults::areMoreResults() — Method in class SearchResults
$SearchState#activeFiltersProperty in class SearchState
SearchState::addActiveFilter() — Method in class SearchState
ValidateFilterTrait::asStringArray() — Method in class ValidateFilterTrait
ValidateFilterTrait::asString() — Method in class ValidateFilterTrait
ValidateFilterTrait::asInt() — Method in class ValidateFilterTrait
ValidateFilterTrait::asIntArray() — Method in class ValidateFilterTrait
ValidateFilterTrait::asBool() — Method in class ValidateFilterTrait
DatabaseSettingsRepository::all() — Method in class DatabaseSettingsRepository
DefaultSettingsRepository::all() — Method in class DefaultSettingsRepository
MemoryCacheSettingsRepository::all() — Method in class MemoryCacheSettingsRepository
OverrideSettingsRepository::all() — Method in class OverrideSettingsRepository
SettingsRepositoryInterface::all() — Method in class SettingsRepositoryInterface
UninstalledSettingsRepository::all() — Method in class UninstalledSettingsRepository
AbstractPolicyClass in namespace Flarum\User\Access
AbstractPolicy::allow() — Method in class AbstractPolicy
Gate::allows() — Method in class Gate
Determine if the given ability should be granted for the current user.
AccountActivationMailerClass in namespace Flarum\User
AccountActivationMailerTraitClass in namespace Flarum\User
AvatarUploaderClass in namespace Flarum\User
AvatarValidatorClass in namespace Flarum\User
DefaultDriver::avatarUrl() — Method in class DefaultDriver
Return an avatar URL for a user.
DefaultDriver::avatarSrcset() — Method in class DefaultDriver
Return a srcset string for a user's avatar, or null if not supported.
DriverInterface::avatarUrl() — Method in class DriverInterface
Return an avatar URL for a user.
DriverInterface::avatarSrcset() — Method in class DriverInterface
Return a srcset string for a user's avatar, or null if not supported.
ActivatedClass in namespace Flarum\User\Event
AvatarChangedClass in namespace Flarum\User\Event
AvatarDeletingClass in namespace Flarum\User\Event
AvatarSavingClass in namespace Flarum\User\Event
$User#avatarDriverProperty in class User
A driver for getting avatar URLs.
$User#avatar_urlProperty in class User
$User#accessTokensProperty in class User
User::activate() — Method in class User
User::assertPermission() — Method in class User
Ensure the current user is allowed to do something.
User::assertRegistered() — Method in class User
Ensure the given actor is authenticated.
User::assertCan() — Method in class User
User::assertAdmin() — Method in class User
User::accessTokens() — Method in class User
User::addGroupProcessor() — Method in class User
Register a callback that processes a user's list of groups.

B

AdminServiceProvider::boot() — Method in class AdminServiceProvider
WhenSavingSettings::beforeSave() — Method in class WhenSavingSettings
AnnouncementsServiceProvider::boot() — Method in class AnnouncementsServiceProvider
ApiServiceProvider::boot() — Method in class ApiServiceProvider
$Client#bodyProperty in class Client
$HasHooks#beforeProperty in class HasHooks
HasHooks::before() — Method in class HasHooks
$Endpoint#beforeSerializationProperty in class Endpoint
Endpoint::beforeSerialization() — Method in class Endpoint
$JsonApi#baseRequestProperty in class JsonApi
BootableClass in namespace Flarum\Api\Resource\Concerns
Bootable::boot() — Method in class Bootable
Avoids polluting the constructor of the resource with dependencies.
BooleanClass in namespace Flarum\Api\Schema
DateTime::before() — Method in class DateTime
DateTime::beforeOrEqual() — Method in class DateTime
BusServiceProviderClass in namespace Flarum\Bus
ConsoleServiceProvider::boot() — Method in class ConsoleServiceProvider
AbstractModel::boot() — Method in class AbstractModel
DatabaseServiceProvider::boot() — Method in class DatabaseServiceProvider
Discussion::boot() — Method in class Discussion
DiscussionServiceProvider::boot() — Method in class DiscussionServiceProvider
Model::belongsTo() — Method in class Model
Establish a simple belongsTo relationship from this model to another model.
Model::belongsToMany() — Method in class Model
Establish a simple belongsToMany relationship from this model to another model.
Notification::beforeSending() — Method in class Notification
BisectClass in namespace Flarum\Extension
$Bisect#breakProperty in class Bisect
When running bisect across multiple processes (such as multiple HTTP requests), this flag can be used to stop the bisect process after the first step it completes.
Bisect::break() — Method in class Bisect
Bisect::bisect() — Method in class Bisect
BisectStateClass in namespace Flarum\Extension
BisectCommandClass in namespace Flarum\Extension\Console
ExtensionServiceProvider::boot() — Method in class ExtensionServiceProvider
DriverInterface::build() — Method in class DriverInterface
Construct a Laravel Cloud filesystem for this filesystem driver.
ForumServiceProvider::boot() — Method in class ForumServiceProvider
$LogInValidator#basicProperty in class LogInValidator
LogInValidator::basic() — Method in class LogInValidator
$Application#bootedProperty in class Application
$Application#bootingCallbacksProperty in class Application
$Application#bootedCallbacksProperty in class Application
Application::boot() — Method in class Application
Application::bootProvider() — Method in class Application
Application::booting() — Method in class Application
Application::booted() — Method in class Application
InteractsWithLaravel::basePath() — Method in class InteractsWithLaravel
InteractsWithLaravel::bootstrapPath() — Method in class InteractsWithLaravel
InteractsWithLaravel::bootstrapWith() — Method in class InteractsWithLaravel
InstalledApp::basePath() — Method in class InstalledApp
InstalledSite::bootApp() — Method in class InstalledSite
Create and boot a Flarum application instance.
InstalledSite::bootLaravel() — Method in class InstalledSite
$Paths#baseProperty in class Paths
SiteInterface::bootApp() — Method in class SiteInterface
Create and boot a Flarum application instance.
UninstalledSite::bootApp() — Method in class UninstalledSite
Create and boot a Flarum application instance.
UninstalledSite::bootLaravel() — Method in class UninstalledSite
BasicTitleDriverClass in namespace Flarum\Frontend\Driver
FrontendServiceProvider::boot() — Method in class FrontendServiceProvider
Group::boot() — Method in class Group
GroupServiceProvider::boot() — Method in class GroupServiceProvider
HttpServiceProvider::boot() — Method in class HttpServiceProvider
RouteCollectionUrlGenerator::base() — Method in class RouteCollectionUrlGenerator
BaseUrlClass in namespace Flarum\Install
$FileDataProvider#baseUrlProperty in class FileDataProvider
$UserDataProvider#baseUrlProperty in class UserDataProvider
InstallServiceProvider::boot() — Method in class InstallServiceProvider
Installation::baseUrl() — Method in class Installation
Installation::build() — Method in class Installation
DriverInterface::buildTransport() — Method in class DriverInterface
Build a mail transport based on Flarum's current settings.
LogDriver::buildTransport() — Method in class LogDriver
Build a mail transport based on Flarum's current settings.
MailServiceProvider::boot() — Method in class MailServiceProvider
MailgunDriver::buildTransport() — Method in class MailgunDriver
Build a mail transport based on Flarum's current settings.
NullDriver::buildTransport() — Method in class NullDriver
Build a mail transport based on Flarum's current settings.
PostmarkDriver::buildTransport() — Method in class PostmarkDriver
Build a mail transport based on Flarum's current settings.
SendmailDriver::buildTransport() — Method in class SendmailDriver
Build a mail transport based on Flarum's current settings.
SmtpDriver::buildTransport() — Method in class SmtpDriver
Build a mail transport based on Flarum's current settings.
BlueprintInterfaceClass in namespace Flarum\Notification\Blueprint
A notification BlueprintInterface, when instantiated, represents a notification about something. The blueprint is used by the NotificationSyncer to commit the notification to the database.
NotificationServiceProvider::boot() — Method in class NotificationServiceProvider
$NotificationSyncer#beforeSendingCallbacksProperty in class NotificationSyncer
NotificationSyncer::beforeSending() — Method in class NotificationSyncer
CommentPost::boot() — Method in class CommentPost
DiscussionRenamedPost::buildContent() — Method in class DiscussionRenamedPost
Post::boot() — Method in class Post
PostServiceProvider::boot() — Method in class PostServiceProvider
IndexerInterface::build() — Method in class IndexerInterface
Build the index from scratch.
SearchServiceProvider::boot() — Method in class SearchServiceProvider
SettingsServiceProvider::boot() — Method in class SettingsServiceProvider
UpdateServiceProvider::boot() — Method in class UpdateServiceProvider
BackfillAvatarVariantsCommandClass in namespace Flarum\User\Console
Populate the `has_avatar_2x` / `has_avatar_3x` columns for users whose avatars predate variant tracking (uploaded before the columns existed, or uploaded by a future code path that didn't set them).
SessionDriverInterface::build() — Method in class SessionDriverInterface
Build a session handler to handle sessions.
User::boot() — Method in class User
UserServiceProvider::boot() — Method in class UserServiceProvider

C

$ApiKey#castsProperty in class ApiKey
$ApiKey#created_atProperty in class ApiKey
ClientClass in namespace Flarum\Api
ClientMiddlewarePipeClass in namespace Flarum\Api
ContextClass in namespace Flarum\Api
Context::creating() — Method in class Context
ClearCacheControllerClass in namespace Flarum\Api\Controller
CreateTokenControllerClass in namespace Flarum\Api\Controller
Not to be confused with the CreateAccessTokenController, this controller is used to authenticate a user with credentials, and return a system generated session-type access token.
HasAuthorization::can() — Method in class HasAuthorization
HasEagerLoading::compileSimpleEagerLoads() — Method in class HasEagerLoading
HasEagerLoading::compileWhereEagerLoads() — Method in class HasEagerLoading
HasHooks::callBeforeHook() — Method in class HasHooks
HasHooks::callAfterHook() — Method in class HasHooks
CreateClass in namespace Flarum\Api\Endpoint
$JsonApi#containerProperty in class JsonApi
JsonApi::container() — Method in class JsonApi
AbstractDatabaseResource::count() — Method in class AbstractDatabaseResource
AbstractDatabaseResource::create() — Method in class AbstractDatabaseResource
AccessTokenResource::created() — Method in class AccessTokenResource
$Extendable#cachedEndpointsProperty in class Extendable
$Extendable#cachedFieldsProperty in class Extendable
$Extendable#cachedSortsProperty in class Extendable
HasHooks::createAction() — Method in class HasHooks
HasHooks::creating() — Method in class HasHooks
HasHooks::created() — Method in class HasHooks
CountableClass in namespace Flarum\Api\Resource\Contracts
Countable::count() — Method in class Countable
Count the models for the given query.
CreatableClass in namespace Flarum\Api\Resource\Contracts
DiscussionResource::creating() — Method in class DiscussionResource
DiscussionResource::created() — Method in class DiscussionResource
PostResource::created() — Method in class PostResource
GetsRelationAggregates::countRelation() — Method in class GetsRelationAggregates
ConsoleServiceProviderClass in namespace Flarum\Console
$Schedule#configProperty in class Schedule
$AbstractModel#customCastsProperty in class AbstractModel
GenerateDumpCommand::configure() — Method in class GenerateDumpCommand
MigrateCommand::configure() — Method in class MigrateCommand
ResetCommand::configure() — Method in class ResetCommand
DatabaseMigrationRepository::createRepository() — Method in class DatabaseMigrationRepository
Create the migration repository data store.
CollectionClass in namespace Flarum\Database\Eloquent
Migration::createTable() — Method in class Migration
Migration::createTableIfNotExists() — Method in class Migration
MigrationRepositoryInterface::createRepository() — Method in class MigrationRepositoryInterface
Create the migration repository table.
DiscussionPolicy::can() — Method in class DiscussionPolicy
$Discussion#castsProperty in class Discussion
$Discussion#comment_countProperty in class Discussion
$Discussion#created_atProperty in class Discussion
$Discussion#commentsProperty in class Discussion
Discussion::comments() — Method in class Discussion
The discussion's publicly-visible comments.
AuthorFilter::constrain() — Method in class AuthorFilter
CreatedFilterClass in namespace Flarum\Discussion\Search\Filter
CreatedFilter::constrain() — Method in class CreatedFilter
HiddenFilter::constrain() — Method in class HiddenFilter
UnreadFilter::constrain() — Method in class UnreadFilter
$UserState#castsProperty in class UserState
ConditionalClass in namespace Flarum\Extend
The Conditional extender allows developers to conditionally apply other extenders based on either boolean values or results from callable functions.
$Conditional#conditionsProperty in class Conditional
An array of conditions and their associated extenders.
ConsoleClass in namespace Flarum\Extend
Console::command() — Method in class Console
CsrfClass in namespace Flarum\Extend
$Csrf#csrfExemptRoutesProperty in class Csrf
Formatter::configure() — Method in class Formatter
Configure the formatter. This can be used to add support for custom markdown/bbcode/etc tags, or otherwise change the formatter. Please see documentation for the s9e text formatter library for more information on how to use this.
Frontend::css() — Method in class Frontend
Add a CSS file to load in the frontend.
Frontend::content() — Method in class Frontend
Modify the content of the frontend.
Model::cast() — Method in class Model
Add a custom attribute type cast. Should not be applied to non-extension attributes.
ModelPrivate::checker() — Method in class ModelPrivate
Add a model privacy checker.
Validator::configure() — Method in class Validator
Configure the validator. This is often used to adjust validation rules, but can be used to make other changes to the validator as well.
Bisect::checkIssueUsing() — Method in class Bisect
BisectState::continue() — Method in class BisectState
BisectState::continueOrStart() — Method in class BisectState
ToggleExtensionCommand::configure() — Method in class ToggleExtensionCommand
CircularDependenciesExceptionClass in namespace Flarum\Extension\Exception
CircularDependenciesExceptionHandlerClass in namespace Flarum\Extension\Exception
$Extension#conflictProperty in class Extension
Extension::composerJsonAttribute() — Method in class Extension
Dot notation getter for composer.json attributes.
Extension::calculateDependencies() — Method in class Extension
Get the list of flarum extensions that this extension depends on.
Extension::copyAssetsTo() — Method in class Extension
$Formatter#configurationCallbacksProperty in class Formatter
Formatter::configureExternalLinks() — Method in class Formatter
Formatter::configureDefaultsOnLinks() — Method in class Formatter
Formatter::convert() — Method in class Formatter
Converts a plain text string (with or without Markdown) to it's HTML equivalent.
$HasFormattedContent#contentProperty in class HasFormattedContent
ConfirmEmailControllerClass in namespace Flarum\Forum\Controller
ConfirmEmailViewControllerClass in namespace Flarum\Forum\Controller
$AbstractServiceProvider#containerProperty in class AbstractServiceProvider
$AbstractValidator#configurationProperty in class AbstractValidator
Application::config() — Method in class Application
InteractsWithLaravel::configPath() — Method in class InteractsWithLaravel
ConfigClass in namespace Flarum\Foundation
AssetsPublishCommand::configure() — Method in class AssetsPublishCommand
CacheClearCommandClass in namespace Flarum\Foundation\Console
CacheClearCommand::configure() — Method in class CacheClearCommand
InfoCommand::configure() — Method in class InfoCommand
ContainerUtilClass in namespace Flarum\Foundation
ClearingCacheClass in namespace Flarum\Foundation\Event
FontAwesome::cdnUrl() — Method in class FontAwesome
FontAwesome::configOverride() — Method in class FontAwesome
MaintenanceMode::configOverride() — Method in class MaintenanceMode
Assets::css() — Method in class Assets
CompilerInterfaceClass in namespace Flarum\Frontend\Compiler
CompilerInterface::commit() — Method in class CompilerInterface
JsDirectoryCompiler::commit() — Method in class JsDirectoryCompiler
JsDirectoryCompiler::compileSource() — Method in class JsDirectoryCompiler
JsDirectoryCompiler::compilerFor() — Method in class JsDirectoryCompiler
$LessCompiler#cacheDirProperty in class LessCompiler
$LessCompiler#customFunctionsProperty in class LessCompiler
LessCompiler::compile() — Method in class LessCompiler
RevisionCompiler::commit() — Method in class RevisionCompiler
RevisionCompiler::compile() — Method in class RevisionCompiler
RevisionCompiler::calculateRevision() — Method in class RevisionCompiler
$Assets#commonAssetsProperty in class Assets
CorePayloadClass in namespace Flarum\Frontend\Content
ControllerClass in namespace Flarum\Frontend
$Document#contentViewProperty in class Document
The name of the frontend content view to display.
$Document#contentProperty in class Document
The SEO content of the page, displayed within the layout in
$Document#canonicalUrlProperty in class Document
The canonical URL for this page.
$Document#criticalCssProperty in class Document
Inline critical CSS emitted before the main stylesheet link.
$Document#cssProperty in class Document
An array of CSS URLs to load.
$Frontend#contentProperty in class Frontend
Frontend::content() — Method in class Frontend
GroupPolicy::can() — Method in class GroupPolicy
CreatedClass in namespace Flarum\Group\Event
$Group#castsProperty in class Group
$Group#colorProperty in class Group
$Permission#castsProperty in class Permission
$AccessToken#castsProperty in class AccessToken
$AccessToken#created_atProperty in class AccessToken
CookieFactoryClass in namespace Flarum\Http
CheckCsrfTokenClass in namespace Flarum\Http\Middleware
CheckForMaintenanceModeClass in namespace Flarum\Http\Middleware
CollectGarbageClass in namespace Flarum\Http\Middleware
ContentTypeOptionsHeaderClass in namespace Flarum\Http\Middleware
$StartSession#configProperty in class StartSession
DataProviderInterface::configure() — Method in class DataProviderInterface
FileDataProvider::configure() — Method in class FileDataProvider
InstallCommand::configure() — Method in class InstallCommand
UserDataProvider::configure() — Method in class UserDataProvider
Installation::configPath() — Method in class Installation
CompositeClass in namespace Flarum\Install\Prerequisite
ConnectToDatabaseClass in namespace Flarum\Install\Steps
CreateAdminUserClass in namespace Flarum\Install\Steps
$LocaleManager#cssProperty in class LocaleManager
LocaleManager::clearCache() — Method in class LocaleManager
Translator::choice() — Method in class Translator
DriverInterface::canSend() — Method in class DriverInterface
Does this driver actually send out emails?
LogDriver::canSend() — Method in class LogDriver
Does this driver actually send out emails?
MailgunDriver::canSend() — Method in class MailgunDriver
Does this driver actually send out emails?
NullDriver::canSend() — Method in class NullDriver
Does this driver actually send out emails?
PostmarkDriver::canSend() — Method in class PostmarkDriver
Does this driver actually send out emails?
SendmailDriver::canSend() — Method in class SendmailDriver
Does this driver actually send out emails?
SmtpDriver::canSend() — Method in class SmtpDriver
Does this driver actually send out emails?
$Notification#castsProperty in class Notification
$Notification#created_atProperty in class Notification
$UnsubscribeToken#castsProperty in class UnsubscribeToken
$UnsubscribeToken#created_atProperty in class UnsubscribeToken
$AbstractEventPost#contentProperty in class AbstractEventPost
PostPolicy::can() — Method in class PostPolicy
CommentPostClass in namespace Flarum\Post
A standard comment in a discussion.
$Post#castsProperty in class Post
$Post#created_atProperty in class Post
$Post#contentProperty in class Post
QueueFactory::connection() — Method in class QueueFactory
Resolve a queue connection instance.
$QueueServiceProvider#commandsProperty in class QueueServiceProvider
ModelObserver::created() — Method in class ModelObserver
$MemoryCacheSettingsRepository#cacheProperty in class MemoryCacheSettingsRepository
AbstractPolicy::checkAbility() — Method in class AbstractPolicy
UserPolicy::can() — Method in class UserPolicy
ConfirmEmailClass in namespace Flarum\User\Command
ConfirmEmailHandlerClass in namespace Flarum\User\Command
BackfillAvatarVariantsCommand::configure() — Method in class BackfillAvatarVariantsCommand
ConvertAvatarsToWebpCommandClass in namespace Flarum\User\Console
ConvertAvatarsToWebpCommand::configure() — Method in class ConvertAvatarsToWebpCommand
$EmailToken#castsProperty in class EmailToken
$EmailToken#created_atProperty in class EmailToken
$LoginProvider#castsProperty in class LoginProvider
$LoginProvider#created_atProperty in class LoginProvider
$PasswordToken#castsProperty in class PasswordToken
$PasswordToken#created_atProperty in class PasswordToken
$RegistrationToken#castsProperty in class RegistrationToken
$RegistrationToken#created_atProperty in class RegistrationToken
EmailFilter::constrain() — Method in class EmailFilter
GroupFilter::constrain() — Method in class GroupFilter
TokensClearer::clearPasswordTokens() — Method in class TokensClearer
TokensClearer::clearEmailTokens() — Method in class TokensClearer
TokensClearer::clearAccessTokens() — Method in class TokensClearer
$User#castsProperty in class User
$User#comment_countProperty in class User
User::changeEmail() — Method in class User
User::changePassword() — Method in class User
User::changeAvatarPath() — Method in class User
User::checkPassword() — Method in class User
User::can() — Method in class User
User::cannot() — Method in class User

D

DisableBrowserCacheClass in namespace Flarum\Admin\Middleware
$RefreshAnnouncementsCommand#descriptionProperty in class RefreshAnnouncementsCommand
ApiKeyFactory::definition() — Method in class ApiKeyFactory
Client::delete() — Method in class Client
Context::deleting() — Method in class Context
AbstractDeleteController::delete() — Method in class AbstractDeleteController
ClearCacheController::delete() — Method in class ClearCacheController
DeleteAllNotificationsControllerClass in namespace Flarum\Api\Controller
DeleteAllNotificationsController::delete() — Method in class DeleteAllNotificationsController
DeleteFaviconControllerClass in namespace Flarum\Api\Controller
DeleteFaviconController::delete() — Method in class DeleteFaviconController
DeleteLogoControllerClass in namespace Flarum\Api\Controller
DeleteLogoController::delete() — Method in class DeleteLogoController
DeleteLogoDarkModeControllerClass in namespace Flarum\Api\Controller
DeleteSettingsControllerClass in namespace Flarum\Api\Controller
ReadAllNotificationsController::delete() — Method in class ReadAllNotificationsController
TerminateAllOtherSessionsController::delete() — Method in class TerminateAllOtherSessionsController
UninstallExtensionController::delete() — Method in class UninstallExtensionController
$ExtractsListingParams#defaultSortProperty in class ExtractsListingParams
ExtractsListingParams::defaultExtracts() — Method in class ExtractsListingParams
DeleteClass in namespace Flarum\Api\Endpoint
Index::defaultSort() — Method in class Index
AbstractDatabaseResource::delete() — Method in class AbstractDatabaseResource
AccessTokenResource::delete() — Method in class AccessTokenResource
HasHooks::deleteAction() — Method in class HasHooks
HasHooks::deleting() — Method in class HasHooks
HasHooks::deleted() — Method in class HasHooks
HasHooks::dispatchEventsFor() — Method in class HasHooks
DeletableClass in namespace Flarum\Api\Resource\Contracts
DiscussionResourceClass in namespace Flarum\Api\Resource
DiscussionResource::deleting() — Method in class DiscussionResource
GroupResource::deleting() — Method in class GroupResource
$PostResource#defaultLimitProperty in class PostResource
PostResource::deleting() — Method in class PostResource
UserResource::deleting() — Method in class UserResource
DateClass in namespace Flarum\Api\Schema
DateTimeClass in namespace Flarum\Api\Schema
ToOne::deserializeValue() — Method in class ToOne
Arr::deserialize() — Method in class Arr
SortColumn::descendingAlias() — Method in class SortColumn
DispatcherClass in namespace Flarum\Bus
Schedule::dueEvents() — Method in class Schedule
$AbstractModel#defaultsProperty in class AbstractModel
DatabaseMigrationRepositoryClass in namespace Flarum\Database
DatabaseMigrationRepository::delete() — Method in class DatabaseMigrationRepository
Remove a migration from the log.
DatabaseServiceProviderClass in namespace Flarum\Database
Migration::dropColumns() — Method in class Migration
MigrationRepositoryInterface::delete() — Method in class MigrationRepositoryInterface
Remove a migration from the log.
DiscussionPolicyClass in namespace Flarum\Discussion\Access
DiscussionClass in namespace Flarum\Discussion
DiscussionFactoryClass in namespace Flarum\Discussion
DiscussionFactory::definition() — Method in class DiscussionFactory
DiscussionMetadataUpdaterClass in namespace Flarum\Discussion
DiscussionRenamedLoggerClass in namespace Flarum\Discussion
DiscussionRepositoryClass in namespace Flarum\Discussion
DiscussionServiceProviderClass in namespace Flarum\Discussion
DeletedClass in namespace Flarum\Discussion\Event
DeletingClass in namespace Flarum\Discussion\Event
DiscussionSearcherClass in namespace Flarum\Discussion\Search
$UserState#discussion_idProperty in class UserState
$UserState#discussionProperty in class UserState
UserState::discussion() — Method in class UserState
Filesystem::disk() — Method in class Filesystem
Declare a new filesystem disk.
Filesystem::driver() — Method in class Filesystem
Register a new filesystem driver.
Mail::driver() — Method in class Mail
Add a mail driver.
Model::default() — Method in class Model
Add a default value for a given attribute, which can be an explicit value, a closure, or an instance of an invokable class. Unlike with some other extenders, it CANNOT be the `::class` attribute of an invokable class.
Notification::driver() — Method in class Notification
Routes::delete() — Method in class Routes
Add a DELETE route.
Session::driver() — Method in class Session
Register a new session driver.
Settings::default() — Method in class Settings
Set a default value for a setting.
User::displayNameDriver() — Method in class User
Add a display name driver.
$SyncAbandonedExtensionsCommand#descriptionProperty in class SyncAbandonedExtensionsCommand
DefaultLanguagePackGuardClass in namespace Flarum\Extension
DisabledClass in namespace Flarum\Extension\Event
DisablingClass in namespace Flarum\Extension\Event
DependentExtensionsExceptionClass in namespace Flarum\Extension\Exception
This exception is thrown when someone attempts to disable an extension that other enabled extensions depend on.
DependentExtensionsExceptionHandlerClass in namespace Flarum\Extension\Exception
$Extension#descriptionProperty in class Extension
Extension::disable() — Method in class Extension
ExtensionManager::disable() — Method in class ExtensionManager
DriverInterfaceClass in namespace Flarum\Filesystem
DiscussionClass in namespace Flarum\Forum\Content
InteractsWithLaravel::databasePath() — Method in class InteractsWithLaravel
Config::defaults() — Method in class Config
DispatchEventsTraitClass in namespace Flarum\Foundation
DispatchEventsTrait::dispatchEventsFor() — Method in class DispatchEventsTrait
Dispatch all events for an entity.
JsCompiler::delete() — Method in class JsCompiler
JsDirectoryCompiler::destinationFor() — Method in class JsDirectoryCompiler
RevisionCompiler::delete() — Method in class RevisionCompiler
DirectorySourceClass in namespace Flarum\Frontend\Compiler\Source
DocumentClass in namespace Flarum\Frontend
A view which renders a HTML skeleton for Flarum's frontend app.
$Document#directionProperty in class Document
The text direction of the document, displayed as the value of the attribute `dir` in the tag.
Frontend::document() — Method in class Frontend
DeletedClass in namespace Flarum\Group\Event
DeletingClass in namespace Flarum\Group\Event
GroupFactory::definition() — Method in class GroupFactory
AccessTokenFactory::definition() — Method in class AccessTokenFactory
$CookieFactory#domainProperty in class CookieFactory
DeveloperAccessTokenClass in namespace Flarum\Http
DeveloperTokenCreatedClass in namespace Flarum\Http\Event
$ResolveRoute#dispatcherProperty in class ResolveRoute
$RouteCollection#dataGeneratorProperty in class RouteCollection
RouteCollection::delete() — Method in class RouteCollection
DataProviderInterfaceClass in namespace Flarum\Install\Console
$FileDataProvider#debugProperty in class FileDataProvider
$FileDataProvider#databaseConfigurationProperty in class FileDataProvider
$InstallCommand#dataSourceProperty in class InstallCommand
DatabaseConfigClass in namespace Flarum\Install
Installation::debugMode() — Method in class Installation
Installation::databaseConfig() — Method in class Installation
Repository::dehydrate() — Method in class Repository
Dehydrate the context data for serialization.
Repository::dehydrating() — Method in class Repository
Register a dehydrating callback.
DriverInterfaceClass in namespace Flarum\Mail
An interface for a mail service.
DiscussionRenamedBlueprintClass in namespace Flarum\Notification\Blueprint
DeleteAllNotificationsClass in namespace Flarum\Notification\Command
DeleteAllNotificationsHandlerClass in namespace Flarum\Notification\Command
DeletedAllClass in namespace Flarum\Notification\Event
$Notification#dataProperty in class Notification
$Notification#deleted_atProperty in class Notification
NotificationRepository::deleteAll() — Method in class NotificationRepository
NotificationSyncer::delete() — Method in class NotificationSyncer
Delete a notification for all users.
DiscussionRenamedPostClass in namespace Flarum\Post
A post which indicates that a discussion's title was changed.
DeletedClass in namespace Flarum\Post\Event
DeletingClass in namespace Flarum\Post\Event
DiscussionFilterClass in namespace Flarum\Post\Filter
$Post#discussion_idProperty in class Post
$Post#discussionProperty in class Post
Post::discussion() — Method in class Post
PostFactory::definition() — Method in class PostFactory
$AbstractJob#deleteWhenMissingModelsProperty in class AbstractJob
If a serialized model on this job has been deleted between dispatch and worker pickup, treat the job as a no-op and remove it from the queue rather than calling failed(), which re-deserializes the payload and throws ModelNotFoundException a second time — producing duplicate error log entries for what is in fact a handled-correctly race.
DatabaseWorkerArgsClass in namespace Flarum\Queue\Console
DatabaseUuidFailedJobProviderClass in namespace Flarum\Queue
QueueServiceProvider::driver() — Method in class QueueServiceProvider
DatabaseSearchDriverClass in namespace Flarum\Search\Database
DatabaseSearchStateClass in namespace Flarum\Search\Database
IndexerInterface::delete() — Method in class IndexerInterface
ModelObserver::deleted() — Method in class ModelObserver
SearchManager::driver() — Method in class SearchManager
SearchManager::driverFor() — Method in class SearchManager
DatabaseSettingsRepositoryClass in namespace Flarum\Settings
DatabaseSettingsRepository::delete() — Method in class DatabaseSettingsRepository
DefaultSettingsRepositoryClass in namespace Flarum\Settings
DefaultSettingsRepository::delete() — Method in class DefaultSettingsRepository
DeserializingClass in namespace Flarum\Settings\Event
Prepare settings for display in the client.
MemoryCacheSettingsRepository::delete() — Method in class MemoryCacheSettingsRepository
OverrideSettingsRepository::delete() — Method in class OverrideSettingsRepository
SettingsRepositoryInterface::delete() — Method in class SettingsRepositoryInterface
UninstalledSettingsRepository::delete() — Method in class UninstalledSettingsRepository
AbstractPolicy::deny() — Method in class AbstractPolicy
AvatarUploader::deleteAllVariants() — Method in class AvatarUploader
Delete the base file and all HiDPI variants (@2x, @3x) for a given base path.
DefaultDriverClass in namespace Flarum\User\Avatar
The default driver, which returns null when no uploaded avatar exists.
DriverInterfaceClass in namespace Flarum\User\Avatar
An interface for an avatar driver.
DeleteAvatarClass in namespace Flarum\User\Command
DeleteAvatarHandlerClass in namespace Flarum\User\Command
DriverInterfaceClass in namespace Flarum\User\DisplayName
An interface for a display name driver.
DriverInterface::displayName() — Method in class DriverInterface
Return a display name for a user.
UsernameDriver::displayName() — Method in class UsernameDriver
Return a display name for a user.
DeletedClass in namespace Flarum\User\Event
DeletingClass in namespace Flarum\User\Event
$User#displayNameDriverProperty in class User
A driver for getting display names.
$User#display_nameProperty in class User
$User#discussion_countProperty in class User
$User#discussionsProperty in class User
User::discussions() — Method in class User
UserFactory::definition() — Method in class UserFactory

E

$Client#errorHandlingProperty in class Client
ClientMiddlewarePipe::errorHandling() — Method in class ClientMiddlewarePipe
Context::extractIdFromPath() — Method in class Context
ExtensionBisectControllerClass in namespace Flarum\Api\Controller
ExtractsListingParamsClass in namespace Flarum\Api\Endpoint\Concerns
$ExtractsListingParams#extractFilterCallbackProperty in class ExtractsListingParams
$ExtractsListingParams#extractSortCallbackProperty in class ExtractsListingParams
$ExtractsListingParams#extractLimitCallbackProperty in class ExtractsListingParams
$ExtractsListingParams#extractOffsetCallbackProperty in class ExtractsListingParams
ExtractsListingParams::extractFilter() — Method in class ExtractsListingParams
ExtractsListingParams::extractSort() — Method in class ExtractsListingParams
ExtractsListingParams::extractLimit() — Method in class ExtractsListingParams
ExtractsListingParams::extractOffset() — Method in class ExtractsListingParams
ExtractsListingParams::extractFilterValue() — Method in class ExtractsListingParams
ExtractsListingParams::extractSortValue() — Method in class ExtractsListingParams
ExtractsListingParams::extractLimitValue() — Method in class ExtractsListingParams
ExtractsListingParams::extractOffsetValue() — Method in class ExtractsListingParams
HasEagerLoading::eagerLoad() — Method in class HasEagerLoading
Eager loads relationships needed for serializer logic.
HasEagerLoading::eagerLoadWhenIncluded() — Method in class HasEagerLoading
Eager load relations when a relation is included in the serialized response.
HasEagerLoading::eagerLoadWhere() — Method in class HasEagerLoading
Allows loading a relationship with additional query modification.
EndpointClass in namespace Flarum\Api\Endpoint
$JsonApi#endpointNameProperty in class JsonApi
AccessTokenResource::endpoints() — Method in class AccessTokenResource
$Bootable#eventsProperty in class Bootable
ExtendableClass in namespace Flarum\Api\Resource\Concerns
$Extendable#endpointModifiersProperty in class Extendable
DiscussionResource::endpoints() — Method in class DiscussionResource
EloquentBufferClass in namespace Flarum\Api\Resource
ExtensionReadmeResourceClass in namespace Flarum\Api\Resource
ExtensionReadmeResource::endpoints() — Method in class ExtensionReadmeResource
ForumResource::endpoints() — Method in class ForumResource
GroupResource::endpoints() — Method in class GroupResource
MailSettingResource::endpoints() — Method in class MailSettingResource
NotificationResource::endpoints() — Method in class NotificationResource
PostResource::endpoints() — Method in class PostResource
SystemInfoResource::endpoints() — Method in class SystemInfoResource
UserResource::endpoints() — Method in class UserResource
HasValidationRules::evaluate() — Method in class HasValidationRules
Str::email() — Method in class Str
AbstractCommand::execute() — Method in class AbstractCommand
AbstractCommand::error() — Method in class AbstractCommand
Send an error or warning message to the user.
Schedule::environment() — Method in class Schedule
ApiResource::endpoints() — Method in class ApiResource
Add endpoints to the resource.
ApiResource::endpointsBefore() — Method in class ApiResource
Add endpoints to the resource before a certain endpoint.
ApiResource::endpointsAfter() — Method in class ApiResource
Add endpoints to the resource after a certain endpoint.
ApiResource::endpointsBeforeAll() — Method in class ApiResource
Add endpoints to the resource before all other endpoints.
ApiResource::endpoint() — Method in class ApiResource
Modify an endpoint.
ApiResource::extend() — Method in class ApiResource
Auth::extend() — Method in class Auth
Conditional::extend() — Method in class Conditional
Iterates over the conditions and applies the associated extenders if the conditions are met.
Console::extend() — Method in class Console
Csrf::exemptRoute() — Method in class Csrf
Exempt a named route from CSRF checks.
Csrf::extend() — Method in class Csrf
ErrorHandlingClass in namespace Flarum\Extend
ErrorHandling::extend() — Method in class ErrorHandling
EventClass in namespace Flarum\Extend
Event::extend() — Method in class Event
ExtenderInterfaceClass in namespace Flarum\Extend
ExtenderInterface::extend() — Method in class ExtenderInterface
Filesystem::extend() — Method in class Filesystem
Formatter::extend() — Method in class Formatter
Frontend::extraDocumentAttributes() — Method in class Frontend
Adds document root attributes.
Frontend::extraDocumentClasses() — Method in class Frontend
Adds document root classes.
Frontend::extend() — Method in class Frontend
LanguagePack::extend() — Method in class LanguagePack
Link::extend() — Method in class Link
Locales::extend() — Method in class Locales
Mail::extend() — Method in class Mail
Middleware::extend() — Method in class Middleware
Model::extend() — Method in class Model
ModelPrivate::extend() — Method in class ModelPrivate
ModelUrl::extend() — Method in class ModelUrl
ModelVisibility::extend() — Method in class ModelVisibility
Notification::extend() — Method in class Notification
Policy::extend() — Method in class Policy
Post::extend() — Method in class Post
Routes::extend() — Method in class Routes
SearchDriver::extend() — Method in class SearchDriver
SearchIndex::extend() — Method in class SearchIndex
ServiceProvider::extend() — Method in class ServiceProvider
Session::extend() — Method in class Session
Settings::extend() — Method in class Settings
Theme::extend() — Method in class Theme
ThrottleApi::extend() — Method in class ThrottleApi
User::extend() — Method in class User
Validator::extend() — Method in class Validator
View::extendNamespace() — Method in class View
Extend an existing namespace of Laravel views.
View::extend() — Method in class View
Bisect::end() — Method in class Bisect
BisectState::end() — Method in class BisectState
EnabledClass in namespace Flarum\Extension\Event
EnablingClass in namespace Flarum\Extension\Event
CircularDependenciesExceptionHandler::errorDetails() — Method in class CircularDependenciesExceptionHandler
DependentExtensionsExceptionHandler::errorDetails() — Method in class DependentExtensionsExceptionHandler
ExtensionBootErrorClass in namespace Flarum\Extension\Exception
MissingDependenciesExceptionHandler::errorDetails() — Method in class MissingDependenciesExceptionHandler
ExtensionClass in namespace Flarum\Extension
$Extension#extensionDependencyIdsProperty in class Extension
The IDs of all Flarum extensions that this extension depends on.
$Extension#extraProperty in class Extension
Extension::extend() — Method in class Extension
Extension::enable() — Method in class Extension
ExtensionManagerClass in namespace Flarum\Extension
$ExtensionManager#extensionsProperty in class ExtensionManager
ExtensionManager::enable() — Method in class ExtensionManager
ExtensionManager::extend() — Method in class ExtensionManager
Call on all enabled extensions to extend the Flarum application.
ExtensionManager::extensionFromJson() — Method in class ExtensionManager
ExtensionServiceProviderClass in namespace Flarum\Extension
InteractsWithLaravel::environment() — Method in class InteractsWithLaravel
Config::environment() — Method in class Config
IlluminateValidationExceptionHandler::errorDetails() — Method in class IlluminateValidationExceptionHandler
ErrorServiceProviderClass in namespace Flarum\Foundation
EventGeneratorTraitClass in namespace Flarum\Foundation
$InstalledSite#extendersProperty in class InstalledSite
InstalledSite::extendWith() — Method in class InstalledSite
JsDirectoryCompiler::eachFile() — Method in class JsDirectoryCompiler
$Document#extraAttributesProperty in class Document
Document extra attributes.
CookieFactory::expire() — Method in class CookieFactory
Make an expired cookie instance.
ExecuteRouteClass in namespace Flarum\Http\Middleware
$FlarumPromotionHeader#enabledProperty in class FlarumPromotionHeader
RequestUtil::extractSort() — Method in class RequestUtil
RequestUtil::extractLimit() — Method in class RequestUtil
RequestUtil::extractOffsetFromNumber() — Method in class RequestUtil
RequestUtil::extractOffset() — Method in class RequestUtil
RequestUtil::extractInclude() — Method in class RequestUtil
RequestUtil::extractFilter() — Method in class RequestUtil
RequestUtil::extractFields() — Method in class RequestUtil
$FileDataProvider#extensionsProperty in class FileDataProvider
Installation::extensions() — Method in class Installation
EnableBundledExtensionsClass in namespace Flarum\Install\Steps
EmailSendFailedClass in namespace Flarum\Mail\Event
EmailNotificationDriverClass in namespace Flarum\Notification\Driver
$UnsubscribeToken#email_typeProperty in class UnsubscribeToken
PostPolicy::edit() — Method in class PostPolicy
$Post#edited_atProperty in class Post
$Post#edited_user_idProperty in class Post
$Post#editedUserProperty in class Post
Post::editedUser() — Method in class Post
ExceptionHandlerClass in namespace Flarum\Queue
UserPolicy::editCredentials() — Method in class UserPolicy
EmailConfirmationMailerClass in namespace Flarum\User
EmailTokenClass in namespace Flarum\User
$EmailToken#emailProperty in class EmailToken
EmailChangeRequestedClass in namespace Flarum\User\Event
EmailChangedClass in namespace Flarum\User\Event
EmailFilterClass in namespace Flarum\User\Search\Filter
EmailActivationThrottlerClass in namespace Flarum\User\Throttler
Unactivated users can request a confirmation email, this throttler applies a timeout of 5 minutes between confirmation requests.
EmailChangeThrottlerClass in namespace Flarum\User\Throttler
Users can request an email change, this throttler applies a timeout of 5 minutes between requests.
$User#emailProperty in class User
$User#emailTokensProperty in class User
User::emailTokens() — Method in class User

F

FaviconValidatorClass in namespace Flarum\Admin
AnnouncementsFetcher::fetch() — Method in class AnnouncementsFetcher
Context::fields() — Method in class Context
Get the fields for the given resource, keyed by name.
$DeleteLogoController#filePathSettingKeyProperty in class DeleteLogoController
$DeleteLogoDarkModeController#filePathSettingKeyProperty in class DeleteLogoDarkModeController
ForgotPasswordControllerClass in namespace Flarum\Api\Controller
$UploadFaviconController#filePathSettingKeyProperty in class UploadFaviconController
$UploadFaviconController#filenamePrefixProperty in class UploadFaviconController
$UploadImageController#fileExtensionProperty in class UploadImageController
$UploadImageController#filePathSettingKeyProperty in class UploadImageController
$UploadImageController#filenamePrefixProperty in class UploadImageController
UploadImageController::fileExtension() — Method in class UploadImageController
UploadImageController::filePathSettingKey() — Method in class UploadImageController
UploadImageController::filenamePrefix() — Method in class UploadImageController
$UploadLogoController#filePathSettingKeyProperty in class UploadLogoController
$UploadLogoController#filenamePrefixProperty in class UploadLogoController
UploadLogoController::fileExtension() — Method in class UploadLogoController
$UploadLogoDarkModeController#filePathSettingKeyProperty in class UploadLogoDarkModeController
$UploadLogoDarkModeController#filenamePrefixProperty in class UploadLogoDarkModeController
Create::fillDefaultValues() — Method in class Create
ForgotPasswordValidatorClass in namespace Flarum\Api
JsonApi::forResource() — Method in class JsonApi
JsonApi::forEndpoint() — Method in class JsonApi
JsonApi::findEndpoint() — Method in class JsonApi
FakeHttpMethodsClass in namespace Flarum\Api\Middleware
AbstractDatabaseResource::find() — Method in class AbstractDatabaseResource
AbstractDatabaseResource::filters() — Method in class AbstractDatabaseResource
Filters that can be applied to the resource list.
AccessTokenResource::fields() — Method in class AccessTokenResource
$Extendable#fieldModifiersProperty in class Extendable
FindableClass in namespace Flarum\Api\Resource\Contracts
Listable::filters() — Method in class Listable
Filters that can be applied to the resource list.
DiscussionResource::find() — Method in class DiscussionResource
DiscussionResource::fields() — Method in class DiscussionResource
ExtensionReadmeResource::find() — Method in class ExtensionReadmeResource
ExtensionReadmeResource::fields() — Method in class ExtensionReadmeResource
ForumResourceClass in namespace Flarum\Api\Resource
ForumResource::find() — Method in class ForumResource
ForumResource::fields() — Method in class ForumResource
GroupResource::fields() — Method in class GroupResource
MailSettingResource::find() — Method in class MailSettingResource
MailSettingResource::fields() — Method in class MailSettingResource
NotificationResource::fields() — Method in class NotificationResource
PostResource::fields() — Method in class PostResource
SystemInfoResource::find() — Method in class SystemInfoResource
SystemInfoResource::fields() — Method in class SystemInfoResource
UserResource::find() — Method in class UserResource
UserResource::fields() — Method in class UserResource
FlarumFieldClass in namespace Flarum\Api\Schema\Concerns
FlarumRelationshipClass in namespace Flarum\Api\Schema\Concerns
DateTime::format() — Method in class DateTime
AbstractCommand::fire() — Method in class AbstractCommand
FactoryClass in namespace Flarum\Console\Cache
GenerateDumpCommand::fire() — Method in class GenerateDumpCommand
MigrateCommand::fire() — Method in class MigrateCommand
ResetCommand::fire() — Method in class ResetCommand
$DatabaseServiceProvider#fakersProperty in class DatabaseServiceProvider
$Discussion#first_post_idProperty in class Discussion
$Discussion#firstPostProperty in class Discussion
Discussion::firstPost() — Method in class Discussion
DiscussionRepository::findOrFail() — Method in class DiscussionRepository
Find a discussion by ID, optionally making sure it is visible to a certain user, or throw an exception.
IdWithTransliteratedSlugDriver::fromSlug() — Method in class IdWithTransliteratedSlugDriver
AuthorFilter::filter() — Method in class AuthorFilter
Filters a query.
CreatedFilter::filter() — Method in class CreatedFilter
Filters a query.
HiddenFilter::filter() — Method in class HiddenFilter
Filters a query.
UnreadFilter::filter() — Method in class UnreadFilter
Filters a query.
FulltextFilterClass in namespace Flarum\Discussion\Search
$UserState#fillableProperty in class UserState
The attributes that are mass assignable.
Utf8SlugDriver::fromSlug() — Method in class Utf8SlugDriver
ApiResource::fields() — Method in class ApiResource
Add fields to the resource.
ApiResource::fieldsBefore() — Method in class ApiResource
Add fields to the resource before a certain field.
ApiResource::fieldsAfter() — Method in class ApiResource
Add fields to the resource after a certain field.
ApiResource::field() — Method in class ApiResource
Modify a field.
FilesystemClass in namespace Flarum\Extend
FormatterClass in namespace Flarum\Extend
FrontendClass in namespace Flarum\Extend
AbandonedExtensionsFetcher::fetch() — Method in class AbandonedExtensionsFetcher
Bisect::foundIssue() — Method in class Bisect
BisectState::fromArray() — Method in class BisectState
BisectCommand::foundIssue() — Method in class BisectCommand
ToggleExtensionCommand::fire() — Method in class ToggleExtensionCommand
FilesystemManagerClass in namespace Flarum\Filesystem
FilesystemServiceProviderClass in namespace Flarum\Filesystem
FormattableClass in namespace Flarum\Formatter
FormatterClass in namespace Flarum\Formatter
Formatter::flush() — Method in class Formatter
Flush the cache so that the formatter components are regenerated.
FormatterServiceProviderClass in namespace Flarum\Formatter
$HasFormattedContent#formatterProperty in class HasFormattedContent
HasFormattedContent::formatContent() — Method in class HasFormattedContent
Get the content rendered as HTML.
XsltPolyfill::findSource() — Method in class XsltPolyfill
Locate the vendored xslt-polyfill bundle inside core's js/dist.
ForumServiceProviderClass in namespace Flarum\Forum
$AbstractImageValidator#filenameProperty in class AbstractImageValidator
Application::fireAppCallbacks() — Method in class Application
Config::fontawesomeSource() — Method in class Config
Config::fontawesomeCdnUrl() — Method in class Config
Config::fontawesomeKitUrl() — Method in class Config
AssetsPublishCommand::fire() — Method in class AssetsPublishCommand
CacheClearCommand::fire() — Method in class CacheClearCommand
InfoCommand::fire() — Method in class InfoCommand
HttpFormatter::format() — Method in class HttpFormatter
Create an HTTP Response to represent the error we are handling.
JsonApiFormatter::format() — Method in class JsonApiFormatter
Create an HTTP Response to represent the error we are handling.
ViewFormatter::format() — Method in class ViewFormatter
Create an HTTP Response to represent the error we are handling.
WhoopsFormatter::format() — Method in class WhoopsFormatter
Create an HTTP Response to represent the error we are handling.
FontAwesomeClass in namespace Flarum\Foundation
Site::fromPaths() — Method in class Site
AddTranslations::forFrontend() — Method in class AddTranslations
AssetManager::frontend() — Method in class AssetManager
AssetManager::flushJs() — Method in class AssetManager
$Assets#fileSourceOverridesProperty in class Assets
CompilerInterface::flush() — Method in class CompilerInterface
FileVersionerClass in namespace Flarum\Frontend\Compiler
JsCompiler::format() — Method in class JsCompiler
JsDirectoryCompiler::flush() — Method in class JsDirectoryCompiler
JsDirectoryCompiler::flushSource() — Method in class JsDirectoryCompiler
$LessCompiler#fileSourceOverridesProperty in class LessCompiler
LessCompiler::finalize() — Method in class LessCompiler
RevisionCompiler::format() — Method in class RevisionCompiler
RevisionCompiler::flush() — Method in class RevisionCompiler
$DirectorySource#filesystemProperty in class DirectorySource
FileSourceClass in namespace Flarum\Frontend\Compiler\Source
Assets::forFrontend() — Method in class Assets
Sets the frontend to generate assets for.
Assets::forceCommit() — Method in class Assets
Force compilation of assets when in debug mode.
$Document#footProperty in class Document
An array of strings to prepend before the page's .
FrontendClass in namespace Flarum\Frontend
FrontendServiceProviderClass in namespace Flarum\Frontend
RecompileFrontendAssets::flush() — Method in class RecompileFrontendAssets
RecompileFrontendAssets::flushCss() — Method in class RecompileFrontendAssets
RecompileFrontendAssets::flushJs() — Method in class RecompileFrontendAssets
HiddenFilter::filter() — Method in class HiddenFilter
Filters a query.
GroupRepository::findOrFail() — Method in class GroupRepository
Find a user by ID, optionally making sure it is visible to a certain user, or throw an exception.
AccessToken::findValid() — Method in class AccessToken
Shortcut to find a valid token.
AccessTokenTypeFilter::filter() — Method in class AccessTokenTypeFilter
Filters a query.
UserFilter::filter() — Method in class UserFilter
Filters a query.
FlarumPromotionHeaderClass in namespace Flarum\Http\Middleware
Rememberer::forget() — Method in class Rememberer
RouteCollection::fixPathPart() — Method in class RouteCollection
SlugDriverInterface::fromSlug() — Method in class SlugDriverInterface
SlugManager::forResource() — Method in class SlugManager
BaseUrl::fromString() — Method in class BaseUrl
BaseUrl::fromUri() — Method in class BaseUrl
FileDataProviderClass in namespace Flarum\Install\Console
InstallCommand::fire() — Method in class InstallCommand
Repository::forget() — Method in class Repository
Forget a context key.
Repository::forgetHidden() — Method in class Repository
Forget a hidden context key.
Repository::flush() — Method in class Repository
Flush all context data.
FlarumLogTransportClass in namespace Flarum\Mail
$Notification#from_user_idProperty in class Notification
$Notification#fromUserProperty in class Notification
Notification::fromUser() — Method in class Notification
NotificationRepository::findByUser() — Method in class NotificationRepository
$UnsubscribeToken#fillableProperty in class UnsubscribeToken
FloodingExceptionClass in namespace Flarum\Post\Exception
AuthorFilter::filter() — Method in class AuthorFilter
Filters a query.
DiscussionFilter::filter() — Method in class DiscussionFilter
Filters a query.
FulltextFilterClass in namespace Flarum\Post\Filter
IdFilter::filter() — Method in class IdFilter
Filters a query.
NumberFilter::filter() — Method in class NumberFilter
Filters a query.
TypeFilter::filter() — Method in class TypeFilter
Filters a query.
PostRepository::findOrFail() — Method in class PostRepository
Find a post by ID, optionally making sure it is visible to a certain user, or throw an exception.
PostRepository::findWhere() — Method in class PostRepository
Find posts that match certain conditions, optionally making sure they are visible to a certain user, and/or using other criteria.
PostRepository::filterVisibleIds() — Method in class PostRepository
Filter a list of post IDs to only include posts that are visible to a certain user.
AbstractFulltextFilter::filter() — Method in class AbstractFulltextFilter
Filters a query.
FilterInterfaceClass in namespace Flarum\Search\Filter
FilterInterface::filter() — Method in class FilterInterface
Filters a query.
FilterManagerClass in namespace Flarum\Search\Filter
$FilterManager#filtersProperty in class FilterManager
IndexerInterface::flush() — Method in class IndexerInterface
Flush the index.
ModelObserver::forceDeleted() — Method in class ModelObserver
AbstractPolicy::forceAllow() — Method in class AbstractPolicy
AbstractPolicy::forceDeny() — Method in class AbstractPolicy
BackfillAvatarVariantsCommand::fire() — Method in class BackfillAvatarVariantsCommand
ConvertAvatarsToWebpCommand::fire() — Method in class ConvertAvatarsToWebpCommand
IdSlugDriver::fromSlug() — Method in class IdSlugDriver
IdWithDisplayNameSlugDriver::fromSlug() — Method in class IdWithDisplayNameSlugDriver
$LoginProvider#fillableProperty in class LoginProvider
EmailFilter::filter() — Method in class EmailFilter
Filters a query.
GroupFilter::filter() — Method in class GroupFilter
Filters a query.
FulltextFilterClass in namespace Flarum\User\Search
UserRepository::findOrFail() — Method in class UserRepository
Find a user by ID, optionally making sure it is visible to a certain user, or throw an exception.
UserRepository::findOrFailByUsername() — Method in class UserRepository
Find a user by username, optionally making sure it is visible to a certain user, or throw an exception.
UserRepository::findByIdentification() — Method in class UserRepository
Find a user by an identification (username or email).
UserRepository::findByEmail() — Method in class UserRepository
UsernameSlugDriver::fromSlug() — Method in class UsernameSlugDriver

G

AdminPayload::getSearchDrivers() — Method in class AdminPayload
ApiKey::generate() — Method in class ApiKey
Client::get() — Method in class Client
ClientMiddlewarePipe::getPipe() — Method in class ClientMiddlewarePipe
Context::getSearchResults() — Method in class Context
Context::getActor() — Method in class Context
Context::getParam() — Method in class Context
ExtractsListingParams::getAvailableSorts() — Method in class ExtractsListingParams
HasAuthorization::getAuthenticated() — Method in class HasAuthorization
HasAuthorization::getAuthorized() — Method in class HasAuthorization
HasEagerLoading::getEagerLoadsFor() — Method in class HasEagerLoading
HasEagerLoading::getWhereEagerLoadsFor() — Method in class HasEagerLoading
InvalidAccessTokenException::getType() — Method in class InvalidAccessTokenException
Determine the exception's type.
JsonApi::getCollection() — Method in class JsonApi
Get a collection by name or class.
JsonApi::getResource() — Method in class JsonApi
Get a resource by type or class.
JsonApi::getContainer() — Method in class JsonApi
AbstractDatabaseResource::getId() — Method in class AbstractDatabaseResource
AbstractDatabaseResource::getValue() — Method in class AbstractDatabaseResource
AbstractDatabaseResource::getAttributeValue() — Method in class AbstractDatabaseResource
AbstractDatabaseResource::getRelationshipValue() — Method in class AbstractDatabaseResource
EloquentBuffer::getBuffer() — Method in class EloquentBuffer
ExtensionReadmeResource::getId() — Method in class ExtensionReadmeResource
ForumResource::getId() — Method in class ForumResource
ForumResource::getLogoUrl() — Method in class ForumResource
ForumResource::getLogoDarkModeUrl() — Method in class ForumResource
ForumResource::getFaviconUrl() — Method in class ForumResource
ForumResource::getAssetUrl() — Method in class ForumResource
GroupResourceClass in namespace Flarum\Api\Resource
MailSettingResource::getId() — Method in class MailSettingResource
SystemInfoResource::getId() — Method in class SystemInfoResource
GetsRelationAggregatesClass in namespace Flarum\Api\Schema\Concerns
GetsRelationAggregates::getRelationAggregate() — Method in class GetsRelationAggregates
HasValidationRules::getRules() — Method in class HasValidationRules
HasValidationRules::getValidationRules() — Method in class HasValidationRules
HasValidationRules::getValidationMessages() — Method in class HasValidationRules
HasValidationRules::getValidationAttributes() — Method in class HasValidationRules
RelationAggregator::getRelationAggregate() — Method in class RelationAggregator
Dispatcher::getCommandHandler() — Method in class Dispatcher
AbstractModel::getCasts() — Method in class AbstractModel
GenerateDumpCommandClass in namespace Flarum\Database\Console
DatabaseMigrationRepository::getRan() — Method in class DatabaseMigrationRepository
Get the ran migrations for the given extension.
MigrationRepositoryInterface::getRan() — Method in class MigrationRepositoryInterface
Get the ran migrations for the given extension.
Migrator::getMigrationFiles() — Method in class Migrator
Get all of the migration files in a given path.
Migrator::getRepository() — Method in class Migrator
Get the migration repository instance.
Discussion::getModifiedPosts() — Method in class Discussion
Get the posts that have been modified during this request.
DiscussionRepository::getReadIdsQuery() — Method in class DiscussionRepository
Get a query containing the IDs of discussions which a user has read completely.
DiscussionSearcher::getQuery() — Method in class DiscussionSearcher
AuthorFilter::getFilterKey() — Method in class AuthorFilter
This filter will only be run when a query contains a filter param with this key.
CreatedFilter::getFilterKey() — Method in class CreatedFilter
This filter will only be run when a query contains a filter param with this key.
HiddenFilter::getFilterKey() — Method in class HiddenFilter
This filter will only be run when a query contains a filter param with this key.
UnreadFilter::getFilterKey() — Method in class UnreadFilter
This filter will only be run when a query contains a filter param with this key.
Policy::globalPolicy() — Method in class Policy
Add a custom policy for when an ability check is ran without a model instance.
Routes::get() — Method in class Routes
Add a GET route.
AbandonedExtensionsFetcher::getCachedMap() — Method in class AbandonedExtensionsFetcher
Return the cached map from settings, or an empty array if not yet fetched.
Extension::getVersion() — Method in class Extension
Extension::getAbandoned() — Method in class Extension
Get the abandoned status.
Extension::getIcon() — Method in class Extension
Extension::getIconStyles() — Method in class Extension
Extension::getId() — Method in class Extension
The raw path of the directory under extensions.
Extension::getTitle() — Method in class Extension
Extension::getPath() — Method in class Extension
Extension::getExtensionDependencyIds() — Method in class Extension
The IDs of all Flarum extensions that this extension depends on.
Extension::getOptionalDependencyIds() — Method in class Extension
The IDs of all Flarum extensions that this extension should be booted after if enabled.
Extension::getLinks() — Method in class Extension
Compile a list of links for this extension.
Extension::getReadme() — Method in class Extension
Gets the rendered contents of the extension README file as a HTML string.
ExtensionManager::getExtensions() — Method in class ExtensionManager
ExtensionManager::getInstalledPackageNames() — Method in class ExtensionManager
Returns a flat list of all installed composer package names (including non-extension packages).
ExtensionManager::getExtensionsById() — Method in class ExtensionManager
ExtensionManager::getExtension() — Method in class ExtensionManager
ExtensionManager::getAsset() — Method in class ExtensionManager
Get the path to an extension's published asset.
ExtensionManager::getAssetsFilesystem() — Method in class ExtensionManager
Get an instance of the `assets` filesystem.
ExtensionManager::getMigrator() — Method in class ExtensionManager
The database migrator.
ExtensionManager::getEnabledExtensions() — Method in class ExtensionManager
ExtensionManager::getEnabled() — Method in class ExtensionManager
The id's of the enabled extensions.
FilesystemManager::getDriver() — Method in class FilesystemManager
FilesystemManager::getLocalConfig() — Method in class FilesystemManager
Formatter::getConfigurator() — Method in class Formatter
Formatter::getComponent() — Method in class Formatter
Get a TextFormatter component ("renderer" or "parser" or "js").
Formatter::getParser() — Method in class Formatter
Formatter::getRenderer() — Method in class Formatter
Formatter::getJs() — Method in class Formatter
Get the formatter JavaScript.
HasFormattedContent::getContentAttribute() — Method in class HasFormattedContent
HasFormattedContent::getParsedContentAttribute() — Method in class HasFormattedContent
HasFormattedContent::getFormatter() — Method in class HasFormattedContent
Registration::getProvided() — Method in class Registration
Registration::getSuggested() — Method in class Registration
Registration::getPayload() — Method in class Registration
Discussion::getApiDocument() — Method in class Discussion
Get the result of an API request to show a discussion.
Discussion::getPostsApiDocument() — Method in class Discussion
Get the result of an API request to list the posts of a discussion.
Index::getApiDocument() — Method in class Index
Get the result of an API request to list discussions.
Posts::getApiDocument() — Method in class Posts
User::getApiDocument() — Method in class User
Get the result of an API request to show a user.
GlobalLogOutControllerClass in namespace Flarum\Forum\Controller
LogOutController::getAllowedRedirectDomains() — Method in class LogOutController
LogOutViewController::getAllowedRedirectDomains() — Method in class LogOutViewController
AbstractImageValidator::getMaxSize() — Method in class AbstractImageValidator
AbstractImageValidator::getAllowedTypes() — Method in class AbstractImageValidator
AbstractValidator::getRules() — Method in class AbstractValidator
AbstractValidator::getActiveRules() — Method in class AbstractValidator
AbstractValidator::getMessages() — Method in class AbstractValidator
AppInterface::getContainer() — Method in class AppInterface
AppInterface::getRequestHandler() — Method in class AppInterface
AppInterface::getConsoleCommands() — Method in class AppInterface
Application::getConfig() — Method in class Application
Application::getProvider() — Method in class Application
ApplicationInfoProvider::getSchedulerStatus() — Method in class ApplicationInfoProvider
InteractsWithLaravel::getLocale() — Method in class InteractsWithLaravel
InteractsWithLaravel::getNamespace() — Method in class InteractsWithLaravel
InteractsWithLaravel::getProviders() — Method in class InteractsWithLaravel
HandledError::getException() — Method in class HandledError
HandledError::getType() — Method in class HandledError
HandledError::getStatusCode() — Method in class HandledError
HandledError::getDetails() — Method in class HandledError
IOException::getType() — Method in class IOException
Determine the exception's type.
InstalledApp::getContainer() — Method in class InstalledApp
InstalledApp::getRequestHandler() — Method in class InstalledApp
InstalledApp::getUpdaterHandler() — Method in class InstalledApp
InstalledApp::getConsoleCommands() — Method in class InstalledApp
InstalledSite::getIlluminateConfig() — Method in class InstalledSite
KnownError::getType() — Method in class KnownError
Determine the exception's type.
UninstalledSite::getIlluminateConfig() — Method in class UninstalledSite
ValidationException::getAttributes() — Method in class ValidationException
ValidationException::getRelationships() — Method in class ValidationException
Assets::getName() — Method in class Assets
Assets::getAssetsDir() — Method in class Assets
Assets::getCacheDir() — Method in class Assets
Assets::getLessImportDirs() — Method in class Assets
CompilerInterface::getFilename() — Method in class CompilerInterface
CompilerInterface::getUrl() — Method in class CompilerInterface
HasSources::getSources() — Method in class HasSources
FileVersioner::getRevision() — Method in class FileVersioner
JsDirectoryCompiler::getFilename() — Method in class JsDirectoryCompiler
JsDirectoryCompiler::getUrl() — Method in class JsDirectoryCompiler
LessCompiler::getCacheDir() — Method in class LessCompiler
LessCompiler::getImportDirs() — Method in class LessCompiler
LessCompiler::getCacheDifferentiator() — Method in class LessCompiler
RevisionCompiler::getFilename() — Method in class RevisionCompiler
RevisionCompiler::getUrl() — Method in class RevisionCompiler
RevisionCompiler::getCacheDifferentiator() — Method in class RevisionCompiler
DirectorySource::getContent() — Method in class DirectorySource
DirectorySource::getCacheDifferentiator() — Method in class DirectorySource
DirectorySource::getFilesystem() — Method in class DirectorySource
DirectorySource::getExtensionId() — Method in class DirectorySource
FileSource::getContent() — Method in class FileSource
FileSource::getCacheDifferentiator() — Method in class FileSource
FileSource::getPath() — Method in class FileSource
FileSource::getExtensionId() — Method in class FileSource
SourceCollector::getSources() — Method in class SourceCollector
SourceInterface::getContent() — Method in class SourceInterface
SourceInterface::getCacheDifferentiator() — Method in class SourceInterface
StringSource::getContent() — Method in class StringSource
StringSource::getCacheDifferentiator() — Method in class StringSource
VersionerInterface::getRevision() — Method in class VersionerInterface
Assets::getUrls() — Method in class Assets
Maps provided CompilerInterfaces to their URLs.
Document::getForumApiDocument() — Method in class Document
GroupPolicyClass in namespace Flarum\Group\Access
GroupSearcherClass in namespace Flarum\Group\Filter
GroupSearcher::getQuery() — Method in class GroupSearcher
HiddenFilter::getFilterKey() — Method in class HiddenFilter
This filter will only be run when a query contains a filter param with this key.
GroupClass in namespace Flarum\Group
GroupFactoryClass in namespace Flarum\Group
GroupRepositoryClass in namespace Flarum\Group
GroupServiceProviderClass in namespace Flarum\Group
$Permission#group_idProperty in class Permission
Permission::group() — Method in class Permission
AccessToken::generate() — Method in class AccessToken
Generate an access token for the specified user.
AccessToken::getModels() — Method in class AccessToken
Get the type-to-model map.
ActorReference::getActor() — Method in class ActorReference
CookieFactory::getName() — Method in class CookieFactory
Get a cookie name.
MaintenanceModeException::getType() — Method in class MaintenanceModeException
Determine the exception's type.
MethodNotAllowedException::getType() — Method in class MethodNotAllowedException
Determine the exception's type.
RouteNotFoundException::getType() — Method in class RouteNotFoundException
Determine the exception's type.
TokenMismatchException::getType() — Method in class TokenMismatchException
Determine the exception's type.
AccessTokenSearcher::getQuery() — Method in class AccessTokenSearcher
AccessTokenTypeFilter::getFilterKey() — Method in class AccessTokenTypeFilter
This filter will only be run when a query contains a filter param with this key.
UserFilter::getFilterKey() — Method in class UserFilter
This filter will only be run when a query contains a filter param with this key.
ResolveRoute::getDispatcher() — Method in class ResolveRoute
RequestUtil::getActor() — Method in class RequestUtil
RouteCollection::get() — Method in class RouteCollection
RouteCollection::getRoutes() — Method in class RouteCollection
RouteCollection::getRouteData() — Method in class RouteCollection
RouteCollection::getPath() — Method in class RouteCollection
AdminUser::getUsername() — Method in class AdminUser
AdminUser::getAttributes() — Method in class AdminUser
Installer::getContainer() — Method in class Installer
Installer::getRequestHandler() — Method in class Installer
Installer::getConsoleCommands() — Method in class Installer
Step::getMessage() — Method in class Step
A one-line status message summarizing what's happening in this step.
ConnectToDatabase::getMessage() — Method in class ConnectToDatabase
A one-line status message summarizing what's happening in this step.
CreateAdminUser::getMessage() — Method in class CreateAdminUser
A one-line status message summarizing what's happening in this step.
EnableBundledExtensions::getMessage() — Method in class EnableBundledExtensions
A one-line status message summarizing what's happening in this step.
PublishAssets::getMessage() — Method in class PublishAssets
A one-line status message summarizing what's happening in this step.
RunMigrations::getMessage() — Method in class RunMigrations
A one-line status message summarizing what's happening in this step.
StoreConfig::getMessage() — Method in class StoreConfig
A one-line status message summarizing what's happening in this step.
WriteSettings::getMessage() — Method in class WriteSettings
A one-line status message summarizing what's happening in this step.
LocaleManager::getLocale() — Method in class LocaleManager
LocaleManager::getLocales() — Method in class LocaleManager
LocaleManager::getJsFiles() — Method in class LocaleManager
LocaleManager::getCssFiles() — Method in class LocaleManager
LocaleManager::getTranslator() — Method in class LocaleManager
Translator::get() — Method in class Translator
Translator::getCatalogue() — Method in class Translator
TranslatorInterface::getLocale() — Method in class TranslatorInterface
Repository::get() — Method in class Repository
Get a context value.
Repository::getHidden() — Method in class Repository
Get a hidden context value.
BlueprintInterface::getFromUser() — Method in class BlueprintInterface
Get the user that sent the notification.
BlueprintInterface::getSubject() — Method in class BlueprintInterface
Get the model that is the subject of this activity.
BlueprintInterface::getData() — Method in class BlueprintInterface
Get the data to be stored in the notification.
BlueprintInterface::getType() — Method in class BlueprintInterface
Get the serialized type of this activity.
BlueprintInterface::getSubjectModel() — Method in class BlueprintInterface
Get the name of the model class for the subject of this activity.
DiscussionRenamedBlueprint::getFromUser() — Method in class DiscussionRenamedBlueprint
Get the user that sent the notification.
DiscussionRenamedBlueprint::getSubject() — Method in class DiscussionRenamedBlueprint
Get the model that is the subject of this activity.
DiscussionRenamedBlueprint::getData() — Method in class DiscussionRenamedBlueprint
Get the data to be stored in the notification.
DiscussionRenamedBlueprint::getType() — Method in class DiscussionRenamedBlueprint
Get the serialized type of this activity.
DiscussionRenamedBlueprint::getSubjectModel() — Method in class DiscussionRenamedBlueprint
Get the name of the model class for the subject of this activity.
MailableInterface::getEmailViews() — Method in class MailableInterface
Get the names of the views to construct a notification email with.
MailableInterface::getEmailSubject() — Method in class MailableInterface
Get the subject line for a notification email.
Notification::getSubjectModelAttribute() — Method in class Notification
Get the subject model for this notification record by looking up its type in our subject model map.
Notification::getSubjectModels() — Method in class Notification
Get the type-to-subject-model map.
Notification::getBlueprintAttributes() — Method in class Notification
NotificationMailer::generateUnsubscribeToken() — Method in class NotificationMailer
NotificationMailer::getEmailViews() — Method in class NotificationMailer
Retrieves the email views from the blueprint, and enforces that both a plain text and HTML view are provided.
NotificationSyncer::getNotificationDrivers() — Method in class NotificationSyncer
UnsubscribeToken::generate() — Method in class UnsubscribeToken
AbstractEventPost::getContentAttribute() — Method in class AbstractEventPost
Unserialize the content attribute from the database's JSON value.
FloodingException::getType() — Method in class FloodingException
Determine the exception's type.
AuthorFilter::getFilterKey() — Method in class AuthorFilter
This filter will only be run when a query contains a filter param with this key.
DiscussionFilter::getFilterKey() — Method in class DiscussionFilter
This filter will only be run when a query contains a filter param with this key.
IdFilter::getFilterKey() — Method in class IdFilter
This filter will only be run when a query contains a filter param with this key.
NumberFilter::getFilterKey() — Method in class NumberFilter
This filter will only be run when a query contains a filter param with this key.
PostSearcher::getQuery() — Method in class PostSearcher
TypeFilter::getFilterKey() — Method in class TypeFilter
This filter will only be run when a query contains a filter param with this key.
Post::getModels() — Method in class Post
PostRepository::getIndexForNumber() — Method in class PostRepository
Get the position within a discussion where a post with a certain number is. If the post with that number does not exist, the index of the closest post to it will be returned.
DatabaseUuidFailedJobProvider::getTable() — Method in class DatabaseUuidFailedJobProvider
Get a new query builder instance for the table.
AbstractDriver::getSearchers() — Method in class AbstractDriver
AbstractFulltextFilter::getFilterKey() — Method in class AbstractFulltextFilter
This filter will only be run when a query contains a filter param with this key.
AbstractSearcher::getTotalResults() — Method in class AbstractSearcher
DatabaseSearchState::getQuery() — Method in class DatabaseSearchState
FilterInterface::getFilterKey() — Method in class FilterInterface
This filter will only be run when a query contains a filter param with this key.
FilterManager::getFulltext() — Method in class FilterManager
SearchResults::getResults() — Method in class SearchResults
SearchResults::getTotalResults() — Method in class SearchResults
SearchState::getActor() — Method in class SearchState
SearchState::getDefaultSort() — Method in class SearchState
SearchState::getActiveFilters() — Method in class SearchState
Get a list of the filters that are active.
SearcherInterface::getQuery() — Method in class SearcherInterface
DatabaseSettingsRepository::get() — Method in class DatabaseSettingsRepository
You generally should use the Settings extender's `default` method instead to register default values.
DefaultSettingsRepository::get() — Method in class DefaultSettingsRepository
You generally should use the Settings extender's `default` method instead to register default values.
MemoryCacheSettingsRepository::get() — Method in class MemoryCacheSettingsRepository
You generally should use the Settings extender's `default` method instead to register default values.
OverrideSettingsRepository::get() — Method in class OverrideSettingsRepository
You generally should use the Settings extender's `default` method instead to register default values.
SettingsRepositoryInterface::get() — Method in class SettingsRepositoryInterface
You generally should use the Settings extender's `default` method instead to register default values.
$SettingsValidator#globalRulesProperty in class SettingsValidator
These rules apply to all attributes.
UninstalledSettingsRepository::get() — Method in class UninstalledSettingsRepository
You generally should use the Settings extender's `default` method instead to register default values.
GateClass in namespace Flarum\User\Access
Gate::getPolicies() — Method in class Gate
Get all policies for a given model and ability.
AccountActivationMailerTrait::generateToken() — Method in class AccountActivationMailerTrait
AccountActivationMailerTrait::getEmailData() — Method in class AccountActivationMailerTrait
Get the data that should be made available to email templates.
EmailConfirmationMailer::generateToken() — Method in class EmailConfirmationMailer
EmailConfirmationMailer::getEmailData() — Method in class EmailConfirmationMailer
EmailToken::generate() — Method in class EmailToken
GroupsChangedClass in namespace Flarum\User\Event
InvalidConfirmationTokenException::getType() — Method in class InvalidConfirmationTokenException
Determine the exception's type.
NotAuthenticatedException::getType() — Method in class NotAuthenticatedException
Determine the exception's type.
PermissionDeniedException::getType() — Method in class PermissionDeniedException
Determine the exception's type.
GuestClass in namespace Flarum\User
Guest::getGroupsAttribute() — Method in class Guest
Get the guest's group, containing only the 'guests' group model.
PasswordToken::generate() — Method in class PasswordToken
Generate a password token for the specified user.
RegistrationToken::generate() — Method in class RegistrationToken
Generate an auth token for the specified user.
EmailFilter::getFilterKey() — Method in class EmailFilter
This filter will only be run when a query contains a filter param with this key.
GroupFilterClass in namespace Flarum\User\Search\Filter
GroupFilter::getFilterKey() — Method in class GroupFilter
This filter will only be run when a query contains a filter param with this key.
UserSearcher::getQuery() — Method in class UserSearcher
$User#groupProcessorsProperty in class User
An array of callables, through each of which the user's list of groups is passed before being returned.
$User#gateProperty in class User
The access gate.
$User#groupsProperty in class User
User::getHasUploadedAvatarAttribute() — Method in class User
Determine whether the user has uploaded a custom avatar.
User::getAvatarUrlAttribute() — Method in class User
User::getAvatarSrcsetAttribute() — Method in class User
User::getDisplayNameAttribute() — Method in class User
User::getAlertableNotificationTypes() — Method in class User
Get the notification types that should be alerted to this user, according to their preferences.
User::getUnreadNotificationCount() — Method in class User
User::getUnreadNotifications() — Method in class User
User::getNewNotificationCount() — Method in class User
Get the number of new, unseen notifications for the user.
User::getPreferencesAttribute() — Method in class User
Get the values of all registered preferences for this user, by transforming their stored preferences and merging them with the defaults.
User::getPreference() — Method in class User
User::groups() — Method in class User
User::getPermissions() — Method in class User
Get a list of permissions that the user has.
User::getNotificationPreferenceKey() — Method in class User
Get the key for a preference which flags whether the user will receive a notification for $type via $method.
UserRepository::getIdForUsername() — Method in class UserRepository
UserRepository::getIdsForUsernames() — Method in class UserRepository
UserRepository::getIdsForUsername() — Method in class UserRepository
Find users by matching a string of words against their username, optionally making sure they are visible to a certain user.
UserValidator::getUser() — Method in class UserValidator
UserValidator::getRules() — Method in class UserValidator
UserValidator::getMessages() — Method in class UserValidator

H

UpdateExtensionController::handle() — Method in class UpdateExtensionController
WhenSavingSettings::hasDirtySettings() — Method in class WhenSavingSettings
RefreshAnnouncementsCommand::handle() — Method in class RefreshAnnouncementsCommand
ClientMiddlewarePipe::handle() — Method in class ClientMiddlewarePipe
AbstractDeleteController::handle() — Method in class AbstractDeleteController
CreateTokenController::handle() — Method in class CreateTokenController
DeleteSettingsController::handle() — Method in class DeleteSettingsController
ExtensionBisectController::handle() — Method in class ExtensionBisectController
ForgotPasswordController::handle() — Method in class ForgotPasswordController
ListAnnouncementsController::handle() — Method in class ListAnnouncementsController
OrderGroupsController::handle() — Method in class OrderGroupsController
ResolveRegistrationTokenController::handle() — Method in class ResolveRegistrationTokenController
SendConfirmationEmailController::handle() — Method in class SendConfirmationEmailController
SendTestMailController::handle() — Method in class SendTestMailController
SetPermissionController::handle() — Method in class SetPermissionController
SetSettingsController::handle() — Method in class SetSettingsController
ShowForumController::handle() — Method in class ShowForumController
ShowMailSettingsController::handle() — Method in class ShowMailSettingsController
SyncAbandonedExtensionsController::handle() — Method in class SyncAbandonedExtensionsController
UpdateExtensionController::handle() — Method in class UpdateExtensionController
UploadImageController::handle() — Method in class UploadImageController
HasAuthorizationClass in namespace Flarum\Api\Endpoint\Concerns
HasCustomHooksClass in namespace Flarum\Api\Endpoint\Concerns
HasEagerLoadingClass in namespace Flarum\Api\Endpoint\Concerns
This is directed at eager loading relationships apart from the request includes.
HasHooksClass in namespace Flarum\Api\Endpoint\Concerns
Endpoint::handle() — Method in class Endpoint
JsonApi::handle() — Method in class JsonApi
HasHooksClass in namespace Flarum\Api\Resource\Concerns
HasSortMapClass in namespace Flarum\Api\Resource\Concerns
HasValidationRulesClass in namespace Flarum\Api\Schema\Concerns
AbstractCommand::hasOption() — Method in class AbstractCommand
DiscussionPolicy::hide() — Method in class DiscussionPolicy
ReadDiscussionHandler::handle() — Method in class ReadDiscussionHandler
$Discussion#hidden_atProperty in class Discussion
$Discussion#hidden_user_idProperty in class Discussion
Discussion::hide() — Method in class Discussion
DiscussionRenamedLogger::handle() — Method in class DiscussionRenamedLogger
HiddenClass in namespace Flarum\Discussion\Event
HiddenFilterClass in namespace Flarum\Discussion\Search\Filter
ErrorHandling::handler() — Method in class ErrorHandling
Register a handler with custom error handling logic.
Model::hasOne() — Method in class Model
Establish a simple hasOne relationship from this model to another model.
Model::hasMany() — Method in class Model
Establish a simple hasMany relationship from this model to another model.
ToggleExtensionHandler::handle() — Method in class ToggleExtensionHandler
BisectCommand::handle() — Method in class BisectCommand
SyncAbandonedExtensionsCommand::handle() — Method in class SyncAbandonedExtensionsCommand
DefaultLanguagePackGuard::handle() — Method in class DefaultLanguagePackGuard
CircularDependenciesExceptionHandler::handle() — Method in class CircularDependenciesExceptionHandler
DependentExtensionsExceptionHandler::handle() — Method in class DependentExtensionsExceptionHandler
MissingDependenciesExceptionHandler::handle() — Method in class MissingDependenciesExceptionHandler
$Extension#homepageProperty in class Extension
Extension::hasAssets() — Method in class Extension
Tests whether the extension has assets.
Extension::hasMigrations() — Method in class Extension
Tests whether the extension has migrations.
HasFormattedContentClass in namespace Flarum\Formatter
A trait to add formatted content to a model.
ConfirmEmailController::handle() — Method in class ConfirmEmailController
GlobalLogOutController::handle() — Method in class GlobalLogOutController
LogInController::handle() — Method in class LogInController
LogInViewController::handle() — Method in class LogInViewController
LogOutController::handle() — Method in class LogOutController
LogOutViewController::handle() — Method in class LogOutViewController
RegisterController::handle() — Method in class RegisterController
SavePasswordController::handle() — Method in class SavePasswordController
UnsubscribeActionController::handle() — Method in class UnsubscribeActionController
ValidateCustomLess::hasDirtyCustomLessSettings() — Method in class ValidateCustomLess
InteractsWithLaravel::hasDebugModeEnabled() — Method in class InteractsWithLaravel
InteractsWithLaravel::hasBeenBootstrapped() — Method in class InteractsWithLaravel
IlluminateValidationExceptionHandler::handle() — Method in class IlluminateValidationExceptionHandler
JsonApiExceptionHandler::handle() — Method in class JsonApiExceptionHandler
QueryExceptionHandler::handle() — Method in class QueryExceptionHandler
ValidationExceptionHandler::handle() — Method in class ValidationExceptionHandler
HandledErrorClass in namespace Flarum\Foundation\ErrorHandling
An error that was caught / interpreted by Flarum's error handling stack.
HandledError::hasDetails() — Method in class HandledError
HttpFormatterClass in namespace Flarum\Foundation\ErrorHandling
Registry::handle() — Method in class Registry
Map exceptions to handled errors.
HighMaintenanceModeHandlerClass in namespace Flarum\Foundation
HighMaintenanceModeHandler::handle() — Method in class HighMaintenanceModeHandler
Handle the request and return a response.
Site::hasConfigFile() — Method in class Site
HasSourcesClass in namespace Flarum\Frontend\Compiler\Concerns
Controller::handle() — Method in class Controller
$Document#hasNextPageProperty in class Document
Is there a next page?
$Document#headProperty in class Document
An array of strings to append to the page's , rendered *after* the forum/admin stylesheet so that user-supplied