v1.3.0 v1.4.0 v1.5.0 v1.6.0 v1.7.0 v1.8.0 main 2.x

• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

AdminServiceProvider — Class in namespace Flarum\Admin

AdminPayload — Class in namespace Flarum\Admin\Content

ApiKey — Class in namespace Flarum\Api

$ApiKey#allowed_ips — Property in class ApiKey

ApiServiceProvider — Class in namespace Flarum\Api

$Client#actor — Property in class Client

AbstractCreateController — Class in namespace Flarum\Api\Controller

AbstractDeleteController — Class in namespace Flarum\Api\Controller

AbstractListController — Class in namespace Flarum\Api\Controller

AbstractListController::addPaginationData() — Method in class AbstractListController

AbstractSerializeController — Class in namespace Flarum\Api\Controller

AbstractSerializeController::addInclude() — Method in class AbstractSerializeController

Include the given relationship by default.

AbstractSerializeController::addOptionalInclude() — Method in class AbstractSerializeController

Make the given relationship available for inclusion.

AbstractSerializeController::addSortField() — Method in class AbstractSerializeController

Allow sorting results by the given field.

AbstractSerializeController::addDataPreparationCallback() — Method in class AbstractSerializeController

AbstractSerializeController::addSerializationPreparationCallback() — Method in class AbstractSerializeController

AbstractShowController — Class in namespace Flarum\Api\Controller

AbstractSerializer — Class in namespace Flarum\Api\Serializer

$AbstractSerializer#actor — Property in class AbstractSerializer

$AbstractSerializer#attributeMutators — Property in class AbstractSerializer

AbstractSerializer::addAttributeMutator() — Method in class AbstractSerializer

AccessTokenSerializer — Class in namespace Flarum\Api\Serializer

$ForumSerializer#assetsFilesystem — Property in class ForumSerializer

ForumSerializer::actor() — Method in class ForumSerializer

AbstractCommand — Class in namespace Flarum\Console

AbstractModel — Class in namespace Flarum\Database

Base model class, building on Eloquent.

$AbstractModel#afterSaveCallbacks — Property in class AbstractModel

An array of callbacks to be run once after the model is saved.

$AbstractModel#afterDeleteCallbacks — Property 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

AuthorFilter — Class in namespace Flarum\Discussion\Search\Filter

Auth — Class in namespace Flarum\Extend

Auth::addPasswordChecker() — Method in class Auth

Add a new password checker.

$Console#addCommands — Property in class Console

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.

$Extension#authors — Property in class Extension

$Extension#autoload — Property in class Extension

$Extension#autoloadDev — Property 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

AssertRegistered — Class in namespace Flarum\Forum\Content

AbstractServiceProvider — Class in namespace Flarum\Foundation

AbstractValidator — Class 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.

AppInterface — Class in namespace Flarum\Foundation

Application — Class in namespace Flarum\Foundation

ApplicationInfoProvider — Class in namespace Flarum\Foundation

AssetsPublishCommand — Class in namespace Flarum\Foundation\Console

AddLocaleAssets — Class in namespace Flarum\Frontend

AddTranslations — Class in namespace Flarum\Frontend

Assets — Class 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

Assets — Class in namespace Flarum\Frontend\Content

$Assets#assets — Property 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#appView — Property in class Document

The name of the frontend app view to display.

AccessToken — Class in namespace Flarum\Http

AccessTokenPolicy — Class in namespace Flarum\Http\Access

ActorReference — Class in namespace Flarum\Http

AbstractHtmlController — Class in namespace Flarum\Http\Controller

AccessTokenSearcher — Class in namespace Flarum\Http\Filter

AuthenticateWithHeader — Class in namespace Flarum\Http\Middleware

AuthenticateWithSession — Class 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.

$FileDataProvider#adminUser — Property in class FileDataProvider

LocaleManager::addLocale() — Method in class LocaleManager

LocaleManager::addTranslations() — Method in class LocaleManager

LocaleManager::addJsFile() — Method in class LocaleManager

LocaleManager::addCssFile() — Method in class LocaleManager

DriverInterface::availableSettings() — Method in class DriverInterface

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.

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.

NotificationServiceProvider::addType() — Method in class NotificationServiceProvider

NotificationSyncer::addNotificationDriver() — Method in class NotificationSyncer

AbstractEventPost — Class in namespace Flarum\Post

AuthorFilter — Class in namespace Flarum\Post\Filter

RegisteredTypesScope::apply() — Method in class RegisteredTypesScope

Apply the scope to a given Eloquent query builder.

AbstractJob — Class in namespace Flarum\Queue

Listener::addEnvironment() — Method in class Listener

Listener::artisanBinary() — Method in class Listener

AbstractDriver — Class in namespace Flarum\Search

AbstractFulltextFilter — Class in namespace Flarum\Search

AbstractSearcher — Class 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#activeFilters — Property 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

MemoryCacheSettingsRepository::all() — Method in class MemoryCacheSettingsRepository

OverrideSettingsRepository::all() — Method in class OverrideSettingsRepository

SettingsRepositoryInterface::all() — Method in class SettingsRepositoryInterface

UninstalledSettingsRepository::all() — Method in class UninstalledSettingsRepository

AbstractPolicy — Class 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.

AccountActivationMailer — Class in namespace Flarum\User

AccountActivationMailerTrait — Class in namespace Flarum\User

AvatarUploader — Class in namespace Flarum\User

AvatarValidator — Class in namespace Flarum\User

AvatarValidator::assertValid() — Method in class AvatarValidator

Throw an exception if a model is not valid.

AvatarValidator::assertFileRequired() — Method in class AvatarValidator

AvatarValidator::assertFileMimes() — Method in class AvatarValidator

AvatarValidator::assertFileSize() — Method in class AvatarValidator

Activated — Class in namespace Flarum\User\Event

AvatarChanged — Class in namespace Flarum\User\Event

AvatarDeleting — Class in namespace Flarum\User\Event

AvatarSaving — Class in namespace Flarum\User\Event

$User#avatar_url — Property in class User

$User#accessTokens — Property 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

ApiServiceProvider::boot() — Method in class ApiServiceProvider

$Client#body — Property in class Client

$AbstractSerializeController#beforeDataCallbacks — Property in class AbstractSerializeController

$AbstractSerializeController#beforeSerializationCallbacks — Property in class AbstractSerializeController

AbstractSerializeController::buildParameters() — Method in class AbstractSerializeController

AbstractSerializer::buildRelationship() — Method in class AbstractSerializer

BasicDiscussionSerializer — Class in namespace Flarum\Api\Serializer

BasicPostSerializer — Class in namespace Flarum\Api\Serializer

BasicUserSerializer — Class in namespace Flarum\Api\Serializer

BusServiceProvider — Class 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

Notification::beforeSending() — Method in class Notification

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

$Application#booted — Property in class Application

$Application#bootingCallbacks — Property in class Application

$Application#bootedCallbacks — Property 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#base — Property in class Paths

SiteInterface::bootApp() — Method in class SiteInterface

Create and boot a Flarum application instance.

BasicTitleDriver — Class in namespace Flarum\Frontend\Driver

Group::boot() — Method in class Group

Group::build() — Method in class Group

GroupServiceProvider::boot() — Method in class GroupServiceProvider

HttpServiceProvider::boot() — Method in class HttpServiceProvider

RouteCollectionUrlGenerator::base() — Method in class RouteCollectionUrlGenerator

BaseUrl — Class in namespace Flarum\Install

$FileDataProvider#baseUrl — Property in class FileDataProvider

$UserDataProvider#baseUrl — Property in class UserDataProvider

InstallServiceProvider::boot() — Method in class InstallServiceProvider

DriverInterface::buildTransport() — Method in class DriverInterface

Build a mail transport based on Flarum's current settings.

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.

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.

BlueprintInterface — Class 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#beforeSendingCallbacks — Property in class NotificationSyncer

NotificationSyncer::beforeSending() — Method in class NotificationSyncer

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

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

AdminPayload::checkAdvancedPageEmpty() — Method in class AdminPayload

$ApiKey#casts — Property in class ApiKey

$ApiKey#created_at — Property in class ApiKey

Client — Class in namespace Flarum\Api

ClientMiddlewarePipe — Class in namespace Flarum\Api

AbstractListController::createElement() — Method in class AbstractListController

Create a PHP JSON-API Element for output in the document.

$AbstractSerializeController#container — Property in class AbstractSerializeController

AbstractSerializeController::createElement() — Method in class AbstractSerializeController

Create a PHP JSON-API Element for output in the document.

AbstractShowController::createElement() — Method in class AbstractShowController

Create a PHP JSON-API Element for output in the document.

ClearCacheController — Class in namespace Flarum\Api\Controller

CreateAccessTokenController — Class in namespace Flarum\Api\Controller

Not to be confused with the CreateTokenController, this controller is used by the actor to manually create a developer type access token.

CreateDiscussionController — Class in namespace Flarum\Api\Controller

CreateGroupController — Class in namespace Flarum\Api\Controller

CreatePostController — Class in namespace Flarum\Api\Controller

CreateTokenController — Class 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.

CreateUserController — Class in namespace Flarum\Api\Controller

$AbstractSerializer#container — Property in class AbstractSerializer

$AbstractSerializer#customRelations — Property in class AbstractSerializer

CurrentUserSerializer — Class in namespace Flarum\Api\Serializer

$ForumSerializer#config — Property in class ForumSerializer

ConsoleServiceProvider — Class in namespace Flarum\Console

$Schedule#config — Property in class Schedule

$AbstractModel#customRelations — Property in class AbstractModel

$AbstractModel#customCasts — Property in class AbstractModel

GenerateDumpCommand::configure() — Method in class GenerateDumpCommand

MigrateCommand::configure() — Method in class MigrateCommand

ResetCommand::configure() — Method in class ResetCommand

Collection — Class in namespace Flarum\Database\Eloquent

Migration::createTable() — Method in class Migration

Migration::createTableIfNotExists() — Method in class Migration

DiscussionPolicy::can() — Method in class DiscussionPolicy

$Discussion#casts — Property in class Discussion

$Discussion#comment_count — Property in class Discussion

$Discussion#created_at — Property in class Discussion

$Discussion#comments — Property in class Discussion

Discussion::comments() — Method in class Discussion

The discussion's publicly-visible comments.

AuthorFilter::constrain() — Method in class AuthorFilter

CreatedFilter — Class 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#casts — Property in class UserState

Conditional — Class 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#conditions — Property in class Conditional

An array of conditions and their associated extenders.

Console — Class in namespace Flarum\Extend

Console::command() — Method in class Console

Add a command to the console.

Csrf — Class in namespace Flarum\Extend

$Csrf#csrfExemptRoutes — Property 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.

ToggleExtensionCommand::configure() — Method in class ToggleExtensionCommand

CircularDependenciesException — Class in namespace Flarum\Extension\Exception

CircularDependenciesExceptionHandler — Class in namespace Flarum\Extension\Exception

$Extension#conflict — Property 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#configurationCallbacks — Property 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.

ConfirmEmailController — Class in namespace Flarum\Forum\Controller

ConfirmEmailViewController — Class in namespace Flarum\Forum\Controller

$AbstractServiceProvider#container — Property in class AbstractServiceProvider

$AbstractValidator#configuration — Property in class AbstractValidator

Application::config() — Method in class Application

InteractsWithLaravel::configPath() — Method in class InteractsWithLaravel

AssetsPublishCommand::configure() — Method in class AssetsPublishCommand

CacheClearCommand — Class in namespace Flarum\Foundation\Console

CacheClearCommand::configure() — Method in class CacheClearCommand

InfoCommand::configure() — Method in class InfoCommand

ContainerUtil — Class in namespace Flarum\Foundation

ClearingCache — Class in namespace Flarum\Foundation\Event

Assets::css() — Method in class Assets

CompilerInterface — Class 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#cacheDir — Property in class LessCompiler

$LessCompiler#customFunctions — Property 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#commonAssets — Property in class Assets

Controller — Class in namespace Flarum\Frontend

$Document#contentView — Property in class Document

The name of the frontend content view to display.

$Document#content — Property in class Document

The SEO content of the page, displayed within the layout in

$Document#canonicalUrl — Property in class Document

The canonical URL for this page.

$Document#css — Property in class Document

An array of CSS URLs to load.

$Frontend#content — Property in class Frontend

Frontend::content() — Method in class Frontend

GroupPolicy::can() — Method in class GroupPolicy

CreateGroup — Class in namespace Flarum\Group\Command

CreateGroupHandler — Class in namespace Flarum\Group\Command

Created — Class in namespace Flarum\Group\Event

$Group#casts — Property in class Group

$Group#color — Property in class Group

$Permission#casts — Property in class Permission

$AccessToken#casts — Property in class AccessToken

$AccessToken#created_at — Property in class AccessToken

CookieFactory — Class in namespace Flarum\Http

CheckCsrfToken — Class in namespace Flarum\Http\Middleware

CollectGarbage — Class in namespace Flarum\Http\Middleware

ContentTypeOptionsHeader — Class in namespace Flarum\Http\Middleware

$StartSession#config — Property 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

Composite — Class in namespace Flarum\Install\Prerequisite

$LocaleManager#css — Property 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?

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?

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#casts — Property in class Notification

$Notification#created_at — Property in class Notification

$UnsubscribeToken#casts — Property in class UnsubscribeToken

$UnsubscribeToken#created_at — Property in class UnsubscribeToken

$AbstractEventPost#content — Property in class AbstractEventPost

PostPolicy::can() — Method in class PostPolicy

CommentPost — Class in namespace Flarum\Post

A standard comment in a discussion.

$Post#casts — Property in class Post

$Post#created_at — Property in class Post

$Post#content — Property in class Post

ModelObserver::created() — Method in class ModelObserver

$MemoryCacheSettingsRepository#cache — Property in class MemoryCacheSettingsRepository

AbstractPolicy::checkAbility() — Method in class AbstractPolicy

UserPolicy::can() — Method in class UserPolicy

ConfirmEmail — Class in namespace Flarum\User\Command

ConfirmEmailHandler — Class in namespace Flarum\User\Command

$EmailToken#casts — Property in class EmailToken

$EmailToken#created_at — Property in class EmailToken

$LoginProvider#casts — Property in class LoginProvider

$LoginProvider#created_at — Property in class LoginProvider

$PasswordToken#casts — Property in class PasswordToken

$PasswordToken#created_at — Property in class PasswordToken

$RegistrationToken#casts — Property in class RegistrationToken

$RegistrationToken#created_at — Property in class RegistrationToken

EmailFilter::constrain() — Method in class EmailFilter

GroupFilter::constrain() — Method in class GroupFilter

$User#casts — Property in class User

$User#comment_count — Property 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

DisableBrowserCache — Class in namespace Flarum\Admin\Middleware

Client::delete() — Method in class Client

AbstractDeleteController::delete() — Method in class AbstractDeleteController

AbstractListController::data() — Method in class AbstractListController

Get the data to be serialized and assigned to the response document.

AbstractSerializeController::data() — Method in class AbstractSerializeController

Get the data to be serialized and assigned to the response document.

ClearCacheController::delete() — Method in class ClearCacheController

CreateAccessTokenController::data() — Method in class CreateAccessTokenController

Get the data to be serialized and assigned to the response document.

CreateDiscussionController::data() — Method in class CreateDiscussionController

Get the data to be serialized and assigned to the response document.

CreateGroupController::data() — Method in class CreateGroupController

Get the data to be serialized and assigned to the response document.

CreatePostController::data() — Method in class CreatePostController

Get the data to be serialized and assigned to the response document.

CreateUserController::data() — Method in class CreateUserController

Get the data to be serialized and assigned to the response document.

DeleteAccessTokenController — Class in namespace Flarum\Api\Controller

DeleteAccessTokenController::delete() — Method in class DeleteAccessTokenController

DeleteAllNotificationsController — Class in namespace Flarum\Api\Controller

DeleteAllNotificationsController::delete() — Method in class DeleteAllNotificationsController

DeleteAvatarController — Class in namespace Flarum\Api\Controller

DeleteAvatarController::data() — Method in class DeleteAvatarController

Get the data to be serialized and assigned to the response document.

DeleteDiscussionController — Class in namespace Flarum\Api\Controller

DeleteDiscussionController::delete() — Method in class DeleteDiscussionController

DeleteFaviconController — Class in namespace Flarum\Api\Controller

DeleteFaviconController::delete() — Method in class DeleteFaviconController

DeleteGroupController — Class in namespace Flarum\Api\Controller

DeleteGroupController::delete() — Method in class DeleteGroupController

DeleteLogoController — Class in namespace Flarum\Api\Controller

DeleteLogoController::delete() — Method in class DeleteLogoController

DeletePostController — Class in namespace Flarum\Api\Controller

DeletePostController::delete() — Method in class DeletePostController

DeleteUserController — Class in namespace Flarum\Api\Controller

DeleteUserController::delete() — Method in class DeleteUserController

ListAccessTokensController::data() — Method in class ListAccessTokensController

Get the data to be serialized and assigned to the response document.

ListDiscussionsController::data() — Method in class ListDiscussionsController

Get the data to be serialized and assigned to the response document.

ListGroupsController::data() — Method in class ListGroupsController

Get the data to be serialized and assigned to the response document.

ListNotificationsController::data() — Method in class ListNotificationsController

Get the data to be serialized and assigned to the response document.

ListPostsController::data() — Method in class ListPostsController

Get the data to be serialized and assigned to the response document.

ListUsersController::data() — Method in class ListUsersController

Get the data to be serialized and assigned to the response document.

ReadAllNotificationsController::delete() — Method in class ReadAllNotificationsController

ShowDiscussionController::data() — Method in class ShowDiscussionController

Get the data to be serialized and assigned to the response document.

ShowExtensionReadmeController::data() — Method in class ShowExtensionReadmeController

Get the data to be serialized and assigned to the response document.

ShowForumController::data() — Method in class ShowForumController

Get the data to be serialized and assigned to the response document.

ShowGroupController::data() — Method in class ShowGroupController

Get the data to be serialized and assigned to the response document.

ShowMailSettingsController::data() — Method in class ShowMailSettingsController

Get the data to be serialized and assigned to the response document.

ShowPostController::data() — Method in class ShowPostController

Get the data to be serialized and assigned to the response document.

ShowUserController::data() — Method in class ShowUserController

Get the data to be serialized and assigned to the response document.

TerminateAllOtherSessionsController::delete() — Method in class TerminateAllOtherSessionsController

UninstallExtensionController::delete() — Method in class UninstallExtensionController

UpdateDiscussionController::data() — Method in class UpdateDiscussionController

Get the data to be serialized and assigned to the response document.

UpdateGroupController::data() — Method in class UpdateGroupController

Get the data to be serialized and assigned to the response document.

UpdateNotificationController::data() — Method in class UpdateNotificationController

Get the data to be serialized and assigned to the response document.

UpdatePostController::data() — Method in class UpdatePostController

Get the data to be serialized and assigned to the response document.

UpdateUserController::data() — Method in class UpdateUserController

Get the data to be serialized and assigned to the response document.

UploadAvatarController::data() — Method in class UploadAvatarController

Get the data to be serialized and assigned to the response document.

UploadImageController::data() — Method in class UploadImageController

Get the data to be serialized and assigned to the response document.

BasicPostSerializer::discussion() — Method in class BasicPostSerializer

DiscussionSerializer — Class in namespace Flarum\Api\Serializer

PostSerializer::discussion() — Method in class PostSerializer

Dispatcher — Class in namespace Flarum\Bus

Schedule::dueEvents() — Method in class Schedule

$AbstractModel#defaults — Property in class AbstractModel

DatabaseMigrationRepository — Class in namespace Flarum\Database

DatabaseMigrationRepository::delete() — Method in class DatabaseMigrationRepository

Remove a migration from the log.

DatabaseServiceProvider — Class in namespace Flarum\Database

Migration::dropColumns() — Method in class Migration

MigrationRepositoryInterface::delete() — Method in class MigrationRepositoryInterface

Remove a migration from the log.

DiscussionPolicy — Class in namespace Flarum\Discussion\Access

DeleteDiscussion — Class in namespace Flarum\Discussion\Command

DeleteDiscussionHandler — Class in namespace Flarum\Discussion\Command

Discussion — Class in namespace Flarum\Discussion

DiscussionRenamedLogger — Class in namespace Flarum\Discussion

DiscussionRepository — Class in namespace Flarum\Discussion

DiscussionServiceProvider — Class in namespace Flarum\Discussion

DiscussionValidator — Class in namespace Flarum\Discussion

Deleted — Class in namespace Flarum\Discussion\Event

Deleting — Class in namespace Flarum\Discussion\Event

DiscussionSearcher — Class in namespace Flarum\Discussion\Search

$UserState#discussion_id — Property in class UserState

$UserState#discussion — Property 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.

Notification::driver() — Method in class Notification

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.

DefaultLanguagePackGuard — Class in namespace Flarum\Extension

Disabled — Class in namespace Flarum\Extension\Event

Disabling — Class in namespace Flarum\Extension\Event

DependentExtensionsException — Class in namespace Flarum\Extension\Exception

This exception is thrown when someone attempts to disable an extension that other enabled extensions depend on.

DependentExtensionsExceptionHandler — Class in namespace Flarum\Extension\Exception

$Extension#description — Property in class Extension

Extension::disable() — Method in class Extension

ExtensionManager::disable() — Method in class ExtensionManager

DriverInterface — Class in namespace Flarum\Filesystem

Discussion — Class in namespace Flarum\Forum\Content

InteractsWithLaravel::databasePath() — Method in class InteractsWithLaravel

DispatchEventsTrait — Class 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

DirectorySource — Class in namespace Flarum\Frontend\Compiler\Source

Document — Class in namespace Flarum\Frontend

A view which renders a HTML skeleton for Flarum's frontend app.

$Document#direction — Property 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

DeleteGroup — Class in namespace Flarum\Group\Command

DeleteGroupHandler — Class in namespace Flarum\Group\Command

Deleted — Class in namespace Flarum\Group\Event

Deleting — Class in namespace Flarum\Group\Event

$CookieFactory#domain — Property in class CookieFactory

DeveloperAccessToken — Class in namespace Flarum\Http

DeveloperTokenCreated — Class in namespace Flarum\Http\Event

$ResolveRoute#dispatcher — Property in class ResolveRoute

$RouteCollection#dataGenerator — Property in class RouteCollection

RouteCollection::delete() — Method in class RouteCollection

DataProviderInterface — Class in namespace Flarum\Install\Console

$FileDataProvider#debug — Property in class FileDataProvider

$FileDataProvider#databaseConfiguration — Property in class FileDataProvider

$InstallCommand#dataSource — Property in class InstallCommand

DriverInterface — Class in namespace Flarum\Mail

An interface for a mail service.

DiscussionRenamedBlueprint — Class in namespace Flarum\Notification\Blueprint

DeleteAllNotifications — Class in namespace Flarum\Notification\Command

DeleteAllNotificationsHandler — Class in namespace Flarum\Notification\Command

DeletedAll — Class in namespace Flarum\Notification\Event

$Notification#data — Property in class Notification

$Notification#deleted_at — Property in class Notification

NotificationRepository::deleteAll() — Method in class NotificationRepository

NotificationSyncer::delete() — Method in class NotificationSyncer

Delete a notification for all users.

DeletePost — Class in namespace Flarum\Post\Command

DeletePostHandler — Class in namespace Flarum\Post\Command

DiscussionRenamedPost — Class in namespace Flarum\Post

A post which indicates that a discussion's title was changed.

Deleted — Class in namespace Flarum\Post\Event

Deleting — Class in namespace Flarum\Post\Event

DiscussionFilter — Class in namespace Flarum\Post\Filter

$Post#discussion_id — Property in class Post

$Post#discussion — Property in class Post

Post::discussion() — Method in class Post

WorkCommand::downForMaintenance() — Method in class WorkCommand

DatabaseSearchDriver — Class in namespace Flarum\Search\Database

DatabaseSearchState — Class 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

DatabaseSettingsRepository — Class in namespace Flarum\Settings

DatabaseSettingsRepository::delete() — Method in class DatabaseSettingsRepository

Deserializing — Class 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

DeleteAvatar — Class in namespace Flarum\User\Command

DeleteAvatarHandler — Class in namespace Flarum\User\Command

DeleteUser — Class in namespace Flarum\User\Command

DeleteUserHandler — Class in namespace Flarum\User\Command

DriverInterface — Class 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.

Deleted — Class in namespace Flarum\User\Event

Deleting — Class in namespace Flarum\User\Event

$User#displayNameDriver — Property in class User

A driver for getting display names.

$User#display_name — Property in class User

$User#discussion_count — Property in class User

$User#discussions — Property in class User

User::discussions() — Method in class User

E

$Client#errorHandling — Property in class Client

ClientMiddlewarePipe::errorHandling() — Method in class ClientMiddlewarePipe

AbstractSerializeController::extractInclude() — Method in class AbstractSerializeController

AbstractSerializeController::extractFields() — Method in class AbstractSerializeController

AbstractSerializeController::extractSort() — Method in class AbstractSerializeController

AbstractSerializeController::extractOffset() — Method in class AbstractSerializeController

AbstractSerializeController::extractLimit() — Method in class AbstractSerializeController

AbstractSerializeController::extractFilter() — Method in class AbstractSerializeController

ListPostsController::extractSort() — Method in class ListPostsController

ListPostsController::extractOffset() — Method in class ListPostsController

ExtensionReadmeSerializer — Class in namespace Flarum\Api\Serializer

PostSerializer::editedUser() — Method in class PostSerializer

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

EditDiscussion — Class in namespace Flarum\Discussion\Command

EditDiscussionHandler — Class in namespace Flarum\Discussion\Command

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

ErrorHandling — Class in namespace Flarum\Extend

ErrorHandling::extend() — Method in class ErrorHandling

Event — Class in namespace Flarum\Extend

Event::extend() — Method in class Event

ExtenderInterface — Class in namespace Flarum\Extend

ExtenderInterface::extend() — Method in class ExtenderInterface

Filesystem::extend() — Method in class Filesystem

Formatter::extend() — Method in class Formatter

Link::extend() — Method in class Link

Mail::extend() — Method in class Mail

Notification::extend() — Method in class Notification

Policy::extend() — Method in class Policy

Post::extend() — Method in class Post

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

View::extendNamespace() — Method in class View

Extend an existing namespace of Laravel views.

View::extend() — Method in class View

Enabled — Class in namespace Flarum\Extension\Event

Enabling — Class in namespace Flarum\Extension\Event

CircularDependenciesExceptionHandler::errorDetails() — Method in class CircularDependenciesExceptionHandler

DependentExtensionsExceptionHandler::errorDetails() — Method in class DependentExtensionsExceptionHandler

ExtensionBootError — Class in namespace Flarum\Extension\Exception

MissingDependenciesExceptionHandler::errorDetails() — Method in class MissingDependenciesExceptionHandler

Extension — Class in namespace Flarum\Extension

$Extension#extensionDependencyIds — Property in class Extension

The IDs of all Flarum extensions that this extension depends on.

$Extension#extra — Property in class Extension

Extension::extend() — Method in class Extension

Extension::enable() — Method in class Extension

ExtensionManager — Class in namespace Flarum\Extension

$ExtensionManager#extensions — Property 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

ExtensionServiceProvider — Class in namespace Flarum\Extension

InteractsWithLaravel::environment() — Method in class InteractsWithLaravel

IlluminateValidationExceptionHandler::errorDetails() — Method in class IlluminateValidationExceptionHandler

ErrorServiceProvider — Class in namespace Flarum\Foundation

EventGeneratorTrait — Class in namespace Flarum\Foundation

$InstalledSite#extenders — Property in class InstalledSite

InstalledSite::extendWith() — Method in class InstalledSite

JsDirectoryCompiler::eachFile() — Method in class JsDirectoryCompiler

EditGroup — Class in namespace Flarum\Group\Command

EditGroupHandler — Class in namespace Flarum\Group\Command

CookieFactory::expire() — Method in class CookieFactory

Make an expired cookie instance.

ExecuteRoute — Class in namespace Flarum\Http\Middleware

$FlarumPromotionHeader#enabled — Property in class FlarumPromotionHeader

$FileDataProvider#extensions — Property in class FileDataProvider

$UnsubscribeToken#email_type — Property in class UnsubscribeToken

PostPolicy::edit() — Method in class PostPolicy

EditPost — Class in namespace Flarum\Post\Command

EditPostHandler — Class in namespace Flarum\Post\Command

$Post#edited_at — Property in class Post

$Post#edited_user_id — Property in class Post

$Post#editedUser — Property in class Post

Post::editedUser() — Method in class Post

UserPolicy::editCredentials() — Method in class UserPolicy

EditUser — Class in namespace Flarum\User\Command

EditUserHandler — Class in namespace Flarum\User\Command

EmailConfirmationMailer — Class in namespace Flarum\User

EmailToken — Class in namespace Flarum\User

$EmailToken#email — Property in class EmailToken

EmailChangeRequested — Class in namespace Flarum\User\Event

EmailChanged — Class in namespace Flarum\User\Event

EmailFilter — Class in namespace Flarum\User\Search\Filter

EmailActivationThrottler — Class in namespace Flarum\User\Throttler

Unactivated users can request a confirmation email, this throttler applies a timeout of 5 minutes between confirmation requests.

EmailChangeThrottler — Class in namespace Flarum\User\Throttler

Users can request an email change, this throttler applies a timeout of 5 minutes between requests.

$User#email — Property in class User

$User#emailTokens — Property in class User

User::emailTokens() — Method in class User

F

ForgotPasswordController — Class in namespace Flarum\Api\Controller

$UploadFaviconController#filePathSettingKey — Property in class UploadFaviconController

$UploadFaviconController#filenamePrefix — Property in class UploadFaviconController

$UploadImageController#fileExtension — Property in class UploadImageController

$UploadImageController#filePathSettingKey — Property in class UploadImageController

$UploadImageController#filenamePrefix — Property in class UploadImageController

$UploadLogoController#filePathSettingKey — Property in class UploadLogoController

$UploadLogoController#filenamePrefix — Property in class UploadLogoController

ForgotPasswordValidator — Class in namespace Flarum\Api

FakeHttpMethods — Class in namespace Flarum\Api\Middleware

AbstractSerializer::formatDate() — Method in class AbstractSerializer

BasicDiscussionSerializer::firstPost() — Method in class BasicDiscussionSerializer

ForumSerializer — Class in namespace Flarum\Api\Serializer

NotificationSerializer::fromUser() — Method in class NotificationSerializer

AbstractCommand::fire() — Method in class AbstractCommand

Factory — Class in namespace Flarum\Console\Cache

GenerateDumpCommand::fire() — Method in class GenerateDumpCommand

MigrateCommand::fire() — Method in class MigrateCommand

ResetCommand::fire() — Method in class ResetCommand

$Discussion#first_post_id — Property in class Discussion

$Discussion#firstPost — Property 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.

FulltextFilter — Class in namespace Flarum\Discussion\Search

$UserState#fillable — Property in class UserState

The attributes that are mass assignable.

Utf8SlugDriver::fromSlug() — Method in class Utf8SlugDriver

Filesystem — Class in namespace Flarum\Extend

Formatter — Class in namespace Flarum\Extend

ToggleExtensionCommand::fire() — Method in class ToggleExtensionCommand

FilesystemManager — Class in namespace Flarum\Filesystem

FilesystemServiceProvider — Class in namespace Flarum\Filesystem

Formatter — Class in namespace Flarum\Formatter

Formatter::flush() — Method in class Formatter

Flush the cache so that the formatter components are regenerated.

FormatterServiceProvider — Class in namespace Flarum\Formatter

ForumServiceProvider — Class in namespace Flarum\Forum

Application::fireAppCallbacks() — Method in class Application

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.

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.

Site::fromPaths() — Method in class Site

AddTranslations::forFrontend() — Method in class AddTranslations

$Assets#fileSourceOverrides — Property in class Assets

CompilerInterface::flush() — Method in class CompilerInterface

FileVersioner — Class in namespace Flarum\Frontend\Compiler

JsCompiler::format() — Method in class JsCompiler

JsDirectoryCompiler::flush() — Method in class JsDirectoryCompiler

JsDirectoryCompiler::flushSource() — Method in class JsDirectoryCompiler

$LessCompiler#fileSourceOverrides — Property in class LessCompiler

RevisionCompiler::format() — Method in class RevisionCompiler

RevisionCompiler::flush() — Method in class RevisionCompiler

$DirectorySource#filesystem — Property in class DirectorySource

FileSource — Class 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#foot — Property in class Document

An array of strings to prepend before the page's .

Frontend — Class 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.

UserFilter::filter() — Method in class UserFilter

Filters a query.

FlarumPromotionHeader — Class 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

FileDataProvider — Class in namespace Flarum\Install\Console

InstallCommand::fire() — Method in class InstallCommand

FlarumLogTransport — Class in namespace Flarum\Mail

$Notification#from_user_id — Property in class Notification

$Notification#fromUser — Property in class Notification

Notification::fromUser() — Method in class Notification

NotificationRepository::findByUser() — Method in class NotificationRepository

$UnsubscribeToken#fillable — Property in class UnsubscribeToken

$CommentPost#formatter — Property in class CommentPost

CommentPost::formatContent() — Method in class CommentPost

Get the content rendered as HTML.

FloodingException — Class in namespace Flarum\Post\Exception

AuthorFilter::filter() — Method in class AuthorFilter

Filters a query.

DiscussionFilter::filter() — Method in class DiscussionFilter

Filters a query.

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.

FilterInterface — Class in namespace Flarum\Search\Filter

FilterInterface::filter() — Method in class FilterInterface

Filters a query.

FilterManager — Class in namespace Flarum\Search\Filter

$FilterManager#filters — Property 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

IdSlugDriver::fromSlug() — Method in class IdSlugDriver

$LoginProvider#fillable — Property in class LoginProvider

EmailFilter::filter() — Method in class EmailFilter

Filters a query.

GroupFilter::filter() — Method in class GroupFilter

Filters a query.

FulltextFilter — Class 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

AbstractSerializeController::getRelationsToLoad() — Method in class AbstractSerializeController

Returns the relations to load added by extenders.

AbstractSerializeController::getRelationCallablesToLoad() — Method in class AbstractSerializeController

Returns the relation callables to load added by extenders.

AbstractSerializeController::getContainer() — Method in class AbstractSerializeController

ShowDiscussionController::getRelationsToLoad() — Method in class ShowDiscussionController

Returns the relations to load added by extenders.

ShowDiscussionController::getRelationCallablesToLoad() — Method in class ShowDiscussionController

Returns the relation callables to load added by extenders.

InvalidAccessTokenException::getType() — Method in class InvalidAccessTokenException

Determine the exception's type.

AbstractSerializer::getRequest() — Method in class AbstractSerializer

AbstractSerializer::getActor() — Method in class AbstractSerializer

AbstractSerializer::getAttributes() — Method in class AbstractSerializer

AbstractSerializer::getDefaultAttributes() — Method in class AbstractSerializer

Get the default set of serialized attributes for a model.

AbstractSerializer::getRelationship() — Method in class AbstractSerializer

AbstractSerializer::getCustomRelationship() — Method in class AbstractSerializer

Get a custom relationship.

AbstractSerializer::getRelationshipData() — Method in class AbstractSerializer

AbstractSerializer::getContainer() — Method in class AbstractSerializer

AccessTokenSerializer::getDefaultAttributes() — Method in class AccessTokenSerializer

Get the default set of serialized attributes for a model.

BasicDiscussionSerializer::getDefaultAttributes() — Method in class BasicDiscussionSerializer

BasicPostSerializer::getDefaultAttributes() — Method in class BasicPostSerializer

BasicUserSerializer::getDefaultAttributes() — Method in class BasicUserSerializer

BasicUserSerializer::groups() — Method in class BasicUserSerializer

CurrentUserSerializer::getDefaultAttributes() — Method in class CurrentUserSerializer

DiscussionSerializer::getDefaultAttributes() — Method in class DiscussionSerializer

ExtensionReadmeSerializer::getDefaultAttributes() — Method in class ExtensionReadmeSerializer

ExtensionReadmeSerializer::getId() — Method in class ExtensionReadmeSerializer

ExtensionReadmeSerializer::getType() — Method in class ExtensionReadmeSerializer

ForumSerializer::getId() — Method in class ForumSerializer

ForumSerializer::getDefaultAttributes() — Method in class ForumSerializer

ForumSerializer::groups() — Method in class ForumSerializer

ForumSerializer::getLogoUrl() — Method in class ForumSerializer

ForumSerializer::getFaviconUrl() — Method in class ForumSerializer

ForumSerializer::getAssetUrl() — Method in class ForumSerializer

GroupSerializer — Class in namespace Flarum\Api\Serializer

GroupSerializer::getDefaultAttributes() — Method in class GroupSerializer

MailSettingsSerializer::getDefaultAttributes() — Method in class MailSettingsSerializer

MailSettingsSerializer::getId() — Method in class MailSettingsSerializer

NotificationSerializer::getDefaultAttributes() — Method in class NotificationSerializer

PostSerializer::getDefaultAttributes() — Method in class PostSerializer

UserSerializer::getDefaultAttributes() — Method in class UserSerializer

Dispatcher::getCommandHandler() — Method in class Dispatcher

AbstractModel::getCasts() — Method in class AbstractModel

AbstractModel::getAttribute() — Method in class AbstractModel

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

AbstractModel::getCustomRelation() — Method in class AbstractModel

Get a custom relation object.

GenerateDumpCommand — Class 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.

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.

Extension::getVersion() — Method in class Extension

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::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.

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.

Index::getApiDocument() — Method in class Index

Get the result of an API request to list discussions.

User::getApiDocument() — Method in class User

Get the result of an API request to show a user.

GlobalLogOutController — Class in namespace Flarum\Forum\Controller

AbstractValidator::getRules() — 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::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

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.

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

JsDirectoryCompiler::getSources() — 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

GroupPolicy — Class in namespace Flarum\Group\Access

GroupSearcher — Class 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.

Group — Class in namespace Flarum\Group

GroupRepository — Class in namespace Flarum\Group

GroupServiceProvider — Class in namespace Flarum\Group

GroupValidator — Class in namespace Flarum\Group

$Permission#group_id — Property 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.

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

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

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.

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

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

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.

CommentPost::getContentAttribute() — Method in class CommentPost

CommentPost::getParsedContentAttribute() — Method in class CommentPost

CommentPost::getFormatter() — Method in class CommentPost

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.

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.

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#globalRules — Property 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.

Gate — Class 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.

AvatarValidator::getMaxSize() — Method in class AvatarValidator

AvatarValidator::getAllowedTypes() — Method in class AvatarValidator

EmailConfirmationMailer::generateToken() — Method in class EmailConfirmationMailer

EmailConfirmationMailer::getEmailData() — Method in class EmailConfirmationMailer

EmailToken::generate() — Method in class EmailToken

GroupsChanged — Class 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.

Guest — Class 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.

GroupFilter — Class 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#groupProcessors — Property in class User

An array of callables, through each of which the user's list of groups is passed before being returned.

$User#gate — Property in class User

The access gate.

$User#groups — Property in class User

User::getAvatarUrlAttribute() — 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

ClientMiddlewarePipe::handle() — Method in class ClientMiddlewarePipe

AbstractCreateController::handle() — Method in class AbstractCreateController

AbstractDeleteController::handle() — Method in class AbstractDeleteController

AbstractSerializeController::handle() — Method in class AbstractSerializeController

CreateTokenController::handle() — Method in class CreateTokenController

ForgotPasswordController::handle() — Method in class ForgotPasswordController

SendConfirmationEmailController::handle() — Method in class SendConfirmationEmailController

SendTestMailController::handle() — Method in class SendTestMailController

SetPermissionController::handle() — Method in class SetPermissionController

SetSettingsController::handle() — Method in class SetSettingsController

UpdateExtensionController::handle() — Method in class UpdateExtensionController

AbstractSerializer::hasOne() — Method in class AbstractSerializer

Get a relationship builder for a has-one relationship.

AbstractSerializer::hasMany() — Method in class AbstractSerializer

Get a relationship builder for a has-many relationship.

BasicDiscussionSerializer::hiddenUser() — Method in class BasicDiscussionSerializer

PostSerializer::hiddenUser() — Method in class PostSerializer

AbstractCommand::hasOption() — Method in class AbstractCommand

DiscussionPolicy::hide() — Method in class DiscussionPolicy

DeleteDiscussionHandler::handle() — Method in class DeleteDiscussionHandler

EditDiscussionHandler::handle() — Method in class EditDiscussionHandler

ReadDiscussionHandler::handle() — Method in class ReadDiscussionHandler

StartDiscussionHandler::handle() — Method in class StartDiscussionHandler

$Discussion#hidden_at — Property in class Discussion

$Discussion#hidden_user_id — Property in class Discussion

Discussion::hide() — Method in class Discussion

DiscussionRenamedLogger::handle() — Method in class DiscussionRenamedLogger

Hidden — Class in namespace Flarum\Discussion\Event

HiddenFilter — Class in namespace Flarum\Discussion\Search\Filter

ErrorHandling::handler() — Method in class ErrorHandling

Register a handler with custom error handling logic.

ToggleExtensionHandler::handle() — Method in class ToggleExtensionHandler

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#homepage — Property 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.

ConfirmEmailController::handle() — Method in class ConfirmEmailController

GlobalLogOutController::handle() — Method in class GlobalLogOutController

LogInController::handle() — Method in class LogInController

LogOutController::handle() — Method in class LogOutController

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

ValidationExceptionHandler::handle() — Method in class ValidationExceptionHandler

HttpFormatter — Class in namespace Flarum\Foundation\ErrorHandling

MaintenanceModeHandler::handle() — Method in class MaintenanceModeHandler

Handle the request and return a response.

Site::hasConfigFile() — Method in class Site

HasSources — Class in namespace Flarum\Frontend\Compiler\Concerns

Controller::handle() — Method in class Controller

$Document#hasNextPage — Property in class Document

Is there a next page?

$Document#head — Property in class Document

An array of strings to append to the page's .

CreateGroupHandler::handle() — Method in class CreateGroupHandler

DeleteGroupHandler::handle() — Method in class DeleteGroupHandler

EditGroupHandler::handle() — Method in class EditGroupHandler

HiddenFilter — Class in namespace Flarum\Group\Filter

Group::hasPermission() — Method in class Group

AbstractHtmlController::handle() — Method in class AbstractHtmlController

HttpServiceProvider — Class in namespace Flarum\Http

HandleErrors — Class in namespace Flarum\Http\Middleware

Catch exceptions thrown in a PSR-15 middleware stack and handle them safely.

$RememberAccessToken#hidden — Property in class RememberAccessToken

$SessionAccessToken#hidden — Property in class SessionAccessToken

InstallController::handle() — Method in class InstallController

LocaleManager::hasLocale() — Method in class LocaleManager

DeleteAllNotificationsHandler::handle() — Method in class DeleteAllNotificationsHandler

ReadAllNotificationsHandler::handle() — Method in class ReadAllNotificationsHandler

ReadNotificationHandler::handle() — Method in class ReadNotificationHandler

PostPolicy::hide() — Method in class PostPolicy

DeletePostHandler::handle() — Method in class DeletePostHandler

EditPostHandler::handle() — Method in class EditPostHandler

PostReplyHandler::handle() — Method in class PostReplyHandler

CommentPost::hide() — Method in class CommentPost

Hidden — Class in namespace Flarum\Post\Event

$Post#hidden_at — Property in class Post

$Post#hidden_user_id — Property in class Post

$Post#hiddenUser — Property in class Post

Post::hiddenUser() — Method in class Post

IndexJob::handle() — Method in class IndexJob

ModelObserver::hidden() — Method in class ModelObserver

UpdateController::handle() — Method in class UpdateController

AccountActivationMailer::handle() — Method in class AccountActivationMailer

ConfirmEmailHandler::handle() — Method in class ConfirmEmailHandler

DeleteAvatarHandler::handle() — Method in class DeleteAvatarHandler

DeleteUserHandler::handle() — Method in class DeleteUserHandler

EditUserHandler::handle() — Method in class EditUserHandler

UploadAvatarHandler::handle() — Method in class UploadAvatarHandler

EmailConfirmationMailer::handle() — Method in class EmailConfirmationMailer

RequestPasswordResetJob::handle() — Method in class RequestPasswordResetJob

SelfDemotionGuard::handle() — Method in class SelfDemotionGuard

Prevent an admin from removing their admin permission via the API.

SessionManager::handler() — Method in class SessionManager

Returns the configured session handler.

$User#hasher — Property in class User

The hasher with which to hash passwords.

User::hasPermission() — Method in class User

User::hasPermissionLike() — Method in class User

Check whether the user has a permission that is like the given string, based on their groups.

I

Index — Class in namespace Flarum\Admin\Content

$ApiKey#id — Property in class ApiKey

$AbstractSerializeController#include — Property in class AbstractSerializeController

The relationships that are included by default.

$CreateDiscussionController#include — Property in class CreateDiscussionController

$CreatePostController#include — Property in class CreatePostController

$ListDiscussionsController#include — Property in class ListDiscussionsController

$ListNotificationsController#include — Property in class ListNotificationsController

$ListPostsController#include — Property in class ListPostsController

$ListUsersController#include — Property in class ListUsersController

$ShowDiscussionController#include — Property in class ShowDiscussionController

$ShowForumController#include — Property in class ShowForumController

$ShowPostController#include — Property in class ShowPostController

$ShowUserController#include — Property in class ShowUserController

$UpdatePostController#include — Property in class UpdatePostController

$UpdateUserController#include — Property in class UpdateUserController

InvalidAccessTokenException — Class in namespace Flarum\Api\Exception

$AbstractCommand#input — Property in class AbstractCommand

AbstractCommand::info() — Method in class AbstractCommand

Schedule::isDownForMaintenance() — Method in class Schedule

Migrator::installFromSchema() — Method in class Migrator

Initialize the Flarum database from a schema dump.

$Discussion#id — Property in class Discussion

$Discussion#is_private — Property in class Discussion

IdWithTransliteratedSlugDriver — Class in namespace Flarum\Discussion

SearchIndex::indexer() — Method in class SearchIndex

Register an indexer for a resource.

$Extension#id — Property in class Extension

Unique ID of the extension.

$Extension#installed — Property in class Extension

Extension::isInstalled() — Method in class Extension

ExtensionManager::isEnabled() — Method in class ExtensionManager

Index — Class in namespace Flarum\Forum\Content

Application::isBooted() — Method in class Application

ApplicationInfoProvider::identifyQueueDriver() — Method in class ApplicationInfoProvider

ApplicationInfoProvider::identifyDatabaseVersion() — Method in class ApplicationInfoProvider

ApplicationInfoProvider::identifySessionDriver() — Method in class ApplicationInfoProvider

Reports on the session driver in use based on three scenarios:

1. If the configured session driver is valid and in use, it will be returned.

ApplicationInfoProvider::identifyPHPVersion() — Method in class ApplicationInfoProvider

InteractsWithLaravel — Class in namespace Flarum\Foundation\Concerns

Implementation of the Laravel Application Contract, for the sake of better integration with Laravel packages/ecosystem.

InteractsWithLaravel::isDownForMaintenance() — Method in class InteractsWithLaravel

InfoCommand — Class in namespace Flarum\Foundation\Console

IlluminateValidationExceptionHandler — Class in namespace Flarum\Foundation\ErrorHandling\ExceptionHandler

IOException — Class in namespace Flarum\Foundation

InstalledApp — Class in namespace Flarum\Foundation

InstalledSite — Class in namespace Flarum\Foundation

$LessCompiler#importDirs — Property in class LessCompiler

$Group#id — Property in class Group

$Group#icon — Property in class Group

$Group#is_hidden — Property in class Group

$AccessToken#id — Property in class AccessToken

InjectActorReference — Class in namespace Flarum\Http\Middleware

ImageServiceProvider — Class in namespace Flarum\Image

InstallCommand — Class in namespace Flarum\Install\Console

InstallCommand::init() — Method in class InstallCommand

InstallCommand::install() — Method in class InstallCommand

IndexController — Class in namespace Flarum\Install\Controller

InstallController — Class in namespace Flarum\Install\Controller

InstallServiceProvider — Class in namespace Flarum\Install

Installer — Class in namespace Flarum\Install

$Notification#id — Property in class Notification

$UnsubscribeToken#id — Property in class UnsubscribeToken

IdFilter — Class in namespace Flarum\Post\Filter

$Post#id — Property in class Post

$Post#ip_address — Property in class Post

$Post#is_private — Property in class Post

Post::isVisibleTo() — Method in class Post

Determine whether this post is visible to the given user.

IndexerInterface — Class in namespace Flarum\Search

IndexerInterface::index() — Method in class IndexerInterface

IndexJob — Class in namespace Flarum\Search\Job

SearchCriteria::isFulltext() — Method in class SearchCriteria

SearchManager::indexers() — Method in class SearchManager

SearchManager::indexable() — Method in class SearchManager

SearchState::isFulltextSearch() — Method in class SearchState

$MemoryCacheSettingsRepository#isCached — Property in class MemoryCacheSettingsRepository

IndexController — Class in namespace Flarum\Update\Controller

$EmailToken#incrementing — Property in class EmailToken

Use a custom primary key for this model.

InvalidConfirmationTokenException — Class in namespace Flarum\User\Exception

$Guest#id — Property in class Guest

Override the ID of this user, as a guest does not have an ID.

Guest::isGuest() — Method in class Guest

Check whether the user is a guest.

IdSlugDriver — Class in namespace Flarum\User

$LoginProvider#id — Property in class LoginProvider

$LoginProvider#identifier — Property in class LoginProvider

$PasswordToken#incrementing — Property in class PasswordToken

$RegistrationToken#incrementing — Property in class RegistrationToken

Use a custom primary key for this model.

$RegistrationToken#identifier — Property in class RegistrationToken

$User#id — Property in class User

$User#is_email_confirmed — Property in class User

User::isAdmin() — Method in class User

User::isGuest() — Method in class User

Check whether the user is a guest.

J

JsonApiResponse — Class in namespace Flarum\Api

InteractsWithLaravel::joinPaths() — Method in class InteractsWithLaravel

Assets::js() — Method in class Assets

Assets::jsDirectory() — Method in class Assets

JsCompiler — Class in namespace Flarum\Frontend\Compiler

JsDirectoryCompiler — Class in namespace Flarum\Frontend\Compiler

Used to copy JS files from a package directory to the assets' directory.

$Document#js — Property in class Document

An array of JavaScript URLs to load.

$LocaleManager#js — Property in class LocaleManager

$User#joined_at — Property in class User

K

$ApiKey#key — Property in class ApiKey

$Extension#keywords — Property in class Extension

KnownError — Class in namespace Flarum\Foundation

An exception that has a well-known meaning in a Flarum application.

L

$ApiKey#last_activity_at — Property in class ApiKey

$AbstractSerializeController#limit — Property in class AbstractSerializeController

The number of records included by default.

$AbstractSerializeController#loadRelations — Property in class AbstractSerializeController

$AbstractSerializeController#loadRelationCallables — Property in class AbstractSerializeController

AbstractSerializeController::loadRelations() — Method in class AbstractSerializeController

Eager loads the required relationships.

ListAccessTokensController — Class in namespace Flarum\Api\Controller

ListDiscussionsController — Class in namespace Flarum\Api\Controller

ListGroupsController — Class in namespace Flarum\Api\Controller

$ListGroupsController#limit — Property in class ListGroupsController

ListNotificationsController — Class in namespace Flarum\Api\Controller

ListPostsController — Class in namespace Flarum\Api\Controller

ListUsersController — Class in namespace Flarum\Api\Controller

BasicDiscussionSerializer::lastPostedUser() — Method in class BasicDiscussionSerializer

BasicDiscussionSerializer::lastPost() — Method in class BasicDiscussionSerializer

DatabaseMigrationRepository::log() — Method in class DatabaseMigrationRepository

Log that a migration was run.

Collection::loadAggregate() — Method in class Collection

This is done to prevent conflicts when using visibility scopes.

MigrationRepositoryInterface::log() — Method in class MigrationRepositoryInterface

Log that a migration was run.

$Discussion#last_posted_at — Property in class Discussion

$Discussion#last_posted_user_id — Property in class Discussion

$Discussion#last_post_id — Property in class Discussion

$Discussion#last_post_number — Property in class Discussion

$Discussion#lastPost — Property in class Discussion

$Discussion#lastPostedUser — Property in class Discussion

Discussion::lastPost() — Method in class Discussion

Discussion::lastPostedUser() — Method in class Discussion

$UserState#last_read_at — Property in class UserState

$UserState#last_read_post_number — Property in class UserState

Event::listen() — Method in class Event

Add a listener to a domain event dispatched by flarum or a flarum extension.

LifecycleInterface — Class in namespace Flarum\Extend

Link — Class in namespace Flarum\Extend

$Extension#license — Property in class Extension

LogInController — Class in namespace Flarum\Forum\Controller

LogOutController — Class in namespace Flarum\Forum\Controller

LogInValidator — Class in namespace Flarum\Forum

$Application#loadedProviders — Property in class Application

InteractsWithLaravel::langPath() — Method in class InteractsWithLaravel

InteractsWithLaravel::loadDeferredProviders() — Method in class InteractsWithLaravel

LogReporter — Class in namespace Flarum\Foundation\ErrorHandling

Log caught exceptions to a PSR-3 logger instance.

Site::loadConfig() — Method in class Site

Site::loadExtenders() — Method in class Site

$Assets#lessImportOverrides — Property in class Assets

Assets::localeJs() — Method in class Assets

Assets::localeCss() — Method in class Assets

LessCompiler — Class in namespace Flarum\Frontend\Compiler

$LessCompiler#lessImportOverrides — Property in class LessCompiler

$Document#language — Property in class Document

The language of the document, displayed as the value of the attribute lang in the tag.

$Document#layoutView — Property in class Document

The name of the frontend layout view to display.

$AccessToken#lifetime — Property in class AccessToken

How long this access token should be valid from the time of last activity.

$AccessToken#last_activity_at — Property in class AccessToken

$AccessToken#last_ip_address — Property in class AccessToken

$AccessToken#last_user_agent — Property in class AccessToken

$DeveloperAccessToken#lifetime — Property in class DeveloperAccessToken

$RememberAccessToken#lifetime — Property in class RememberAccessToken

$SessionAccessToken#lifetime — Property in class SessionAccessToken

SessionAuthenticator::logIn() — Method in class SessionAuthenticator

SessionAuthenticator::logOut() — Method in class SessionAuthenticator

LocaleManager — Class in namespace Flarum\Locale

$LocaleManager#locales — Property in class LocaleManager

LocaleServiceProvider — Class in namespace Flarum\Locale

PrefixedYamlFileLoader::load() — Method in class PrefixedYamlFileLoader

ListenCommand — Class in namespace Flarum\Queue\Console

Listener — Class in namespace Flarum\Queue

$AvatarValidator#laravelValidator — Property in class AvatarValidator

LoggedIn — Class in namespace Flarum\User\Event

LoggedOut — Class in namespace Flarum\User\Event

LoginProvider — Class in namespace Flarum\User

$LoginProvider#last_login_at — Property in class LoginProvider

LoginProvider::logIn() — Method in class LoginProvider

Get the user associated with the provider so that they can be logged in.

$User#last_seen_at — Property in class User

$User#loginProviders — Property in class User

User::loginProviders() — Method in class User

M

$ClientMiddlewarePipe#middlewares — Property in class ClientMiddlewarePipe

$AbstractSerializeController#maxLimit — Property in class AbstractSerializeController

The maximum number of records that can be requested.

UploadFaviconController::makeImage() — Method in class UploadFaviconController

UploadImageController::makeImage() — Method in class UploadImageController

UploadLogoController::makeImage() — Method in class UploadLogoController

BasicDiscussionSerializer::mostRelevantPost() — Method in class BasicDiscussionSerializer

MailSettingsSerializer — Class in namespace Flarum\Api\Serializer

MigrateCommand — Class in namespace Flarum\Database\Console

MigrationKeyMissing — Class in namespace Flarum\Database\Exception

Migration — Class in namespace Flarum\Database

Migration factory.

MigrationRepositoryInterface — Class in namespace Flarum\Database

Migrator — Class in namespace Flarum\Database

$Discussion#modifiedPosts — Property in class Discussion

An array of posts that have been modified during this request.

Discussion::mergePost() — Method in class Discussion

Save a post, attempting to merge it with the discussion's last post.

Discussion::mostRelevantPost() — Method in class Discussion

Mail — Class in namespace Flarum\Extend

Policy::modelPolicy() — Method in class Policy

Add a custom policy for when an ability check is ran on an instance of a model.

MissingDependenciesException — Class in namespace Flarum\Extension\Exception

This exception is thrown when someone attempts to enable an extension whose Flarum extension dependencies are not all enabled.

MissingDependenciesExceptionHandler — Class in namespace Flarum\Extension\Exception

Extension::migrate() — Method in class Extension

ExtensionManager::migrate() — Method in class ExtensionManager

Runs the database migrations for the extension.

ExtensionManager::migrateDown() — Method in class ExtensionManager

Runs the database migrations to reset the database to its old state.

ResponseFactory::make() — Method in class ResponseFactory

AbstractValidator::makeValidator() — Method in class AbstractValidator

Application::markAsRegistered() — Method in class Application

InteractsWithLaravel::maintenanceMode() — Method in class InteractsWithLaravel

MaintenanceModeHandler — Class in namespace Flarum\Foundation

Assets::makeJs() — Method in class Assets

Assets::makeCss() — Method in class Assets

Assets::makeLocaleJs() — Method in class Assets

Assets::makeLocaleCss() — Method in class Assets

Assets::makeJsDirectory() — Method in class Assets

Assets::makeJsCompiler() — Method in class Assets

Assets::makeLessCompiler() — Method in class Assets

Assets::makeJsDirectoryCompiler() — Method in class Assets

$Document#meta — Property in class Document

An array of meta tags to append to the page's .

Document::makeView() — Method in class Document

Document::makeTitle() — Method in class Document

Document::makeLayout() — Method in class Document

Document::makeContent() — Method in class Document

Document::makePreloads() — Method in class Document

Document::makeHead() — Method in class Document

Document::makeJs() — Method in class Document

Document::makeFoot() — Method in class Document

BasicTitleDriver::makeTitle() — Method in class BasicTitleDriver

TitleDriverInterface::makeTitle() — Method in class TitleDriverInterface

Permission::map() — Method in class Permission

Get a map of permissions to the group IDs that have them.

$AccessToken#models — Property in class AccessToken

A map of access token types, as specified in the type column, to their classes.

CookieFactory::make() — Method in class CookieFactory

Make a new cookie instance.

MethodNotAllowedException — Class in namespace Flarum\Http\Exception

MailServiceProvider — Class in namespace Flarum\Mail

Mailer — Class in namespace Flarum\Mail

MailgunDriver — Class in namespace Flarum\Mail

MailableInterface — Class in namespace Flarum\Notification

NotificationRepository::markAllAsRead() — Method in class NotificationRepository

MergeableInterface — Class in namespace Flarum\Post

A post that has the ability to be merged into an adjacent post.

$Post#models — Property in class Post

A map of post types, as specified in the type column, to their classes.

ModelObserver — Class in namespace Flarum\Search\Listener

MemoryCacheSettingsRepository — Class in namespace Flarum\Settings

SettingsValidator::makeValidator() — Method in class SettingsValidator

$User#marked_all_as_read_at — Property in class User

User::markAllAsRead() — Method in class User

Mark all discussions as read.

User::markNotificationsAsRead() — Method in class User

Mark all notifications as read.

N

NotificationSerializer — Class in namespace Flarum\Api\Serializer

AbstractModel::newModelQuery() — Method in class AbstractModel

AbstractModel::newCollection() — Method in class AbstractModel

Migrator::note() — Method in class Migrator

Notification — Class in namespace Flarum\Extend

View::namespace() — Method in class View

Register a new namespace of Laravel views.

$Extension#name — Property in class Extension

Extension::nameToId() — Method in class Extension

InstalledApp::needsUpdate() — Method in class InstalledApp

$Group#name_singular — Property in class Group

$Group#name_plural — Property in class Group

AccessToken::newFromBuilder() — Method in class AccessToken

Create a new model instance according to the access token type.

NullDriver — Class in namespace Flarum\Mail

NotificationDriverInterface — Class in namespace Flarum\Notification\Driver

Notification — Class in namespace Flarum\Notification

Models a notification record in the database.

Notification::notify() — Method in class Notification

Send notifications to the given recipients.

NotificationRepository — Class in namespace Flarum\Notification

NotificationServiceProvider — Class in namespace Flarum\Notification

NotificationSyncer — Class in namespace Flarum\Notification

The Notification Syncer commits notification blueprints to the database, and sends them via email depending on user preference. Where a blueprint represents a single notification, the syncer associates it with a particular user(s) and makes it available in their inbox.

$NotificationSyncer#notificationDrivers — Property in class NotificationSyncer

A map of notification drivers.

NumberFilter — Class in namespace Flarum\Post\Filter

$Post#number — Property in class Post

Post::newFromBuilder() — Method in class Post

Create a new model instance according to the post's type.

AbstractDriver::name() — Method in class AbstractDriver

DatabaseSearchDriver::name() — Method in class DatabaseSearchDriver

NotAuthenticatedException — Class in namespace Flarum\User\Exception

$User#notifications — Property in class User

User::notifications() — Method in class User

O

$AbstractSerializeController#optionalInclude — Property in class AbstractSerializeController

The relationships that are available to be included.

$ListDiscussionsController#optionalInclude — Property in class ListDiscussionsController

$ShowDiscussionController#optionalInclude — Property in class ShowDiscussionController

$AbstractCommand#output — Property in class AbstractCommand

$Migrator#output — Property in class Migrator

$Discussion#observables — Property in class Discussion

Formatter::onEnable() — Method in class Formatter

Formatter::onDisable() — Method in class Formatter

LifecycleInterface::onEnable() — Method in class LifecycleInterface

LifecycleInterface::onDisable() — Method in class LifecycleInterface

Theme::overrideLessImport() — Method in class Theme

This can be used to override LESS files that are imported within the code.

Theme::overrideFileSource() — Method in class Theme

This method allows overriding LESS file sources.

View::onEnable() — Method in class View

View::onDisable() — Method in class View

$Extension#optionalDependencyIds — Property in class Extension

The IDs of all Flarum extensions that this extension should be booted after if enabled.

LessCompiler::overrideSources() — Method in class LessCompiler

LessCompiler::overrideImports() — Method in class LessCompiler

Pipeline::on() — Method in class Pipeline

$NotificationSyncer#onePerUser — Property in class NotificationSyncer

Whether notifications are being limited to one per user.

NotificationSyncer::onePerUser() — Method in class NotificationSyncer

Limit notifications to one per user for the entire duration of the given callback.

$CommentPost#observables — Property in class CommentPost

OverrideSettingsRepository — Class in namespace Flarum\Settings

A settings repository decorator that allows overriding certain values.

P

AdminServiceProvider::populateRoutes() — Method in class AdminServiceProvider

DisableBrowserCache::process() — Method in class DisableBrowserCache

RequireAdministrateAbility::process() — Method in class RequireAdministrateAbility

ApiServiceProvider::populateRoutes() — Method in class ApiServiceProvider

$Client#parent — Property in class Client

Client::post() — Method in class Client

Client::put() — Method in class Client

Client::patch() — Method in class Client

$ClientMiddlewarePipe#pipe — Property in class ClientMiddlewarePipe

ClientMiddlewarePipe::process() — Method in class ClientMiddlewarePipe

ClientMiddlewarePipe::pipe() — Method in class ClientMiddlewarePipe

FakeHttpMethods::process() — Method in class FakeHttpMethods

ThrottleApi::process() — Method in class ThrottleApi

BasicDiscussionSerializer::posts() — Method in class BasicDiscussionSerializer

PostSerializer — Class in namespace Flarum\Api\Serializer

$Discussion#participant_count — Property in class Discussion

$Discussion#posts — Property in class Discussion

$Discussion#participants — Property in class Discussion

Discussion::posts() — Method in class Discussion

Discussion::participants() — Method in class Discussion

Query the discussion's participants (a list of unique users who have posted in the discussion).

Formatter::parse() — Method in class Formatter

Prepare the system for parsing. This can be used to modify the text that will be parsed, or to modify the parser.

Policy — Class in namespace Flarum\Extend

Post — Class in namespace Flarum\Extend

User::permissionGroups() — Method in class User

Dynamically process a user's list of groups when calculating permissions.

$Extension#provide — Property in class Extension

ExtensionManager::publishAssets() — Method in class ExtensionManager

Copy the assets from an extension's assets directory into public view.

ExtensionManager::pluckTitles() — Method in class ExtensionManager

Returns the titles of the extensions passed.

$Formatter#parsingCallbacks — Property in class Formatter

Formatter::parse() — Method in class Formatter

$Registration#provided — Property in class Registration

$Registration#payload — Property in class Registration

Registration::provide() — Method in class Registration

Registration::provideTrustedEmail() — Method in class Registration

Registration::provideAvatar() — Method in class Registration

ForumServiceProvider::populateRoutes() — Method in class ForumServiceProvider

InteractsWithLaravel::publicPath() — Method in class InteractsWithLaravel

$EventGeneratorTrait#pendingEvents — Property in class EventGeneratorTrait

Paths — Class in namespace Flarum\Foundation

$Paths#public — Property in class Paths

FileVersioner::putRevision() — Method in class FileVersioner

VersionerInterface::putRevision() — Method in class VersionerInterface

$Document#payload — Property in class Document

Other variables to preload into the Flarum JS.

$Document#page — Property in class Document

Which page of content are we on?

$Document#preloads — Property in class Document

An array of preloaded assets.

Frontend::populate() — Method in class Frontend

$Group#permissions — Property in class Group

Group::permissions() — Method in class Group

Permission — Class in namespace Flarum\Group

$Permission#permission — Property in class Permission

$CookieFactory#prefix — Property in class CookieFactory

$CookieFactory#path — Property in class CookieFactory

AuthenticateWithHeader::process() — Method in class AuthenticateWithHeader

AuthenticateWithSession::process() — Method in class AuthenticateWithSession

CheckCsrfToken::process() — Method in class CheckCsrfToken

CollectGarbage::process() — Method in class CollectGarbage

ContentTypeOptionsHeader::process() — Method in class ContentTypeOptionsHeader

ExecuteRoute::process() — Method in class ExecuteRoute

Executes the route handler resolved in ResolveRoute.

FlarumPromotionHeader::process() — Method in class FlarumPromotionHeader

HandleErrors::process() — Method in class HandleErrors

Catch all errors that happen during further middleware execution.

InjectActorReference::process() — Method in class InjectActorReference

ParseJsonBody — Class in namespace Flarum\Http\Middleware

ParseJsonBody::process() — Method in class ParseJsonBody

ProcessIp — Class in namespace Flarum\Http\Middleware

ProcessIp::process() — Method in class ProcessIp

$ReferrerPolicyHeader#policy — Property in class ReferrerPolicyHeader

ReferrerPolicyHeader::process() — Method in class ReferrerPolicyHeader

RememberFromCookie::process() — Method in class RememberFromCookie

ResolveRoute::process() — Method in class ResolveRoute

Resolve the given request from our route collection.

SetLocale::process() — Method in class SetLocale

ShareErrorsFromSession::process() — Method in class ShareErrorsFromSession

StartSession::process() — Method in class StartSession

$RouteCollection#pendingRoutes — Property in class RouteCollection

RouteCollection::post() — Method in class RouteCollection

RouteCollection::put() — Method in class RouteCollection

RouteCollection::patch() — Method in class RouteCollection

RouteCollectionUrlGenerator::path() — Method in class RouteCollectionUrlGenerator

InstallServiceProvider::populateRoutes() — Method in class InstallServiceProvider

Pipeline — Class in namespace Flarum\Install

Pipeline::pipe() — Method in class Pipeline

$Composite#prerequisites — Property in class Composite

Composite::problems() — Method in class Composite

Verify that this prerequisite is fulfilled.

PhpExtensions — Class in namespace Flarum\Install\Prerequisite

PhpExtensions::problems() — Method in class PhpExtensions

Verify that this prerequisite is fulfilled.

PhpVersion — Class in namespace Flarum\Install\Prerequisite

PhpVersion::problems() — Method in class PhpVersion

Verify that this prerequisite is fulfilled.

PrerequisiteInterface — Class in namespace Flarum\Install\Prerequisite

PrerequisiteInterface::problems() — Method in class PrerequisiteInterface

Verify that this prerequisite is fulfilled.

WritablePaths::problems() — Method in class WritablePaths

Verify that this prerequisite is fulfilled.

PrefixedYamlFileLoader — Class in namespace Flarum\Locale

PostPolicy — Class in namespace Flarum\Post\Access

PostReply — Class in namespace Flarum\Post\Command

PostReplyHandler — Class in namespace Flarum\Post\Command

$CommentPost#parsed_content — Property in class CommentPost

Posted — Class in namespace Flarum\Post\Event

PostSearcher — Class in namespace Flarum\Post\Filter

Post — Class in namespace Flarum\Post

PostCreationThrottler — Class in namespace Flarum\Post

PostRepository — Class in namespace Flarum\Post

PostServiceProvider — Class in namespace Flarum\Post

PostValidator — Class in namespace Flarum\Post

UpdateServiceProvider::populateRoutes() — Method in class UpdateServiceProvider

$Gate#policies — Property in class Gate

$EmailToken#primaryKey — Property in class EmailToken

PasswordChanged — Class in namespace Flarum\User\Event

PermissionDeniedException — Class in namespace Flarum\User\Exception

$LoginProvider#provider — Property in class LoginProvider

PasswordToken — Class in namespace Flarum\User

$PasswordToken#primaryKey — Property in class PasswordToken

$RegistrationToken#primaryKey — Property in class RegistrationToken

$RegistrationToken#provider — Property in class RegistrationToken

$RegistrationToken#payload — Property in class RegistrationToken

PasswordResetThrottler — Class in namespace Flarum\User\Throttler

Logged-in users can request password reset email, this throttler applies a timeout of 5 minutes between password resets.

$User#permissions — Property in class User

An array of permissions that this user has.

$User#preferences — Property in class User

$User#passwordCheckers — Property in class User

Callbacks to check passwords.

$User#password — Property in class User

$User#posts — Property in class User

$User#passwordTokens — Property in class User

User::posts() — Method in class User

User::passwordTokens() — Method in class User

User::permissions() — Method in class User

Define the relationship with the permissions of all the groups that the user is in.

Q

$Client#queryParams — Property in class Client

AbstractModel::qualifyColumn() — Method in class AbstractModel

DiscussionRepository::query() — Method in class DiscussionRepository

GroupRepository::query() — Method in class GroupRepository

GroupRepository::queryVisibleTo() — Method in class GroupRepository

PostRepository::query() — Method in class PostRepository

PostRepository::queryVisibleTo() — Method in class PostRepository

PostRepository::queryIds() — Method in class PostRepository

$DatabaseSearchState#query — Property in class DatabaseSearchState

SearchManager::query() — Method in class SearchManager

UserRepository::query() — Method in class UserRepository

R

AdminServiceProvider::register() — Method in class AdminServiceProvider

RequireAdministrateAbility — Class in namespace Flarum\Admin\Middleware

ApiServiceProvider::register() — Method in class ApiServiceProvider

AbstractSerializeController::removeInclude() — Method in class AbstractSerializeController

Don't include the given relationship by default.

AbstractSerializeController::removeOptionalInclude() — Method in class AbstractSerializeController

Don't allow the given relationship to be included.

AbstractSerializeController::removeSortField() — Method in class AbstractSerializeController

Disallow sorting results by the given field.

ReadAllNotificationsController — Class in namespace Flarum\Api\Controller

$ForgotPasswordValidator#rules — Property in class ForgotPasswordValidator

$AbstractSerializer#request — Property in class AbstractSerializer

AbstractSerializer::resolveSerializer() — Method in class AbstractSerializer

AbstractSerializer::resolveSerializerClass() — Method in class AbstractSerializer

BusServiceProvider::register() — Method in class BusServiceProvider

ConsoleServiceProvider::register() — Method in class ConsoleServiceProvider

AbstractModel::releaseAfterSaveCallbacks() — Method in class AbstractModel

AbstractModel::releaseAfterDeleteCallbacks() — Method in class AbstractModel

ResetCommand — Class in namespace Flarum\Database\Console

DatabaseMigrationRepository::repositoryExists() — Method in class DatabaseMigrationRepository

Determine if the migration repository exists.

DatabaseServiceProvider::register() — Method in class DatabaseServiceProvider

Migration::renameTable() — Method in class Migration

Migration::renameColumn() — Method in class Migration

Migration::renameColumns() — Method in class Migration

MigrationRepositoryInterface::repositoryExists() — Method in class MigrationRepositoryInterface

Determine if the migration repository exists.

Migrator::run() — Method in class Migrator

Run the outstanding migrations at a given path.

Migrator::runMigrationList() — Method in class Migrator

Migrator::runUp() — Method in class Migrator

Run "up" a migration instance.

Migrator::reset() — Method in class Migrator

Rolls all the currently applied migrations back.

Migrator::runDown() — Method in class Migrator

Run "down" a migration instance.

Migrator::runClosureMigration() — Method in class Migrator

Runs a closure migration based on the migrate direction.

Migrator::resolveAndRunClosureMigration() — Method in class Migrator

Resolves and run a migration and assign the filename to the exception if needed.

Migrator::resolve() — Method in class Migrator

Resolve a migration instance from a file.

Migrator::repositoryExists() — Method in class Migrator

ScopeVisibilityTrait::registerVisibilityScoper() — Method in class ScopeVisibilityTrait

DiscussionPolicy::rename() — Method in class DiscussionPolicy

ReadDiscussion — Class in namespace Flarum\Discussion\Command

ReadDiscussionHandler — Class in namespace Flarum\Discussion\Command

$Discussion#readers — Property in class Discussion

Discussion::rename() — Method in class Discussion

Discussion::restore() — Method in class Discussion

Discussion::refreshLastPost() — Method in class Discussion

Discussion::refreshCommentCount() — Method in class Discussion

Discussion::refreshParticipantCount() — Method in class Discussion

Discussion::readers() — Method in class Discussion

$DiscussionValidator#rules — Property in class DiscussionValidator

Renamed — Class in namespace Flarum\Discussion\Event

Restored — Class in namespace Flarum\Discussion\Event

UserState::read() — Method in class UserState

Mark the discussion as being read up to a certain point. Raises the DiscussionWasRead event.

Auth::removePasswordChecker() — Method in class Auth

Remove a password checker.

ErrorHandling::reporter() — Method in class ErrorHandling

Register an error reporter.

Formatter::render() — Method in class Formatter

Prepare the system for rendering. This can be used to modify the xml that will be rendered, or to modify the renderer.

ServiceProvider::register() — Method in class ServiceProvider

Register a service provider.

Settings::registerLessConfigVar() — Method in class Settings

Register a setting as a LESS configuration variable.

ThrottleApi::remove() — Method in class ThrottleApi

Remove a throttler registered with this name.

User::registerPreference() — Method in class User

Register a new user preference.

$Extension#require — Property in class Extension

$Extension#requireDev — Property in class Extension

$Extension#replace — Property in class Extension

ExtensionManager::resolveExtensionOrder() — Method in class ExtensionManager

Sort a list of extensions so that they are properly resolved in respect to order.

ExtensionServiceProvider::register() — Method in class ExtensionServiceProvider

FilesystemManager::resolve() — Method in class FilesystemManager

FilesystemServiceProvider::register() — Method in class FilesystemServiceProvider

$Formatter#renderingCallbacks — Property in class Formatter

Formatter::render() — Method in class Formatter

FormatterServiceProvider::register() — Method in class FormatterServiceProvider

Registration — Class in namespace Flarum\Forum\Auth

ResponseFactory — Class in namespace Flarum\Forum\Auth

ConfirmEmailViewController::render() — Method in class ConfirmEmailViewController

RegisterController — Class in namespace Flarum\Forum\Controller

ResetPasswordController — Class in namespace Flarum\Forum\Controller

ResetPasswordController::render() — Method in class ResetPasswordController

UnsubscribeViewController::render() — Method in class UnsubscribeViewController

ForumServiceProvider::register() — Method in class ForumServiceProvider

$LogInValidator#rules — Property in class LogInValidator

$AbstractValidator#rules — Property in class AbstractValidator

Application::registerBaseBindings() — Method in class Application

Application::registerBaseServiceProviders() — Method in class Application

Application::register() — Method in class Application

Application::resolveProvider() — Method in class Application

Resolve a service provider instance from the class name.

Application::registerCoreContainerAliases() — Method in class Application

InteractsWithLaravel::resourcePath() — Method in class InteractsWithLaravel

InteractsWithLaravel::runningInConsole() — Method in class InteractsWithLaravel

InteractsWithLaravel::runningUnitTests() — Method in class InteractsWithLaravel

InteractsWithLaravel::registerConfiguredProviders() — Method in class InteractsWithLaravel

InteractsWithLaravel::registerDeferredProvider() — Method in class InteractsWithLaravel

LogReporter::report() — Method in class LogReporter

Report an error that Flarum was not able to handle to a backend.

Reporter — Class in namespace Flarum\Foundation\ErrorHandling

Reporter::report() — Method in class Reporter

Report an error that Flarum was not able to handle to a backend.

ErrorServiceProvider::register() — Method in class ErrorServiceProvider

EventGeneratorTrait::raise() — Method in class EventGeneratorTrait

EventGeneratorTrait::releaseEvents() — Method in class EventGeneratorTrait

Return and reset all pending events.

InstalledSite::registerLogger() — Method in class InstalledSite

InstalledSite::registerCache() — Method in class InstalledSite

RevisionCompiler — Class in namespace Flarum\Frontend\Compiler

Document::render() — Method in class Document

RecompileFrontendAssets — Class in namespace Flarum\Frontend

Renamed — Class in namespace Flarum\Group\Event

Group::rename() — Method in class Group

$GroupValidator#rules — Property in class GroupValidator

AccessTokenPolicy::revoke() — Method in class AccessTokenPolicy

AbstractHtmlController::render() — Method in class AbstractHtmlController

RouteNotFoundException — Class in namespace Flarum\Http\Exception

HttpServiceProvider::register() — Method in class HttpServiceProvider

ReferrerPolicyHeader — Class in namespace Flarum\Http\Middleware

RememberFromCookie — Class in namespace Flarum\Http\Middleware

ResolveRoute — Class in namespace Flarum\Http\Middleware

RememberAccessToken — Class in namespace Flarum\Http

RememberAccessToken::rememberCookieLifeTime() — Method in class RememberAccessToken

Just a helper method so we can re-use the lifetime value which is protected.

Rememberer — Class in namespace Flarum\Http

Rememberer::remember() — Method in class Rememberer

Sets the remember cookie on a response.

RequestUtil — Class in namespace Flarum\Http

RouteCollection — Class in namespace Flarum\Http

$RouteCollection#reverse — Property in class RouteCollection

$RouteCollection#routeParser — Property in class RouteCollection

$RouteCollection#routes — Property in class RouteCollection

RouteCollection::removeRoute() — Method in class RouteCollection

RouteCollectionUrlGenerator — Class in namespace Flarum\Http

RouteCollectionUrlGenerator::route() — Method in class RouteCollectionUrlGenerator

RouteHandlerFactory — Class in namespace Flarum\Http

$UrlGenerator#routes — Property in class UrlGenerator

ImageServiceProvider::register() — Method in class ImageServiceProvider

IndexController::render() — Method in class IndexController

InstallServiceProvider::register() — Method in class InstallServiceProvider

Pipeline::run() — Method in class Pipeline

ReversibleStep — Class in namespace Flarum\Install

ReversibleStep::revert() — Method in class ReversibleStep

Step::run() — Method in class Step

Do the work that constitutes this step.

LocaleServiceProvider::register() — Method in class LocaleServiceProvider

MailServiceProvider::register() — Method in class MailServiceProvider

ReadAllNotifications — Class in namespace Flarum\Notification\Command

ReadAllNotificationsHandler — Class in namespace Flarum\Notification\Command

ReadNotification — Class in namespace Flarum\Notification\Command

ReadNotificationHandler — Class in namespace Flarum\Notification\Command

NotificationDriverInterface::registerType() — Method in class NotificationDriverInterface

Logic for registering a notification type, generally used for adding a user preference.

Read — Class in namespace Flarum\Notification\Event

ReadAll — Class in namespace Flarum\Notification\Event

$Notification#read_at — Property in class Notification

Notification::read() — Method in class Notification

NotificationServiceProvider::register() — Method in class NotificationServiceProvider

NotificationSyncer::restore() — Method in class NotificationSyncer

Restore a notification for all users.

CommentPost::reply() — Method in class CommentPost

CommentPost::revise() — Method in class CommentPost

CommentPost::restore() — Method in class CommentPost

DiscussionRenamedPost::reply() — Method in class DiscussionRenamedPost

Restored — Class in namespace Flarum\Post\Event

Revised — Class in namespace Flarum\Post\Event

PostServiceProvider::register() — Method in class PostServiceProvider

$PostValidator#rules — Property in class PostValidator

RegisteredTypesScope — Class in namespace Flarum\Post

ModelObserver::restored() — Method in class ModelObserver

SearchServiceProvider::register() — Method in class SearchServiceProvider

SettingsServiceProvider::register() — Method in class SettingsServiceProvider

IndexController::render() — Method in class IndexController

UpdateServiceProvider::register() — Method in class UpdateServiceProvider

AvatarUploader::removeFileAfterSave() — Method in class AvatarUploader

Handle the removal of the old avatar file after a successful user save We don't place this in remove() because otherwise we would call changeAvatarPath 2 times when uploading.

AvatarUploader::remove() — Method in class AvatarUploader

AvatarValidator::raise() — Method in class AvatarValidator

RegisterUser — Class in namespace Flarum\User\Command

Registered — Class in namespace Flarum\User\Event

RegisteringFromProvider — Class in namespace Flarum\User\Event

Renamed — Class in namespace Flarum\User\Event

RequestPasswordResetJob — Class in namespace Flarum\User\Job

RegistrationToken — Class in namespace Flarum\User

SessionServiceProvider::register() — Method in class SessionServiceProvider

$User#read_notifications_at — Property in class User

$User#read — Property in class User

User::register() — Method in class User

User::rename() — Method in class User

User::requestEmailChange() — Method in class User

User::read() — Method in class User

User::registerPreference() — Method in class User

Register a preference with a transformer and a default value.

User::refreshCommentCount() — Method in class User

User::refreshDiscussionCount() — Method in class User

UserServiceProvider::register() — Method in class UserServiceProvider

UserServiceProvider::registerDisplayNameDrivers() — Method in class UserServiceProvider

UserServiceProvider::registerPasswordCheckers() — Method in class UserServiceProvider

S

$ApiKey#scopes — Property in class ApiKey

ApiServiceProvider::setNotificationSerializers() — Method in class ApiServiceProvider

Client::send() — Method in class Client

Execute the given API action class, pass the input and return its response.

$AbstractSerializeController#serializer — Property in class AbstractSerializeController

The name of the serializer class to output results with.

$AbstractSerializeController#sortFields — Property in class AbstractSerializeController

The fields that are available to be sorted by.

$AbstractSerializeController#sort — Property in class AbstractSerializeController

The default sort field and order to use.

AbstractSerializeController::sortIsDefault() — Method in class AbstractSerializeController

AbstractSerializeController::setSerializer() — Method in class AbstractSerializeController

Set the serializer that will serialize data for the endpoint.

AbstractSerializeController::setLimit() — Method in class AbstractSerializeController

Set the default number of results.

AbstractSerializeController::setMaxLimit() — Method in class AbstractSerializeController

Set the maximum number of results.

AbstractSerializeController::setSort() — Method in class AbstractSerializeController

Set the default sort order for the results.

AbstractSerializeController::setContainer() — Method in class AbstractSerializeController

AbstractSerializeController::setLoadRelations() — Method in class AbstractSerializeController

AbstractSerializeController::setLoadRelationCallables() — Method in class AbstractSerializeController

$CreateAccessTokenController#serializer — Property in class CreateAccessTokenController

$CreateDiscussionController#serializer — Property in class CreateDiscussionController

$CreateGroupController#serializer — Property in class CreateGroupController

$CreatePostController#serializer — Property in class CreatePostController

$CreateUserController#serializer — Property in class CreateUserController

$DeleteAvatarController#serializer — Property in class DeleteAvatarController

$ListAccessTokensController#serializer — Property in class ListAccessTokensController

$ListDiscussionsController#serializer — Property in class ListDiscussionsController

$ListDiscussionsController#sort — Property in class ListDiscussionsController

$ListDiscussionsController#sortFields — Property in class ListDiscussionsController

$ListGroupsController#serializer — Property in class ListGroupsController

$ListGroupsController#sortFields — Property in class ListGroupsController

$ListNotificationsController#serializer — Property in class ListNotificationsController

$ListPostsController#serializer — Property in class ListPostsController

$ListPostsController#sortFields — Property in class ListPostsController

$ListUsersController#serializer — Property in class ListUsersController

$ListUsersController#sortFields — Property in class ListUsersController

SendConfirmationEmailController — Class in namespace Flarum\Api\Controller

SendTestMailController — Class in namespace Flarum\Api\Controller

SetPermissionController — Class in namespace Flarum\Api\Controller

SetSettingsController — Class in namespace Flarum\Api\Controller

ShowDiscussionController — Class in namespace Flarum\Api\Controller

$ShowDiscussionController#serializer — Property in class ShowDiscussionController

ShowExtensionReadmeController — Class in namespace Flarum\Api\Controller

$ShowExtensionReadmeController#serializer — Property in class ShowExtensionReadmeController

ShowForumController — Class in namespace Flarum\Api\Controller

$ShowForumController#serializer — Property in class ShowForumController

ShowGroupController — Class in namespace Flarum\Api\Controller

$ShowGroupController#serializer — Property in class ShowGroupController

ShowMailSettingsController — Class in namespace Flarum\Api\Controller

$ShowMailSettingsController#serializer — Property in class ShowMailSettingsController

ShowPostController — Class in namespace Flarum\Api\Controller

$ShowPostController#serializer — Property in class ShowPostController

ShowUserController — Class in namespace Flarum\Api\Controller

$ShowUserController#serializer — Property in class ShowUserController

$UpdateDiscussionController#serializer — Property in class UpdateDiscussionController

$UpdateGroupController#serializer — Property in class UpdateGroupController

$UpdateNotificationController#serializer — Property in class UpdateNotificationController

$UpdatePostController#serializer — Property in class UpdatePostController

$UpdateUserController#serializer — Property in class UpdateUserController

$UploadAvatarController#serializer — Property in class UploadAvatarController

AbstractSerializer::setRequest() — Method in class AbstractSerializer

AbstractSerializer::setContainer() — Method in class AbstractSerializer

AbstractSerializer::setRelationship() — Method in class AbstractSerializer

$ForumSerializer#settings — Property in class ForumSerializer

$NotificationSerializer#subjectSerializers — Property in class NotificationSerializer

A map of notification types (key) to the serializer that should be used to output the notification's subject (value).

NotificationSerializer::subject() — Method in class NotificationSerializer

NotificationSerializer::setSubjectSerializer() — Method in class NotificationSerializer

Factory::store() — Method in class Factory

Schedule — Class in namespace Flarum\Console

Migrator::setOutput() — Method in class Migrator

ScopeVisibilityTrait — Class in namespace Flarum\Database

ScopeVisibilityTrait::scopeWhereVisibleTo() — Method in class ScopeVisibilityTrait

Scope a query to only include records that are visible to a user.

ScopeDiscussionVisibility — Class in namespace Flarum\Discussion\Access

StartDiscussion — Class in namespace Flarum\Discussion\Command

StartDiscussionHandler — Class in namespace Flarum\Discussion\Command

$Discussion#stateUser — Property in class Discussion

The user for which the state relationship should be loaded.

$Discussion#slug — Property in class Discussion

$Discussion#state — Property in class Discussion

Discussion::start() — Method in class Discussion

Discussion::setFirstPost() — Method in class Discussion

Discussion::setLastPost() — Method in class Discussion

Discussion::state() — Method in class Discussion

If no user is passed (i.e. in the case of eager loading the 'state' relation), then the static $stateUser property is used.

Discussion::stateFor() — Method in class Discussion

Get the state model for a user, or instantiate a new one if it does not exist.

Discussion::setStateUser() — Method in class Discussion

Set the user for which the state relationship should be loaded.

Discussion::setTitleAttribute() — Method in class Discussion

Set the discussion title.

DiscussionRepository::scopeVisibleTo() — Method in class DiscussionRepository

Scope a query to only include records that are visible to a user.

Saving — Class in namespace Flarum\Discussion\Event

Started — Class in namespace Flarum\Discussion\Event

FulltextFilter::search() — Method in class FulltextFilter

UserState::setKeysForSaveQuery() — Method in class UserState

Set the keys for a save update query.

$Console#scheduled — Property in class Console

Console::schedule() — Method in class Console

Schedule a command to run on an interval.

ErrorHandling::status() — Method in class ErrorHandling

Define the corresponding HTTP status code for a well-known error type.

Event::subscribe() — Method in class Event

Add a subscriber for a set of domain events dispatched by flarum or a flarum extension.

$Link#setRel — Property in class Link

$Link#setTarget — Property in class Link

Link::setRel() — Method in class Link

Link::setTarget() — Method in class Link

SearchIndex — Class in namespace Flarum\Extend

ServiceProvider — Class in namespace Flarum\Extend

Session — Class in namespace Flarum\Extend

Settings — Class in namespace Flarum\Extend

Settings::serializeToForum() — Method in class Settings

Serialize a setting value to the ForumSerializer attributes.

ThrottleApi::set() — Method in class ThrottleApi

Add a new throttler (or override one with the same name).

$Extension#support — Property in class Extension

$Extension#suggest — Property in class Extension

Extension::setInstalled() — Method in class Extension

Extension::setVersion() — Method in class Extension

ExtensionManager::setEnabledExtensions() — Method in class ExtensionManager

Persist the currently enabled extensions.

ExtensionManager::subExtensionConfsFromJson() — Method in class ExtensionManager

$Registration#suggested — Property in class Registration

Registration::suggest() — Method in class Registration

Registration::suggestUsername() — Method in class Registration

Registration::suggestEmail() — Method in class Registration

Registration::setPayload() — Method in class Registration

SavePasswordController — Class in namespace Flarum\Forum\Controller

ForumServiceProvider::setDefaultRoute() — Method in class ForumServiceProvider

$Application#serviceProviders — Property in class Application

ApplicationInfoProvider::scheduledTasksRegistered() — Method in class ApplicationInfoProvider

InteractsWithLaravel::storagePath() — Method in class InteractsWithLaravel

InteractsWithLaravel::setLocale() — Method in class InteractsWithLaravel

InteractsWithLaravel::shouldSkipMiddleware() — Method in class InteractsWithLaravel

InstalledApp::subPath() — Method in class InstalledApp

$Paths#storage — Property in class Paths

Site — Class in namespace Flarum\Foundation

SiteInterface — Class in namespace Flarum\Foundation

$Assets#sources — Property in class Assets

Assets::setName() — Method in class Assets

Assets::setAssetsDir() — Method in class Assets

Assets::setCacheDir() — Method in class Assets

Assets::setLessImportDirs() — Method in class Assets

CompilerInterface::setFilename() — Method in class CompilerInterface

$HasSources#sourcesCallbacks — Property in class HasSources

JsCompiler::save() — Method in class JsCompiler

JsDirectoryCompiler::setFilename() — Method in class JsDirectoryCompiler

LessCompiler::setCacheDir() — Method in class LessCompiler

LessCompiler::setImportDirs() — Method in class LessCompiler

LessCompiler::setLessImportOverrides() — Method in class LessCompiler

LessCompiler::setFileSourceOverrides() — Method in class LessCompiler

LessCompiler::setCustomFunctions() — Method in class LessCompiler

RevisionCompiler::setFilename() — Method in class RevisionCompiler

RevisionCompiler::save() — Method in class RevisionCompiler

FileSource::setPath() — Method in class FileSource

SourceCollector — Class in namespace Flarum\Frontend\Compiler\Source

$SourceCollector#sources — Property in class SourceCollector

SourceInterface — Class in namespace Flarum\Frontend\Compiler\Source

StringSource — Class in namespace Flarum\Frontend\Compiler\Source

Document::setForumApiDocument() — Method in class Document

Document::setPageParam() — Method in class Document

Document::setQueryParam() — Method in class Document

Set or override a query param on a string URL to a particular value.

ScopeGroupVisibility — Class in namespace Flarum\Group\Access

Saving — Class in namespace Flarum\Group\Event

GroupRepository::scopeVisibleTo() — Method in class GroupRepository

Scope a query to only include records that are visible to a user.

Permission::setKeysForSaveQuery() — Method in class Permission

Set the keys for a save update query.

AccessToken::scopeValid() — Method in class AccessToken

Filters which tokens are valid at the given date for this particular token type.

AccessToken::scopeExpired() — Method in class AccessToken

Filters which tokens are expired at the given date and ready for garbage collection.

AccessToken::scopeWhereValid() — Method in class AccessToken

This query scope is intended to be used on the base AccessToken object to query for valid tokens of any type.

AccessToken::scopeWhereExpired() — Method in class AccessToken

This query scope is intended to be used on the base AccessToken object to query for expired tokens of any type.

AccessToken::setModel() — Method in class AccessToken

ScopeAccessTokenVisibility — Class in namespace Flarum\Http\Access

ActorReference::setActor() — Method in class ActorReference

$CookieFactory#secure — Property in class CookieFactory

$CookieFactory#samesite — Property in class CookieFactory

HttpServiceProvider::setAccessTokenTypes() — Method in class HttpServiceProvider

$CollectGarbage#sessionConfig — Property in class CollectGarbage

SetLocale — Class in namespace Flarum\Http\Middleware

ShareErrorsFromSession — Class in namespace Flarum\Http\Middleware

Inspired by Illuminate\View\Middleware\ShareErrorsFromSession.

StartSession — Class in namespace Flarum\Http\Middleware

SessionAccessToken — Class in namespace Flarum\Http

SessionAuthenticator — Class in namespace Flarum\Http

SlugDriverInterface — Class in namespace Flarum\Http

SlugManager — Class in namespace Flarum\Http

$FileDataProvider#settings — Property in class FileDataProvider

InstallCommand::showProblems() — Method in class InstallCommand

Step — Class in namespace Flarum\Install

StepFailed — Class in namespace Flarum\Install

LocaleManager::setLocale() — Method in class LocaleManager

LocaleManager::setTranslator() — Method in class LocaleManager

Translator::setLocale() — Method in class Translator

FlarumLogTransport::send() — Method in class FlarumLogTransport

{@inheritdoc}

Mailer::send() — Method in class Mailer

SendmailDriver — Class in namespace Flarum\Mail

SmtpDriver — Class in namespace Flarum\Mail

NotificationDriverInterface::send() — Method in class NotificationDriverInterface

Conditionally sends a notification to users, generally using a queue.

$Notification#subjectModels — Property in class Notification

A map of notification types and the model classes to use for their subjects. For example, the 'discussionRenamed' notification type, which represents that a user's discussion was renamed, has the subject model class 'Flarum\Discussion\Discussion'.

$Notification#subject_id — Property in class Notification

$Notification#subject — Property in class Notification

Notification::subject() — Method in class Notification

Notification::scopeWhereSubjectVisibleTo() — Method in class Notification

Scope the query to include only notifications whose subjects are visible to the given user.

Notification::scopeWhereSubject() — Method in class Notification

Scope the query to include only notifications that have the given subject.

Notification::scopeWhereSubjectModel() — Method in class Notification

Scope the query to include only notification types that use the given subject model.

Notification::scopeMatchingBlueprint() — Method in class Notification

Scope the query to find all records matching the given blueprint.

Notification::setSubjectModel() — Method in class Notification

Set the subject model for the given notification type.

Notification::static() — Method in class Notification

NotificationServiceProvider::setNotificationDrivers() — Method in class NotificationServiceProvider

NotificationServiceProvider::setNotificationTypes() — Method in class NotificationServiceProvider

$NotificationSyncer#sentTo — Property in class NotificationSyncer

An internal list of user IDs that notifications have been sent to.

NotificationSyncer::sync() — Method in class NotificationSyncer

Sync a notification so that it is visible to the specified users, and not visible to anyone else. If it is being made visible for the first time, attempt to send the user an email.

NotificationSyncer::setDeleted() — Method in class NotificationSyncer

Set the deleted status of a list of notification records.

AbstractEventPost::setContentAttribute() — Method in class AbstractEventPost

Serialize the content attribute to be stored in the database as JSON.

ScopePostVisibility — Class in namespace Flarum\Post\Access

CommentPost::setContentAttribute() — Method in class CommentPost

CommentPost::setParsedContentAttribute() — Method in class CommentPost

CommentPost::setFormatter() — Method in class CommentPost

DiscussionRenamedPost::saveAfter() — Method in class DiscussionRenamedPost

Save the model, given that it is going to appear immediately after the passed model.

Saving — Class in namespace Flarum\Post\Event

MergeableInterface::saveAfter() — Method in class MergeableInterface

Save the model, given that it is going to appear immediately after the passed model.

Post::scopeAllTypes() — Method in class Post

Get all posts, regardless of their type, by removing the RegisteredTypesScope global scope constraints applied on this model.

Post::setModel() — Method in class Post

PostServiceProvider::setPostTypes() — Method in class PostServiceProvider

AbstractDriver::supports() — Method in class AbstractDriver

AbstractDriver::searcher() — Method in class AbstractDriver

AbstractFulltextFilter::search() — Method in class AbstractFulltextFilter

AbstractSearcher::search() — Method in class AbstractSearcher

DatabaseSearchState::setQuery() — Method in class DatabaseSearchState

IndexerInterface::save() — Method in class IndexerInterface

SearchCriteria — Class in namespace Flarum\Search

Represents the criteria that will determine the entire result set of a query. The limit and offset are not included because they only determine which part of the entire result set will be returned.

SearchManager — Class in namespace Flarum\Search

SearchResults — Class in namespace Flarum\Search

SearchServiceProvider — Class in namespace Flarum\Search

SearchState — Class in namespace Flarum\Search

SearchState::setDefaultSort() — Method in class SearchState

Set the default sort order for the search. This will only be applied if a sort order has not been specified in the search criteria.

SearcherInterface — Class in namespace Flarum\Search

SearcherInterface::search() — Method in class SearcherInterface

DatabaseSettingsRepository::set() — Method in class DatabaseSettingsRepository

Saved — Class in namespace Flarum\Settings\Event

Saving — Class in namespace Flarum\Settings\Event

Serializing — Class in namespace Flarum\Settings\Event

MemoryCacheSettingsRepository::set() — Method in class MemoryCacheSettingsRepository

OverrideSettingsRepository::set() — Method in class OverrideSettingsRepository

SettingsRepositoryInterface — Class in namespace Flarum\Settings

SettingsRepositoryInterface::set() — Method in class SettingsRepositoryInterface

SettingsServiceProvider — Class in namespace Flarum\Settings

SettingsValidator — Class in namespace Flarum\Settings

UninstalledSettingsRepository::set() — Method in class UninstalledSettingsRepository

AbstractPolicy::sanitizeResult() — Method in class AbstractPolicy

Allows true to be used in place of ->allow(), and false instead of ->deny() This allows more concise and intuitive code, by returning boolean statements:.

ScopeUserVisibility — Class in namespace Flarum\User\Access

AccountActivationMailerTrait::sendConfirmationEmail() — Method in class AccountActivationMailerTrait

EmailToken::scopeValidOrFail() — Method in class EmailToken

Find the token with the given ID, and assert that it has not expired.

Saving — Class in namespace Flarum\User\Event

RegistrationToken::scopeValidOrFail() — Method in class RegistrationToken

Find the token with the given ID, and assert that it has not expired.

FulltextFilter::search() — Method in class FulltextFilter

SelfDemotionGuard — Class in namespace Flarum\User

SessionDriverInterface — Class in namespace Flarum\User

SessionManager — Class in namespace Flarum\User

SessionServiceProvider — Class in namespace Flarum\User

User::setGate() — Method in class User

User::setDisplayNameDriver() — Method in class User

User::setPasswordCheckers() — Method in class User

User::setPasswordAttribute() — Method in class User

Set the password attribute, storing it as a hash.

User::setPreferencesAttribute() — Method in class User

Encode an array of preferences for storage in the database.

User::shouldAlert() — Method in class User

Check whether the user should receive an alert for a notification type.

User::shouldEmail() — Method in class User

Check whether the user should receive an email for a notification type.

User::setPreference() — Method in class User

User::setHasher() — Method in class User

Set the hasher with which to hash passwords.

User::setNotificationPreference() — Method in class User

Set the value of a notification preference.

UserRepository::scopeVisibleTo() — Method in class UserRepository

UserValidator::setUser() — Method in class UserValidator

T

ApiKey::touch() — Method in class ApiKey

TerminateAllOtherSessionsController — Class in namespace Flarum\Api\Controller

ThrottleApi — Class in namespace Flarum\Api\Middleware

ThrottleApi::throttle() — Method in class ThrottleApi

$AccessTokenSerializer#type — Property in class AccessTokenSerializer

$BasicDiscussionSerializer#type — Property in class BasicDiscussionSerializer

$BasicPostSerializer#type — Property in class BasicPostSerializer

$BasicUserSerializer#type — Property in class BasicUserSerializer

$ForumSerializer#type — Property in class ForumSerializer

$GroupSerializer#type — Property in class GroupSerializer

$MailSettingsSerializer#type — Property in class MailSettingsSerializer

$NotificationSerializer#type — Property in class NotificationSerializer

$AbstractModel#timestamps — Property in class AbstractModel

Indicates if the model should be timestamped. Turn off by default.

$AbstractModel#tableAlias — Property in class AbstractModel

An alias for the table name, used in queries.

DatabaseMigrationRepository::table() — Method in class DatabaseMigrationRepository

Get a query builder for the migration table.

$Discussion#title — Property in class Discussion

IdWithTransliteratedSlugDriver::toSlug() — Method in class IdWithTransliteratedSlugDriver

$UserState#table — Property in class UserState

Utf8SlugDriver::toSlug() — Method in class Utf8SlugDriver

ErrorHandling::type() — Method in class ErrorHandling

Define the internal error type for a specific exception class.

Notification::type() — Method in class Notification

Post::type() — Method in class Post

Register a new post type. This is generally done for custom 'event posts', such as those that appear when a discussion is renamed.

Theme — Class in namespace Flarum\Extend

ThrottleApi — Class in namespace Flarum\Extend

ToggleExtension — Class in namespace Flarum\Extension\Command

ToggleExtensionHandler — Class in namespace Flarum\Extension\Command

ToggleExtensionCommand — Class in namespace Flarum\Extension\Console

$Extension#type — Property in class Extension

$Extension#time — Property in class Extension

Extension::toArray() — Method in class Extension

Generates an array result for the object.

InteractsWithLaravel::terminating() — Method in class InteractsWithLaravel

InteractsWithLaravel::terminate() — Method in class InteractsWithLaravel

AddLocaleAssets::to() — Method in class AddLocaleAssets

AddTranslations::to() — Method in class AddTranslations

$Document#title — Property in class Document

The title of the document, displayed in the