Index
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
- AbstractCreateController — Class in namespace Flarum\Api\Controller
- AbstractDeleteController — Class in namespace Flarum\Api\Controller
- AbstractListController — Class in namespace Flarum\Api\Controller
- 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
- $Serializing#attributes — Property in class Serializing
- The serialized attributes of the resource.
- $Serializing#actor — Property in class Serializing
- WillGetData::addInclude() — Method in class WillGetData
- Include the given relationship by default.
- WillGetData::addOptionalInclude() — Method in class WillGetData
- Make the given relationship available for inclusion.
- WillGetData::addSortField() — Method in class WillGetData
- Allow sorting results by the given field.
- $WillSerializeData#actor — Property in class WillSerializeData
- AbstractSerializer — Class in namespace Flarum\Api\Serializer
- $AbstractSerializer#actor — Property in class AbstractSerializer
- AbstractSerializer::addMutator() — Method in class AbstractSerializer
- 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
- Add columns to a table.
- Migration::addSettings() — Method in class Migration
- Add default values for config values.
- Migration::addPermissions() — Method in class Migration
- Add default permissions.
- $DeleteDiscussion#actor — Property in class DeleteDiscussion
- The user performing the action.
- $EditDiscussion#actor — Property in class EditDiscussion
- The user performing the action.
- $ReadDiscussion#actor — Property in class ReadDiscussion
- The user to mark the discussion as read for.
- $StartDiscussion#actor — Property in class StartDiscussion
- The user authoring the discussion.
- $Deleted#actor — Property in class Deleted
- $Deleting#actor — Property in class Deleting
- The user who is performing the action.
- $Hidden#actor — Property in class Hidden
- $Renamed#actor — Property in class Renamed
- $Restored#actor — Property in class Restored
- $Saving#actor — Property in class Saving
- The user who is performing the action.
- $Started#actor — Property in class Started
- AuthorGambit — Class in namespace Flarum\Discussion\Search\Gambit
- FulltextGambit::apply() — Method in class FulltextGambit
- Apply conditions to the searcher for a bit of the search string.
- AbstractConfigureGambits — Class in namespace Flarum\Event
- ConfigureNotificationTypes::add() — Method in class ConfigureNotificationTypes
- ConfigurePostTypes::add() — Method in class ConfigurePostTypes
- ConfigureUserPreferences::add() — Method in class ConfigureUserPreferences
- $GetPermission#actor — Property in class GetPermission
- $GetPermission#ability — Property in class GetPermission
- $ScopeModelVisibility#actor — Property in class ScopeModelVisibility
- $ScopeModelVisibility#ability — Property in class ScopeModelVisibility
- ApiController — Class in namespace Flarum\Extend
- ApiController::addInclude() — Method in class ApiController
- Include the given relationship by default.
- ApiController::addOptionalInclude() — Method in class ApiController
- Make the given relationship available for inclusion.
- ApiController::addSortField() — Method in class ApiController
- Allow sorting results by the given field.
- ApiSerializer — Class in namespace Flarum\Extend
- ApiSerializer::attribute() — Method in class ApiSerializer
- $Console#addCommands — Property in class Console
- Middleware::add() — Method in class Middleware
- ModelUrl::addSlugDriver() — Method in class ModelUrl
- Add a slug driver.
- $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::addRenderingCallback() — Method in class Formatter
- AssertRegistered — Class in namespace Flarum\Forum\Content
- $Discussion#api — Property in class Discussion
- $Index#api — Property in class Index
- $User#api — Property in class User
- $ConfirmEmailController#authenticator — Property in class ConfirmEmailController
- $LogInController#apiClient — Property in class LogInController
- $LogInController#authenticator — Property in class LogInController
- $LogOutController#authenticator — Property in class LogOutController
- $RegisterController#api — Property in class RegisterController
- $RegisterController#authenticator — Property in class RegisterController
- $SavePasswordController#authenticator — Property in class SavePasswordController
- $ValidateCustomLess#assets — Property in class ValidateCustomLess
- AbstractServiceProvider — Class in namespace Flarum\Foundation
- $AbstractServiceProvider#app — Property in class AbstractServiceProvider
- 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
- $ValidationException#attributes — Property in class ValidationException
- 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#assetsDir — Property in class Assets
- CompilerInterface::addSources() — Method in class CompilerInterface
- $RevisionCompiler#assetsDir — Property in class RevisionCompiler
- RevisionCompiler::addSources() — Method in class RevisionCompiler
- SourceCollector::addFile() — Method in class SourceCollector
- SourceCollector::addString() — Method in class SourceCollector
- Assets — Class in namespace Flarum\Frontend\Content
- $Assets#assets — Property in class Assets
- $Document#appView — Property in class Document
- The name of the frontend app view to display.
- $Frontend#api — Property in class Frontend
- FrontendServiceProvider::addBaseCss() — Method in class FrontendServiceProvider
- $RecompileFrontendAssets#assets — Property in class RecompileFrontendAssets
- $CreateGroup#actor — Property in class CreateGroup
- The user performing the action.
- $DeleteGroup#actor — Property in class DeleteGroup
- The user performing the action.
- $EditGroup#actor — Property in class EditGroup
- The user performing the action.
- $Created#actor — Property in class Created
- $Deleted#actor — Property in class Deleted
- $Deleting#actor — Property in class Deleting
- The user who is performing the action.
- $Renamed#actor — Property in class Renamed
- $Saving#actor — Property in class Saving
- The user who is performing the action.
- AccessToken — Class in namespace Flarum\Http
- AbstractHtmlController — Class in namespace Flarum\Http\Controller
- AuthenticateWithHeader — Class in namespace Flarum\Http\Middleware
- AuthenticateWithSession — Class in namespace Flarum\Http\Middleware
- RouteCollection::addRoute() — Method in class RouteCollection
- $UrlGenerator#app — Property in class UrlGenerator
- UrlGenerator::addCollection() — Method in class UrlGenerator
- Register a named route collection for URL generation.
- AdminUser — Class in namespace Flarum\Install
- $FileDataProvider#adminUser — Property in class FileDataProvider
- $InstallController#authenticator — Property in class InstallController
- Installation::adminUser() — Method in class Installation
- LocaleManager::addLocale() — Method in class LocaleManager
- LocaleManager::addTranslations() — Method in class LocaleManager
- LocaleManager::addJsFile() — Method in class LocaleManager
- LocaleManager::addCssFile() — Method in class LocaleManager
- DriverInterface::availableSettings() — Method in class DriverInterface
- Provide a list of settings for this driver.
- LogDriver::availableSettings() — Method in class LogDriver
- Provide a list of settings for this driver.
- MailgunDriver::availableSettings() — Method in class MailgunDriver
- Provide a list of settings for this driver.
- NullDriver::availableSettings() — Method in class NullDriver
- Provide a list of settings for this driver.
- 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.
- $ReadAllNotifications#actor — Property in class ReadAllNotifications
- The user performing the action.
- $ReadNotification#actor — Property in class ReadNotification
- The user performing the action.
- AlertNotificationDriver — Class in namespace Flarum\Notification\Driver
- NotificationServiceProvider::addType() — Method in class NotificationServiceProvider
- NotificationSyncer::addNotificationDriver() — Method in class NotificationSyncer
- Adds a notification driver to the list.
- AbstractEventPost — Class in namespace Flarum\Post
- $DeletePost#actor — Property in class DeletePost
- The user performing the action.
- $EditPost#actor — Property in class EditPost
- The user performing the action.
- $PostReply#actor — Property in class PostReply
- The user who is performing the action.
- $CheckingForFlooding#actor — Property in class CheckingForFlooding
- $Deleted#actor — Property in class Deleted
- $Deleting#actor — Property in class Deleting
- The user who is performing the action.
- $Hidden#actor — Property in class Hidden
- $Posted#actor — Property in class Posted
- $Restored#actor — Property in class Restored
- $Revised#actor — Property in class Revised
- $Saving#actor — Property in class Saving
- The user who is performing the action.
- Floodgate::assertNotFlooding() — Method in class Floodgate
- 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
- AbstractRegexGambit — Class in namespace Flarum\Search
- AbstractRegexGambit::apply() — Method in class AbstractRegexGambit
- Apply conditions to the searcher for a bit of the search string.
- AbstractSearch — Class in namespace Flarum\Search
- An object which represents the internal state of a generic search: the search query, the user performing the search, the fallback sort order, and a log of which gambits have been used.
- $AbstractSearch#actor — Property in class AbstractSearch
- $AbstractSearch#activeGambits — Property in class AbstractSearch
- AbstractSearch::addActiveGambit() — Method in class AbstractSearch
- Add a gambit as being active in this search.
- ApplySearchParametersTrait — Class in namespace Flarum\Search
- ApplySearchParametersTrait::applySort() — Method in class ApplySearchParametersTrait
- Apply sort criteria to a discussion search.
- ApplySearchParametersTrait::applyOffset() — Method in class ApplySearchParametersTrait
- ApplySearchParametersTrait::applyLimit() — Method in class ApplySearchParametersTrait
- GambitInterface::apply() — Method in class GambitInterface
- Apply conditions to the searcher for a bit of the search string.
- GambitManager::add() — Method in class GambitManager
- Add a gambit.
- GambitManager::apply() — Method in class GambitManager
- Apply gambits to a search, given a search query.
- GambitManager::applyGambits() — Method in class GambitManager
- GambitManager::applyFulltext() — Method in class GambitManager
- $SearchCriteria#actor — Property in class SearchCriteria
- The user performing the search.
- $SearchResults#areMoreResults — Property in class SearchResults
- SearchResults::areMoreResults() — Method in class SearchResults
- 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
- 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
- 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
- $DeleteAvatar#actor — Property in class DeleteAvatar
- The user performing the action.
- $DeleteUser#actor — Property in class DeleteUser
- The user performing the action.
- $EditUser#actor — Property in class EditUser
- The user performing the action.
- $RegisterUser#actor — Property in class RegisterUser
- The user performing the action.
- $RegisterUserHandler#avatarUploader — Property in class RegisterUserHandler
- $UploadAvatar#actor — Property in class UploadAvatar
- The user performing the action.
- Activated — Class in namespace Flarum\User\Event
- $Activated#actor — Property in class Activated
- AvatarChanged — Class in namespace Flarum\User\Event
- $AvatarChanged#actor — Property in class AvatarChanged
- AvatarDeleting — Class in namespace Flarum\User\Event
- $AvatarDeleting#actor — Property in class AvatarDeleting
- The user performing the action.
- AvatarSaving — Class in namespace Flarum\User\Event
- $AvatarSaving#actor — Property in class AvatarSaving
- The user performing the action.
- $Deleted#actor — Property in class Deleted
- $Deleting#actor — Property in class Deleting
- The user who is performing the action.
- $EmailChanged#actor — Property in class EmailChanged
- $GroupsChanged#actor — Property in class GroupsChanged
- $PasswordChanged#actor — Property in class PasswordChanged
- $Registered#actor — Property in class Registered
- $Renamed#actor — Property in class Renamed
- $Saving#actor — Property in class Saving
- The user who is performing the action.
- EmailGambit::apply() — Method in class EmailGambit
- Apply conditions to the searcher for a bit of the search string.
- FulltextGambit::apply() — Method in class FulltextGambit
- Apply conditions to the searcher for a bit of the search string.
- $User#avatar_url — Property in class User
- User::activate() — Method in class User
- Activate the user's account.
- 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
- Define the relationship with the user's access tokens.
- User::addPreference() — 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
- {@inheritdoc}
- ApiServiceProvider::boot() — Method in class ApiServiceProvider
- {@inheritdoc}
- $AbstractSerializeController#beforeDataCallbacks — Property in class AbstractSerializeController
- $AbstractSerializeController#beforeSerializationCallbacks — Property in class AbstractSerializeController
- AbstractSerializeController::buildParameters() — Method in class AbstractSerializeController
- $CreateDiscussionController#bus — Property in class CreateDiscussionController
- $CreateGroupController#bus — Property in class CreateGroupController
- $CreatePostController#bus — Property in class CreatePostController
- $CreateTokenController#bus — Property in class CreateTokenController
- $CreateUserController#bus — Property in class CreateUserController
- $DeleteAvatarController#bus — Property in class DeleteAvatarController
- $DeleteDiscussionController#bus — Property in class DeleteDiscussionController
- $DeleteGroupController#bus — Property in class DeleteGroupController
- $DeletePostController#bus — Property in class DeletePostController
- $DeleteUserController#bus — Property in class DeleteUserController
- $ForgotPasswordController#bus — Property in class ForgotPasswordController
- $ReadAllNotificationsController#bus — Property in class ReadAllNotificationsController
- $UpdateDiscussionController#bus — Property in class UpdateDiscussionController
- $UpdateGroupController#bus — Property in class UpdateGroupController
- $UpdateNotificationController#bus — Property in class UpdateNotificationController
- $UpdatePostController#bus — Property in class UpdatePostController
- $UpdateUserController#bus — Property in class UpdateUserController
- $UploadAvatarController#bus — Property in class UploadAvatarController
- 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
- AbstractModel::boot() — Method in class AbstractModel
- {@inheritdoc}
- DatabaseServiceProvider::boot() — Method in class DatabaseServiceProvider
- {@inheritdoc}
- $StartDiscussionHandler#bus — Property in class StartDiscussionHandler
- Discussion::boot() — Method in class Discussion
- Boot the model.
- DiscussionServiceProvider::boot() — Method in class DiscussionServiceProvider
- {@inheritdoc}
- Model::belongsTo() — Method in class Model
- Establish a simple belongsTo relationship from this model to another model.
- Model::belongsToMany() — Method in class Model
- Establish a simple belongsToMany relationship from this model to another model.
- ExtensionServiceProvider::boot() — Method in class ExtensionServiceProvider
- {@inheritdoc}
- $ConfirmEmailController#bus — Property in class ConfirmEmailController
- ForumServiceProvider::boot() — Method in class ForumServiceProvider
- {@inheritdoc}
- $Application#booted — Property in class Application
- Indicates if the application has "booted".
- $Application#bootingCallbacks — Property in class Application
- The array of booting callbacks.
- $Application#bootedCallbacks — Property in class Application
- The array of booted callbacks.
- Application::boot() — Method in class Application
- Boot the application's service providers.
- Application::bootProvider() — Method in class Application
- Boot the given service provider.
- Application::booting() — Method in class Application
- Register a new boot listener.
- Application::booted() — Method in class Application
- Register a new "booted" listener.
- 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
- SiteInterface::bootApp() — Method in class SiteInterface
- Create and boot a Flarum application instance.
- UninstalledSite::bootApp() — Method in class UninstalledSite
- Create and boot a Flarum application instance.
- UninstalledSite::bootLaravel() — Method in class UninstalledSite
- FrontendServiceProvider::boot() — Method in class FrontendServiceProvider
- {@inheritdoc}
- Group::boot() — Method in class Group
- Boot the model.
- Group::build() — Method in class Group
- Create a new group.
- GroupServiceProvider::boot() — Method in class GroupServiceProvider
- {@inheritdoc}
- $RouteCollectionUrlGenerator#baseUrl — Property in class RouteCollectionUrlGenerator
- RouteCollectionUrlGenerator::base() — Method in class RouteCollectionUrlGenerator
- Generate a URL to base with UrlGenerator's prefix.
- BaseUrl — Class in namespace Flarum\Install
- $FileDataProvider#baseUrl — Property in class FileDataProvider
- $UserDataProvider#baseUrl — Property in class UserDataProvider
- InstallServiceProvider::boot() — Method in class InstallServiceProvider
- {@inheritdoc}
- Installation::baseUrl() — Method in class Installation
- Installation::build() — Method in class Installation
- LocaleServiceProvider::boot() — Method in class LocaleServiceProvider
- {@inheritdoc}
- DriverInterface::buildTransport() — Method in class DriverInterface
- Build a mail transport based on Flarum's current settings.
- LogDriver::buildTransport() — Method in class LogDriver
- Build a mail transport based on Flarum's current settings.
- 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.
- $Sending#blueprint — Property in class Sending
- The blueprint for the notification.
- NotificationServiceProvider::boot() — Method in class NotificationServiceProvider
- {@inheritdoc}
- DiscussionRenamedPost::buildContent() — Method in class DiscussionRenamedPost
- Build the content attribute.
- Post::boot() — Method in class Post
- {@inheritdoc}
- PostServiceProvider::boot() — Method in class PostServiceProvider
- {@inheritdoc}
- UpdateServiceProvider::boot() — Method in class UpdateServiceProvider
- {@inheritdoc}
- User::boot() — Method in class User
- Boot the model.
- UserServiceProvider::boot() — Method in class UserServiceProvider
- {@inheritdoc}
C
- $AdminPayload#container — Property in class AdminPayload
- $ApiKey#created_at — Property in class ApiKey
- Client — Class in namespace Flarum\Api
- $Client#container — Property in class Client
- 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
- $ClearCacheController#command — Property in class ClearCacheController
- 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
- CreateUserController — Class in namespace Flarum\Api\Controller
- $SendTestMailController#container — Property in class SendTestMailController
- $WillGetData#controller — Property in class WillGetData
- $WillSerializeData#controller — Property in class WillSerializeData
- $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
- $AbstractModel#customRelations — Property in class AbstractModel
- $GenerateMigrationCommand#creator — Property in class GenerateMigrationCommand
- GenerateMigrationCommand::configure() — Method in class GenerateMigrationCommand
- {@inheritdoc}
- $MigrateCommand#container — Property in class MigrateCommand
- MigrateCommand::configure() — Method in class MigrateCommand
- {@inheritdoc}
- ResetCommand::configure() — Method in class ResetCommand
- {@inheritdoc}
- $DatabaseMigrationRepository#connection — Property in class DatabaseMigrationRepository
- The name of the database connection to use.
- DatabaseMigrationRepository::createRepository() — Method in class DatabaseMigrationRepository
- Create the migration repository data store.
- Migration::createTable() — Method in class Migration
- Create a table.
- MigrationCreator::create() — Method in class MigrationCreator
- Create a new migration for the given extension.
- MigrationRepositoryInterface::createRepository() — Method in class MigrationRepositoryInterface
- Create the migration repository data store.
- DiscussionPolicy::can() — Method in class DiscussionPolicy
- $Discussion#casts — Property in class Discussion
- The attributes that should be cast to native types.
- $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
- Define the relationship with the discussion's publicly-visible comments.
- $Searching#criteria — Property in class Searching
- AuthorGambit::conditions() — Method in class AuthorGambit
- Apply conditions to the search, given that the gambit was matched.
- CreatedGambit — Class in namespace Flarum\Discussion\Search\Gambit
- CreatedGambit::conditions() — Method in class CreatedGambit
- Apply conditions to the search, given that the gambit was matched.
- HiddenGambit::conditions() — Method in class HiddenGambit
- Apply conditions to the search, given that the gambit was matched.
- UnreadGambit::conditions() — Method in class UnreadGambit
- Apply conditions to the search, given that the gambit was matched.
- ConfigureDiscussionGambits — Class in namespace Flarum\Event
- ConfigureNotificationTypes — Class in namespace Flarum\Event
- ConfigurePostTypes — Class in namespace Flarum\Event
- ConfigurePostsQuery — Class in namespace Flarum\Event
- ConfigureUserGambits — Class in namespace Flarum\Event
- ConfigureUserPreferences — Class in namespace Flarum\Event
- Compat — Class in namespace Flarum\Extend
- This class is used to wrap old bootstrap.php closures (as used in versions up to 0.1.0-beta7) in the new Extender format.
- 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.
- Frontend::css() — Method in class Frontend
- Frontend::content() — Method in class Frontend
- Validator::configure() — Method in class Validator
- Configure the validator. This is often used to adjust validation rules, but can be used to make other changes to the validator as well.
- $Extension#composerJson — Property in class Extension
- Composer json of the package.
- $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
- $ExtensionManager#config — Property in class ExtensionManager
- $ExtensionManager#container — Property in class ExtensionManager
- Configuring — Class in namespace Flarum\Formatter\Event
- $Configuring#configurator — Property in class Configuring
- $Parsing#context — Property in class Parsing
- $Rendering#context — Property in class Rendering
- $Formatter#configurationCallbacks — Property in class Formatter
- $Formatter#cache — Property in class Formatter
- $Formatter#cacheDir — Property in class Formatter
- Formatter::configureExternalLinks() — Method in class Formatter
- ConfirmEmailController — Class in namespace Flarum\Forum\Controller
- $ValidateCustomLess#container — Property in class ValidateCustomLess
- $AbstractValidator#configuration — Property in class AbstractValidator
- Application::config() — Method in class Application
- Config — Class in namespace Flarum\Foundation
- CacheClearCommand — Class in namespace Flarum\Foundation\Console
- $CacheClearCommand#cache — Property in class CacheClearCommand
- CacheClearCommand::configure() — Method in class CacheClearCommand
- {@inheritdoc}
- $InfoCommand#config — Property in class InfoCommand
- InfoCommand::configure() — Method in class InfoCommand
- {@inheritdoc}
- ContainerUtil — Class in namespace Flarum\Foundation
- ClearingCache — Class in namespace Flarum\Foundation\Event
- $InstalledApp#container — Property in class InstalledApp
- $InstalledApp#config — Property in class InstalledApp
- $InstalledSite#config — Property in class InstalledSite
- $Assets#cacheDir — Property in class Assets
- Assets::css() — Method in class Assets
- CompilerInterface — Class in namespace Flarum\Frontend\Compiler
- CompilerInterface::commit() — Method in class CompilerInterface
- $LessCompiler#cacheDir — 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
- $StringSource#callback — Property in class StringSource
- $Assets#container — Property in class Assets
- $Assets#config — Property in class Assets
- CorePayload — Class in namespace Flarum\Frontend\Content
- 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#color — Property in class Group
- $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
- $RememberFromCookie#cookie — Property in class RememberFromCookie
- $StartSession#cookie — Property in class StartSession
- $StartSession#config — Property in class StartSession
- $Rememberer#cookie — Property in class Rememberer
- $RouteHandlerFactory#container — Property in class RouteHandlerFactory
- DataProviderInterface::configure() — Method in class DataProviderInterface
- FileDataProvider::configure() — Method in class FileDataProvider
- InstallCommand::configure() — Method in class InstallCommand
- UserDataProvider::configure() — Method in class UserDataProvider
- Installation::configPath() — Method in class Installation
- $Installer#container — Property in class Installer
- Composite — Class in namespace Flarum\Install\Prerequisite
- ConnectToDatabase — Class in namespace Flarum\Install\Steps
- CreateAdminUser — Class in namespace Flarum\Install\Steps
- $LocaleManager#css — Property in class LocaleManager
- $LocaleManager#cacheDir — 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?
- LogDriver::canSend() — Method in class LogDriver
- Does this driver actually send out emails?
- MailgunDriver::canSend() — Method in class MailgunDriver
- Does this driver actually send out emails?
- NullDriver::canSend() — Method in class NullDriver
- Does this driver actually send out emails?
- 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#created_at — Property in class Notification
- $AbstractEventPost#content — Property in class AbstractEventPost
- PostPolicy::can() — Method in class PostPolicy
- CommentPost — Class in namespace Flarum\Post
- A standard comment in a discussion.
- CheckingForFlooding — Class in namespace Flarum\Post\Event
- $Post#casts — Property in class Post
- The attributes that should be cast to native types.
- $Post#created_at — Property in class Post
- $Post#content — Property in class Post
- QueueFactory::connection() — Method in class QueueFactory
- Resolve a queue connection instance.
- $QueueServiceProvider#commands — Property in class QueueServiceProvider
- AbstractRegexGambit::conditions() — Method in class AbstractRegexGambit
- Apply conditions to the search, given that the gambit was matched.
- $GambitManager#container — Property in class GambitManager
- $MemoryCacheSettingsRepository#cache — Property in class MemoryCacheSettingsRepository
- $UpdateController#command — Property in class UpdateController
- $UpdateController#config — Property in class UpdateController
- AbstractPolicy::checkAbility() — Method in class AbstractPolicy
- $Gate#container — Property in class Gate
- UserPolicy::can() — Method in class UserPolicy
- ConfirmEmail — Class in namespace Flarum\User\Command
- ConfirmEmailHandler — Class in namespace Flarum\User\Command
- $EmailToken#created_at — Property in class EmailToken
- CheckingPassword — Class in namespace Flarum\User\Event
- $Searching#criteria — Property in class Searching
- $LoginProvider#created_at — Property in class LoginProvider
- $PasswordToken#created_at — Property in class PasswordToken
- $RegistrationToken#casts — Property in class RegistrationToken
- $RegistrationToken#created_at — Property in class RegistrationToken
- EmailGambit::conditions() — Method in class EmailGambit
- Apply conditions to the search, given that the gambit was matched.
- GroupGambit::conditions() — Method in class GroupGambit
- Apply conditions to the search, given that the gambit was matched.
- $User#comment_count — Property in class User
- User::changeEmail() — Method in class User
- Change the user's email.
- User::changePassword() — Method in class User
- Change the user's password.
- User::changeAvatarPath() — Method in class User
- Change the path of the user avatar.
- User::checkPassword() — Method in class User
- Check if a given password matches the user's password.
- User::can() — Method in class User
- User::cannot() — Method in class User
D
- $AdminPayload#db — Property in class AdminPayload
- $ApiKey#dates — Property in class ApiKey
- AbstractDeleteController::delete() — Method in class AbstractDeleteController
- Delete the resource.
- AbstractSerializeController::data() — Method in class AbstractSerializeController
- Get the data to be serialized and assigned to the response document.
- ClearCacheController::delete() — Method in class ClearCacheController
- Delete the resource.
- 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.
- 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
- Delete the resource.
- DeleteFaviconController — Class in namespace Flarum\Api\Controller
- DeleteFaviconController::delete() — Method in class DeleteFaviconController
- Delete the resource.
- DeleteGroupController — Class in namespace Flarum\Api\Controller
- DeleteGroupController::delete() — Method in class DeleteGroupController
- Delete the resource.
- DeleteLogoController — Class in namespace Flarum\Api\Controller
- DeleteLogoController::delete() — Method in class DeleteLogoController
- Delete the resource.
- DeletePostController — Class in namespace Flarum\Api\Controller
- DeletePostController::delete() — Method in class DeletePostController
- Delete the resource.
- DeleteUserController — Class in namespace Flarum\Api\Controller
- DeleteUserController::delete() — Method in class DeleteUserController
- Delete the resource.
- 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
- Delete the resource.
- $SetSettingsController#dispatcher — Property in class SetSettingsController
- $ShowDiscussionController#discussions — Property in class ShowDiscussionController
- ShowDiscussionController::data() — Method in class ShowDiscussionController
- 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.
- 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.
- UninstallExtensionController::delete() — Method in class UninstallExtensionController
- Delete the resource.
- 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.
- $WillSerializeData#data — Property in class WillSerializeData
- $WillSerializeData#document — Property in class WillSerializeData
- $AbstractSerializer#dispatcher — Property in class AbstractSerializer
- 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
- $AbstractModel#dateAttributes — Property in class AbstractModel
- $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
- Drop columns from a table.
- 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
- $DeleteDiscussion#discussionId — Property in class DeleteDiscussion
- The ID of the discussion to delete.
- $DeleteDiscussion#data — Property in class DeleteDiscussion
- Any other user input associated with the action. This is unused by default, but may be used by extensions.
- DeleteDiscussionHandler — Class in namespace Flarum\Discussion\Command
- $DeleteDiscussionHandler#discussions — Property in class DeleteDiscussionHandler
- $EditDiscussion#discussionId — Property in class EditDiscussion
- The ID of the discussion to edit.
- $EditDiscussion#data — Property in class EditDiscussion
- The attributes to update on the discussion.
- $EditDiscussionHandler#discussions — Property in class EditDiscussionHandler
- $ReadDiscussion#discussionId — Property in class ReadDiscussion
- The ID of the discussion to mark as read.
- $ReadDiscussionHandler#discussions — Property in class ReadDiscussionHandler
- $StartDiscussion#data — Property in class StartDiscussion
- The discussion attributes.
- Discussion — Class in namespace Flarum\Discussion
- $Discussion#dates — Property in class Discussion
- The attributes that should be mutated to dates.
- DiscussionMetadataUpdater — 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
- $Deleted#discussion — Property in class Deleted
- Deleting — Class in namespace Flarum\Discussion\Event
- $Deleting#discussion — Property in class Deleting
- The discussion that is going to be deleted.
- $Deleting#data — Property in class Deleting
- Any user input associated with the command.
- $Hidden#discussion — Property in class Hidden
- $Renamed#discussion — Property in class Renamed
- $Restored#discussion — Property in class Restored
- $Saving#discussion — Property in class Saving
- The discussion that will be saved.
- $Saving#data — Property in class Saving
- Any user input associated with the command.
- $Started#discussion — Property in class Started
- $IdWithTransliteratedSlugDriver#discussions — Property in class IdWithTransliteratedSlugDriver
- DiscussionSearch — Class in namespace Flarum\Discussion\Search
- An object which represents the internal state of a search for discussions: the search query, the user performing the search, the fallback sort order, relevant post information, and a log of which gambits have been used.
- $DiscussionSearch#defaultSort — Property in class DiscussionSearch
- {@inheritdoc}
- DiscussionSearcher — Class in namespace Flarum\Discussion\Search
- $DiscussionSearcher#discussions — Property in class DiscussionSearcher
- $UnreadGambit#discussions — Property in class UnreadGambit
- $UserState#dates — Property in class UserState
- The attributes that should be mutated to dates.
- $UserState#discussion_id — Property in class UserState
- $UserState#discussion — Property in class UserState
- UserState::discussion() — Method in class UserState
- Define the relationship with the discussion that this state is for.
- Mail::driver() — Method in class Mail
- Add a mail driver.
- Model::dateAttribute() — Method in class Model
- Add an attribute to be treated as a date.
- Model::default() — Method in class Model
- Add a default value for a given attribute, which can be an explicit value, a closure,
or an instance of an invokable class. Unlike with some other extenders,
it CANNOT be the
::class
attribute of an invokable class. - Notification::driver() — Method in class Notification
- Routes::delete() — Method in class Routes
- 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.
- $DependentExtensionsException#dependent_extensions — Property in class DependentExtensionsException
- DependentExtensionsExceptionHandler — Class in namespace Flarum\Extension\Exception
- $Extension#description — Property in class Extension
- Extension::disable() — Method in class Extension
- $ExtensionManager#dispatcher — Property in class ExtensionManager
- ExtensionManager::disable() — Method in class ExtensionManager
- Disables an extension.
- Discussion — Class in namespace Flarum\Forum\Content
- DispatchEventsTrait — Class in namespace Flarum\Foundation
- DispatchEventsTrait::dispatchEventsFor() — Method in class DispatchEventsTrait
- Dispatch all events for an entity.
- JsCompiler::delete() — Method in class JsCompiler
- RevisionCompiler::delete() — Method in class RevisionCompiler
- 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
- $CreateGroup#data — Property in class CreateGroup
- The attributes of the new group.
- DeleteGroup — Class in namespace Flarum\Group\Command
- $DeleteGroup#data — Property in class DeleteGroup
- Any other group input associated with the action. This is unused by default, but may be used by extensions.
- DeleteGroupHandler — Class in namespace Flarum\Group\Command
- $EditGroup#data — Property in class EditGroup
- The attributes to update on the post.
- Deleted — Class in namespace Flarum\Group\Event
- Deleting — Class in namespace Flarum\Group\Event
- $Deleting#data — Property in class Deleting
- Any user input associated with the command.
- $Saving#data — Property in class Saving
- The attributes to update on the group.
- $AccessToken#dates — Property in class AccessToken
- $CookieFactory#domain — Property in class CookieFactory
- A domain scope for the cookies.
- $ResolveRoute#dispatcher — Property in class ResolveRoute
- $RouteCollection#dataGenerator — Property in class RouteCollection
- RouteCollection::delete() — Method in class RouteCollection
- $SlugManager#drivers — Property in class SlugManager
- 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
- DatabaseConfig — Class in namespace Flarum\Install
- Installation::debugMode() — Method in class Installation
- Installation::databaseConfig() — Method in class Installation
- DriverInterface — Class in namespace Flarum\Mail
- An interface for a mail service.
- DiscussionRenamedBlueprint — Class in namespace Flarum\Notification\Blueprint
- $Notification#dates — Property in class Notification
- The attributes that should be mutated to dates.
- $Notification#data — Property in class Notification
- $Notification#deleted_at — Property in class Notification
- NotificationSyncer::delete() — Method in class NotificationSyncer
- Delete a notification for all users.
- DeletePost — Class in namespace Flarum\Post\Command
- $DeletePost#data — Property in class DeletePost
- Any other user input associated with the action. This is unused by default, but may be used by extensions.
- DeletePostHandler — Class in namespace Flarum\Post\Command
- $EditPost#data — Property in class EditPost
- The attributes to update on the post.
- $PostReply#discussionId — Property in class PostReply
- The ID of the discussion to post the reply to.
- $PostReply#data — Property in class PostReply
- The attributes to assign to the new post.
- $PostReplyHandler#discussions — Property in class PostReplyHandler
- 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
- $Deleting#data — Property in class Deleting
- Any user input associated with the command.
- $Saving#data — Property in class Saving
- The attributes to update on the post.
- $Post#dates — Property in class Post
- The attributes that should be mutated to dates.
- $Post#discussion_id — Property in class Post
- $Post#discussion — Property in class Post
- Post::discussion() — Method in class Post
- Define the relationship with the post's discussion.
- WorkCommand::downForMaintenance() — Method in class WorkCommand
- QueueServiceProvider::driver() — Method in class QueueServiceProvider
- $AbstractSearch#defaultSort — Property in class AbstractSearch
- DatabaseSettingsRepository — Class in namespace Flarum\Settings
- $DatabaseSettingsRepository#database — Property in class DatabaseSettingsRepository
- 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
- $DeleteUser#data — Property in class DeleteUser
- Any other user input associated with the action. This is unused by default, but may be used by extensions.
- DeleteUserHandler — Class in namespace Flarum\User\Command
- $EditUser#data — Property in class EditUser
- The attributes to update on the user.
- $RegisterUser#data — Property in class RegisterUser
- The attributes of the new user.
- 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.
- $EmailToken#dates — Property in class EmailToken
- The attributes that should be mutated to dates.
- Deleted — Class in namespace Flarum\User\Event
- Deleting — Class in namespace Flarum\User\Event
- $Deleting#data — Property in class Deleting
- Any user input associated with the command.
- $Saving#data — Property in class Saving
- The attributes to update on the user.
- $LoginProvider#dates — Property in class LoginProvider
- $PasswordToken#dates — Property in class PasswordToken
- The attributes that should be mutated to dates.
- $RegistrationToken#dates — Property in class RegistrationToken
- The attributes that should be mutated to dates.
- $User#dates — Property in class User
- The attributes that should be mutated to dates.
- $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() — Method in class User
- Define the relationship with the user's discussions.
E
- $AdminPayload#extensions — Property in class AdminPayload
- $AbstractSerializeController#events — Property in class AbstractSerializeController
- 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
- $CreateTokenController#events — Property in class CreateTokenController
- ListPostsController::extractOffset() — Method in class ListPostsController
- $UninstallExtensionController#extensions — Property in class UninstallExtensionController
- $UpdateExtensionController#extensions — Property in class UpdateExtensionController
- PostSerializer::editedUser() — Method in class PostSerializer
- AbstractCommand::execute() — Method in class AbstractCommand
- {@inheritdoc}
- AbstractCommand::error() — Method in class AbstractCommand
- Send an error or warning message to the user.
- EditDiscussion — Class in namespace Flarum\Discussion\Command
- EditDiscussionHandler — Class in namespace Flarum\Discussion\Command
- $DiscussionSearcher#events — Property in class DiscussionSearcher
- ApiController::extend() — Method in class ApiController
- ApiSerializer::extend() — Method in class ApiSerializer
- Compat::extend() — Method in class Compat
- Console::extend() — Method in class Console
- Csrf::exemptRoute() — Method in class Csrf
- Exempt a named route from CSRF checks.
- Csrf::exemptPath() — Method in class Csrf
- Exempt a path from csrf checks. Wildcards are supported.
- 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
- Formatter::extend() — Method in class Formatter
- Frontend::extend() — Method in class Frontend
- LanguagePack::extend() — Method in class LanguagePack
- Locales::extend() — Method in class Locales
- Mail::extend() — Method in class Mail
- Middleware::extend() — Method in class Middleware
- Model::extend() — Method in class Model
- ModelUrl::extend() — Method in class ModelUrl
- ModelVisibility::extend() — Method in class ModelVisibility
- Notification::extend() — Method in class Notification
- Policy::extend() — Method in class Policy
- Post::extend() — Method in class Post
- Routes::extend() — Method in class Routes
- ServiceProvider::extend() — Method in class ServiceProvider
- Settings::extend() — Method in class Settings
- ThrottleApi::extend() — Method in class ThrottleApi
- User::extend() — Method in class User
- Validator::extend() — Method in class Validator
- View::extend() — Method in class View
- $Disabled#extension — Property in class Disabled
- $Disabling#extension — Property in class Disabling
- Enabled — Class in namespace Flarum\Extension\Event
- $Enabled#extension — Property in class Enabled
- Enabling — Class in namespace Flarum\Extension\Event
- $Enabling#extension — Property in class Enabling
- $Uninstalled#extension — Property in class Uninstalled
- $DependentExtensionsException#extension — Property in class DependentExtensionsException
- DependentExtensionsExceptionHandler::errorDetails() — Method in class DependentExtensionsExceptionHandler
- $MissingDependenciesException#extension — Property in class MissingDependenciesException
- 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
- Enables the extension.
- ExtensionManager::extend() — Method in class ExtensionManager
- Call on all enabled extensions to extend the Flarum application.
- ExtensionServiceProvider — Class in namespace Flarum\Extension
- $Formatter#events — Property in class Formatter
- $LogOutController#events — Property in class LogOutController
- $AbstractValidator#events — Property in class AbstractValidator
- $InfoCommand#extensions — Property in class InfoCommand
- $DispatchEventsTrait#events — Property in class DispatchEventsTrait
- 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
- 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.
- $CheckCsrfToken#exemptRoutes — Property in class CheckCsrfToken
- ExecuteRoute — Class in namespace Flarum\Http\Middleware
- $PhpExtensions#extensions — Property in class PhpExtensions
- EnableBundledExtensions — Class in namespace Flarum\Install\Steps
- EmailNotificationDriver — Class in namespace Flarum\Notification\Driver
- PostPolicy::edit() — Method in class PostPolicy
- EditPost — Class in namespace Flarum\Post\Command
- EditPostHandler — Class in namespace Flarum\Post\Command
- $Floodgate#events — Property in class Floodgate
- $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
- Define the relationship with the user who edited the post.
- ExceptionHandler — Class in namespace Flarum\Queue
- GambitManager::explode() — Method in class GambitManager
- Explode a search query into an array of bits.
- $Gate#events — Property in class Gate
- EditUser — Class in namespace Flarum\User\Command
- EditUserHandler — Class in namespace Flarum\User\Command
- $RequestPasswordReset#email — Property in class RequestPasswordReset
- The email of the user to request a password reset for.
- 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
- $EmailChangeRequested#email — Property in class EmailChangeRequested
- The email they requested to change to.
- EmailChanged — Class in namespace Flarum\User\Event
- EmailGambit — Class in namespace Flarum\User\Search\Gambit
- GroupGambit::extractGroupIdentifiers() — Method in class GroupGambit
- Extract the group names from the pattern match.
- $User#email — Property in class User
- User::emailTokens() — Method in class User
- Define the relationship with the user's email tokens.
F
- $CreateDiscussionController#floodgate — Property in class CreateDiscussionController
- $CreatePostController#floodgate — Property in class CreatePostController
- 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
- Serializing::formatDate() — Method in class Serializing
- 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
- Fire the command.
- GenerateMigrationCommand::fire() — Method in class GenerateMigrationCommand
- Fire the command.
- MigrateCommand::fire() — Method in class MigrateCommand
- Fire the command.
- ResetCommand::fire() — Method in class ResetCommand
- Fire the command.
- $MigrationCreator#files — Property in class MigrationCreator
- The filesystem instance.
- $Migrator#files — Property in class Migrator
- The filesystem instance.
- $Discussion#first_post_id — Property in class Discussion
- $Discussion#firstPost — Property in class Discussion
- Discussion::firstPost() — Method in class Discussion
- Define the relationship with the discussion's first post.
- 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
- FulltextGambit — Class in namespace Flarum\Discussion\Search\Gambit
- $ConfigurePostsQuery#filter — Property in class ConfigurePostsQuery
- Formatter — Class in namespace Flarum\Extend
- Frontend — Class in namespace Flarum\Extend
- $ExtensionManager#filesystem — Property in class ExtensionManager
- 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
- Call the booting callbacks for the application.
- CacheClearCommand::fire() — Method in class CacheClearCommand
- Fire the command.
- InfoCommand::fire() — Method in class InfoCommand
- Fire the command.
- HttpFormatter::format() — Method in class HttpFormatter
- Create an HTTP Response to represent the error we are handling.
- JsonApiFormatter::format() — Method in class JsonApiFormatter
- Create an HTTP Response to represent the error we are handling.
- ViewFormatter::format() — Method in class ViewFormatter
- Create an HTTP Response to represent the error we are handling.
- WhoopsFormatter::format() — Method in class WhoopsFormatter
- Create an HTTP Response to represent the error we are handling.
- Site::fromPaths() — Method in class Site
- $AddTranslations#filter — Property in class AddTranslations
- AddTranslations::forFrontend() — Method in class AddTranslations
- CompilerInterface::flush() — Method in class CompilerInterface
- JsCompiler::format() — Method in class JsCompiler
- $RevisionCompiler#filename — Property in class RevisionCompiler
- RevisionCompiler::format() — Method in class RevisionCompiler
- RevisionCompiler::flush() — Method in class RevisionCompiler
- FileSource — Class in namespace Flarum\Frontend\Compiler\Source
- Assets::forFrontend() — Method in class Assets
- $Controller#frontend — Property in class Controller
- $Document#foot — Property in class Document
- An array of strings to prepend before the page's .
- $Document#forumApiDocument — Property in class Document
- Frontend — Class in namespace Flarum\Frontend
- FrontendServiceProvider — Class in namespace Flarum\Frontend
- RecompileFrontendAssets::flush() — Method in class RecompileFrontendAssets
- RecompileFrontendAssets::flushCss() — Method in class RecompileFrontendAssets
- RecompileFrontendAssets::flushJs() — Method in class RecompileFrontendAssets
- 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.
- $HandleErrors#formatter — Property in class HandleErrors
- 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
- Fire the command.
- $Notification#from_user_id — Property in class Notification
- $Notification#fromUser — Property in class Notification
- Notification::fromUser() — Method in class Notification
- Define the relationship with the notification's sender.
- NotificationRepository::findByUser() — Method in class NotificationRepository
- Find a user's notifications.
- $CommentPost#formatter — Property in class CommentPost
- The text formatter instance.
- CommentPost::formatContent() — Method in class CommentPost
- Get the content rendered as HTML.
- FloodingException — Class in namespace Flarum\Post\Exception
- Floodgate — Class in namespace Flarum\Post
- 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::findByIds() — Method in class PostRepository
- Find posts by their IDs, optionally making sure they are visible to a certain user.
- PostRepository::filterVisibleIds() — Method in class PostRepository
- Filter a list of post IDs to only include posts that are visible to a certain user.
- $GambitManager#fulltextGambit — Property in class GambitManager
- AbstractPolicy::forceAllow() — Method in class AbstractPolicy
- AbstractPolicy::forceDeny() — Method in class AbstractPolicy
- $UploadAvatar#file — Property in class UploadAvatar
- The avatar file to upload.
- $LoginProvider#fillable — Property in class LoginProvider
- FulltextGambit — Class in namespace Flarum\User\Search\Gambit
- 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
- Find a user by email.
- UsernameSlugDriver::fromSlug() — Method in class UsernameSlugDriver
G
- ApiKey::generate() — Method in class ApiKey
- Generate an API key.
- AbstractSerializeController::getEventDispatcher() — Method in class AbstractSerializeController
- AbstractSerializeController::getContainer() — Method in class AbstractSerializeController
- 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
- {@inheritdoc}
- AbstractSerializer::getDefaultAttributes() — Method in class AbstractSerializer
- Get the default set of serialized attributes for a model.
- AbstractSerializer::getRelationship() — Method in class AbstractSerializer
- {@inheritdoc}
- AbstractSerializer::getCustomRelationship() — Method in class AbstractSerializer
- Get a custom relationship.
- AbstractSerializer::getRelationshipData() — Method in class AbstractSerializer
- AbstractSerializer::getEventDispatcher() — Method in class AbstractSerializer
- AbstractSerializer::getContainer() — Method in class AbstractSerializer
- BasicDiscussionSerializer::getDefaultAttributes() — Method in class BasicDiscussionSerializer
- Get the default set of serialized attributes for a model.
- BasicPostSerializer::getDefaultAttributes() — Method in class BasicPostSerializer
- Get the default set of serialized attributes for a model.
- BasicUserSerializer::getDefaultAttributes() — Method in class BasicUserSerializer
- Get the default set of serialized attributes for a model.
- BasicUserSerializer::groups() — Method in class BasicUserSerializer
- CurrentUserSerializer::getDefaultAttributes() — Method in class CurrentUserSerializer
- DiscussionSerializer::getDefaultAttributes() — Method in class DiscussionSerializer
- Get the default set of serialized attributes for a model.
- ForumSerializer::getId() — Method in class ForumSerializer
- {@inheritdoc}
- ForumSerializer::getDefaultAttributes() — Method in class ForumSerializer
- Get the default set of serialized attributes for a model.
- ForumSerializer::groups() — Method in class ForumSerializer
- ForumSerializer::getLogoUrl() — Method in class ForumSerializer
- ForumSerializer::getFaviconUrl() — Method in class ForumSerializer
- GroupSerializer — Class in namespace Flarum\Api\Serializer
- GroupSerializer::getDefaultAttributes() — Method in class GroupSerializer
- Get the default set of serialized attributes for a model.
- MailSettingsSerializer::getDefaultAttributes() — Method in class MailSettingsSerializer
- Get the default set of serialized attributes for a model.
- MailSettingsSerializer::getId() — Method in class MailSettingsSerializer
- NotificationSerializer::getDefaultAttributes() — Method in class NotificationSerializer
- Get the default set of serialized attributes for a model.
- PostSerializer::getDefaultAttributes() — Method in class PostSerializer
- Get the default set of serialized attributes for a model.
- UserSerializer::getDefaultAttributes() — Method in class UserSerializer
- Dispatcher::getCommandHandler() — Method in class Dispatcher
- AbstractModel::getDates() — Method in class AbstractModel
- Get the attributes that should be converted to dates.
- 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.
- GenerateMigrationCommand — Class in namespace Flarum\Database\Console
- DatabaseMigrationRepository::getRan() — Method in class DatabaseMigrationRepository
- Get the ran migrations.
- MigrationCreator::getStub() — Method in class MigrationCreator
- Get the migration stub file.
- MigrationCreator::getMigrationPath() — Method in class MigrationCreator
- Get the full path name to the migration directory.
- MigrationCreator::getPath() — Method in class MigrationCreator
- Get the full path name to the migration.
- MigrationCreator::getDatePrefix() — Method in class MigrationCreator
- Get the date prefix for the migration.
- MigrationCreator::getStubPath() — Method in class MigrationCreator
- Get the path to the stubs.
- MigrationRepositoryInterface::getRan() — Method in class MigrationRepositoryInterface
- Get the ran migrations for the given extension.
- Migrator::getMigrationFiles() — Method in class Migrator
- Get all of the migration files in a given path.
- Migrator::getRepository() — Method in class Migrator
- Get the migration repository instance.
- Migrator::getFilesystem() — Method in class Migrator
- Get the file system instance.
- Discussion::getModifiedPosts() — Method in class Discussion
- Get the posts that have been modified during this request.
- DiscussionRepository::getReadIds() — Method in class DiscussionRepository
- Get the IDs of discussions which a user has read completely.
- DiscussionSearch::getRelevantPostIds() — Method in class DiscussionSearch
- Get the related IDs for each result.
- $DiscussionSearcher#gambits — Property in class DiscussionSearcher
- $AbstractConfigureGambits#gambits — Property in class AbstractConfigureGambits
- GetApiRelationship — Class in namespace Flarum\Event
- Get an API serializer relationship.
- GetModelIsPrivate — Class in namespace Flarum\Event
- Determine whether or not a model should be marked as
is_private
. - GetPermission — Class in namespace Flarum\Event
- Policy::globalPolicy() — Method in class Policy
- Add a custom policy for when an ability check is ran without a model instance.
- Routes::get() — Method in class Routes
- DependentExtensionsException::getDependentExtensionIds() — Method in class DependentExtensionsException
- Get array of IDs for extensions that depend on this extension.
- MissingDependenciesException::getMissingDependencyIds() — Method in class MissingDependenciesException
- Get array of IDs for missing (disabled) extensions that this extension depends on.
- Extension::getVersion() — Method in class Extension
- Extension::getIcon() — Method in class Extension
- Loads the icon information from the composer.json.
- Extension::getId() — Method in class Extension
- The raw path of the directory under extensions.
- Extension::getPath() — Method in class Extension
- Extension::getExtensionDependencyIds() — Method in class Extension
- The IDs of all Flarum extensions that this extension depends on.
- Extension::getLinks() — Method in class Extension
- Compile a list of links for this extension.
- ExtensionManager::getExtensions() — Method in class ExtensionManager
- ExtensionManager::getExtension() — Method in class ExtensionManager
- Loads an Extension with all information.
- ExtensionManager::getAsset() — Method in class ExtensionManager
- Get the path to an extension's published asset.
- ExtensionManager::getMigrator() — Method in class ExtensionManager
- The database migrator.
- ExtensionManager::getEnabledExtensions() — Method in class ExtensionManager
- Get only enabled extensions.
- ExtensionManager::getEnabled() — Method in class ExtensionManager
- The id's of the enabled extensions.
- Formatter::getConfigurator() — Method in class Formatter
- Formatter::getComponent() — Method in class Formatter
- Get a TextFormatter component.
- Formatter::getParser() — Method in class Formatter
- Get the parser.
- Formatter::getRenderer() — Method in class Formatter
- Get the renderer.
- 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.
- User::getApiDocument() — Method in class User
- Get the result of an API request to show a user.
- AbstractValidator::getRules() — Method in class AbstractValidator
- AbstractValidator::getMessages() — Method in class AbstractValidator
- AppInterface::getRequestHandler() — Method in class AppInterface
- AppInterface::getConsoleCommands() — Method in class AppInterface
- Application::getProvider() — Method in class Application
- Get the registered service provider instance if it exists.
- HandledError::getException() — Method in class HandledError
- HandledError::getType() — Method in class HandledError
- HandledError::getStatusCode() — Method in class HandledError
- HandledError::getDetails() — Method in class HandledError
- InstalledApp::getContainer() — Method in class InstalledApp
- InstalledApp::getRequestHandler() — Method in class InstalledApp
- InstalledApp::getUpdaterHandler() — Method in class InstalledApp
- InstalledApp::getConsoleCommands() — Method in class InstalledApp
- InstalledSite::getIlluminateConfig() — Method in class InstalledSite
- KnownError::getType() — Method in class KnownError
- Determine the exception's type.
- UninstalledSite::getIlluminateConfig() — Method in class UninstalledSite
- ValidationException::getAttributes() — Method in class ValidationException
- ValidationException::getRelationships() — Method in class ValidationException
- Assets::getName() — Method in class Assets
- Assets::getAssetsDir() — Method in class Assets
- Assets::getCacheDir() — Method in class Assets
- Assets::getLessImportDirs() — Method in class Assets
- CompilerInterface::getFilename() — Method in class CompilerInterface
- CompilerInterface::getUrl() — Method in class CompilerInterface
- 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::getSources() — Method in class RevisionCompiler
- RevisionCompiler::getUrl() — Method in class RevisionCompiler
- RevisionCompiler::getFilenameForRevision() — Method in class RevisionCompiler
- Get the filename for the given revision.
- RevisionCompiler::getRevision() — Method in class RevisionCompiler
- RevisionCompiler::getCacheDifferentiator() — Method in class RevisionCompiler
- FileSource::getContent() — Method in class FileSource
- FileSource::getCacheDifferentiator() — Method in class FileSource
- FileSource::getPath() — 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
- Document::getForumApiDocument() — Method in class Document
- GroupPolicy — Class in namespace Flarum\Group\Access
- $DeleteGroup#groupId — Property in class DeleteGroup
- The ID of the group to delete.
- $DeleteGroupHandler#groups — Property in class DeleteGroupHandler
- $EditGroup#groupId — Property in class EditGroup
- The ID of the group to edit.
- $EditGroupHandler#groups — Property in class EditGroupHandler
- $Created#group — Property in class Created
- $Deleted#group — Property in class Deleted
- $Deleting#group — Property in class Deleting
- The group that will be deleted.
- $Renamed#group — Property in class Renamed
- $Saving#group — Property in class Saving
- The group that will be saved.
- 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
- Define the relationship with the group that this permission is for.
- AccessToken::generate() — Method in class AccessToken
- Generate an access token for the specified user.
- 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.
- ResolveRoute::getDispatcher() — Method in class ResolveRoute
- RouteCollection::get() — Method in class RouteCollection
- RouteCollection::getRouteData() — Method in class RouteCollection
- RouteCollection::getPath() — Method in class RouteCollection
- AdminUser::getUsername() — Method in class AdminUser
- AdminUser::getAttributes() — Method in class AdminUser
- Installer::getRequestHandler() — Method in class Installer
- Installer::getConsoleCommands() — Method in class Installer
- Step::getMessage() — Method in class Step
- A one-line status message summarizing what's happening in this step.
- ConnectToDatabase::getMessage() — Method in class ConnectToDatabase
- A one-line status message summarizing what's happening in this step.
- CreateAdminUser::getMessage() — Method in class CreateAdminUser
- A one-line status message summarizing what's happening in this step.
- EnableBundledExtensions::getMessage() — Method in class EnableBundledExtensions
- A one-line status message summarizing what's happening in this step.
- PublishAssets::getMessage() — Method in class PublishAssets
- A one-line status message summarizing what's happening in this step.
- RunMigrations::getMessage() — Method in class RunMigrations
- A one-line status message summarizing what's happening in this step.
- StoreConfig::getMessage() — Method in class StoreConfig
- A one-line status message summarizing what's happening in this step.
- WriteSettings::getMessage() — Method in class WriteSettings
- A one-line status message summarizing what's happening in this step.
- LocaleManager::getLocale() — Method in class LocaleManager
- LocaleManager::getLocales() — Method in class LocaleManager
- LocaleManager::getJsFiles() — Method in class LocaleManager
- LocaleManager::getCssFiles() — Method in class LocaleManager
- LocaleManager::getTranslator() — Method in class LocaleManager
- Translator::get() — Method in class Translator
- Translator::getCatalogue() — Method in class Translator
- {@inheritdoc}
- 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::getEmailView() — Method in class MailableInterface
- Get the name of the view to construct a notification email with.
- MailableInterface::getEmailSubject() — Method in class MailableInterface
- Get the subject line for a notification email.
- Notification::getDataAttribute() — Method in class Notification
- When getting the data attribute, unserialize the JSON stored in the database into a plain array.
- 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.
- NotificationSyncer::getNotificationDrivers() — Method in class NotificationSyncer
- AbstractEventPost::getContentAttribute() — Method in class AbstractEventPost
- Unserialize the content attribute from the database's JSON value.
- CommentPost::getContentAttribute() — Method in class CommentPost
- Unparse the parsed content.
- CommentPost::getParsedContentAttribute() — Method in class CommentPost
- Get the parsed/raw content.
- CommentPost::getFormatter() — Method in class CommentPost
- Get the text formatter instance.
- FloodingException::getType() — Method in class FloodingException
- Determine the exception's type.
- Post::getModels() — Method in class Post
- Get the type-to-model map.
- 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.
- AbstractSearch::getQuery() — Method in class AbstractSearch
- Get the query builder for the search results query.
- AbstractSearch::getActor() — Method in class AbstractSearch
- Get the user who is performing the search.
- AbstractSearch::getDefaultSort() — Method in class AbstractSearch
- Get the default sort order for the search.
- AbstractSearch::getActiveGambits() — Method in class AbstractSearch
- Get a list of the gambits that are active in this search.
- GambitInterface — Class in namespace Flarum\Search
- GambitManager — Class in namespace Flarum\Search
- $GambitManager#gambits — Property in class GambitManager
- SearchResults::getResults() — Method in class SearchResults
- DatabaseSettingsRepository::get() — Method in class DatabaseSettingsRepository
- MemoryCacheSettingsRepository::get() — Method in class MemoryCacheSettingsRepository
- OverrideSettingsRepository::get() — Method in class OverrideSettingsRepository
- SettingsRepositoryInterface::get() — Method in class SettingsRepositoryInterface
- UninstalledSettingsRepository::get() — Method in class UninstalledSettingsRepository
- AbstractPolicy::getPermission() — Method in class AbstractPolicy
- Gate — Class in namespace Flarum\User\Access
- Gate::getPolicies() — Method in class Gate
- Get all policies for a given model and ability.
- AccountActivationMailer::generateToken() — Method in class AccountActivationMailer
- AccountActivationMailer::getEmailData() — Method in class AccountActivationMailer
- 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
- Get the data that should be made available to email templates.
- EmailToken::generate() — Method in class EmailToken
- Generate an email token for the specified user.
- 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.
- GroupGambit — Class in namespace Flarum\User\Search\Gambit
- $GroupGambit#groups — Property in class GroupGambit
- $UserSearcher#gambits — Property 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::getAvatarUrlAttribute() — Method in class User
- Get the URL of the user's avatar.
- User::getDisplayNameAttribute() — Method in class User
- Get the user's display name.
- 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
- Get the number of unread notifications for the user.
- User::getUnreadNotifications() — Method in class User
- Get all notifications that have not been read yet.
- 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
- Get the value of a preference for this user.
- User::groups() — Method in class User
- Define the relationship with the user's groups.
- User::getPermissions() — Method in class User
- Get a list of permissions that the user has.
- User::getSession() — Method in class User
- User::getNotificationPreferenceKey() — Method in class User
- Get the key for a preference which flags whether or not the user will receive a notification for $type via $method.
- UserRepository::getIdForUsername() — Method in class UserRepository
- Get the ID of a user with the given username.
- 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
- AbstractCreateController::handle() — Method in class AbstractCreateController
- {@inheritdoc}
- AbstractDeleteController::handle() — Method in class AbstractDeleteController
- {@inheritdoc}
- AbstractSerializeController::handle() — Method in class AbstractSerializeController
- {@inheritdoc}
- CreateTokenController::handle() — Method in class CreateTokenController
- {@inheritdoc}
- ForgotPasswordController::handle() — Method in class ForgotPasswordController
- {@inheritdoc}
- SendConfirmationEmailController::handle() — Method in class SendConfirmationEmailController
- {@inheritdoc}
- SendTestMailController::handle() — Method in class SendTestMailController
- SetPermissionController::handle() — Method in class SetPermissionController
- {@inheritdoc}
- SetSettingsController::handle() — Method in class SetSettingsController
- {@inheritdoc}
- UpdateExtensionController::handle() — Method in class UpdateExtensionController
- {@inheritdoc}
- 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
- Did the user pass the given option?
- 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
- Hide the discussion.
- DiscussionRenamedLogger::handle() — Method in class DiscussionRenamedLogger
- Hidden — Class in namespace Flarum\Discussion\Event
- HiddenGambit — Class in namespace Flarum\Discussion\Search\Gambit
- ApiSerializer::hasOne() — Method in class ApiSerializer
- Establish a simple hasOne relationship from this serializer to another serializer.
- ApiSerializer::hasMany() — Method in class ApiSerializer
- Establish a simple hasMany relationship from this serializer to another serializer.
- ErrorHandling::handler() — Method in class ErrorHandling
- Register a handler with custom error handling logic.
- Model::hasOne() — Method in class Model
- Establish a simple hasOne relationship from this model to another model.
- Model::hasMany() — Method in class Model
- Establish a simple hasMany relationship from this model to another model.
- DefaultLanguagePackGuard::handle() — Method in class DefaultLanguagePackGuard
- 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
- LogInController::handle() — Method in class LogInController
- {@inheritdoc}
- LogOutController::handle() — Method in class LogOutController
- RegisterController::handle() — Method in class RegisterController
- {@inheritdoc}
- SavePasswordController::handle() — Method in class SavePasswordController
- IlluminateValidationExceptionHandler::handle() — Method in class IlluminateValidationExceptionHandler
- ValidationExceptionHandler::handle() — Method in class ValidationExceptionHandler
- HandledError — Class in namespace Flarum\Foundation\ErrorHandling
- An error that was caught / interpreted by Flarum's error handling stack.
- HandledError::hasDetails() — Method in class HandledError
- HttpFormatter — Class in namespace Flarum\Foundation\ErrorHandling
- Registry::handle() — Method in class Registry
- Map exceptions to handled errors.
- MaintenanceModeHandler::handle() — Method in class MaintenanceModeHandler
- Handle the request and return a response.
- Site::hasConfigFile() — Method in class Site
- Controller::handle() — Method in class Controller
- $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
- Group::hasPermission() — Method in class Group
- Check whether the group has a certain permission.
- 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.
- $StartSession#handler — Property in class StartSession
- InstallController::handle() — Method in class InstallController
- LocaleManager::hasLocale() — Method in class LocaleManager
- SendRawEmailJob::handle() — Method in class SendRawEmailJob
- ReadAllNotificationsHandler::handle() — Method in class ReadAllNotificationsHandler
- ReadNotificationHandler::handle() — Method in class ReadNotificationHandler
- SendEmailNotificationJob::handle() — Method in class SendEmailNotificationJob
- SendNotificationsJob::handle() — Method in class SendNotificationsJob
- 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
- Hide the post.
- 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
- Define the relationship with the user who hid the post.
- 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
- RegisterUserHandler::handle() — Method in class RegisterUserHandler
- RequestPasswordResetHandler::handle() — Method in class RequestPasswordResetHandler
- UploadAvatarHandler::handle() — Method in class UploadAvatarHandler
- EmailConfirmationMailer::handle() — Method in class EmailConfirmationMailer
- SelfDemotionGuard::handle() — Method in class SelfDemotionGuard
- Prevent an admin from removing their admin permission via the API.
- $User#hasher — Property in class User
- The hasher with which to hash passwords.
- User::hasPermission() — Method in class User
- Check whether the user has a certain permission based on their groups.
- User::hasPermissionLike() — Method in class User
- Check whether the user has a permission that is like the given string, based on their groups.
I
- $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
- {@inheritdoc}
- $CreatePostController#include — Property in class CreatePostController
- {@inheritdoc}
- $ListDiscussionsController#include — Property in class ListDiscussionsController
- {@inheritdoc}
- $ListNotificationsController#include — Property in class ListNotificationsController
- {@inheritdoc}
- $ListPostsController#include — Property in class ListPostsController
- {@inheritdoc}
- $ListUsersController#include — Property in class ListUsersController
- {@inheritdoc}
- $ShowDiscussionController#include — Property in class ShowDiscussionController
- {@inheritdoc}
- $ShowForumController#include — Property in class ShowForumController
- {@inheritdoc}
- $ShowPostController#include — Property in class ShowPostController
- {@inheritdoc}
- $ShowUserController#include — Property in class ShowUserController
- {@inheritdoc}
- $UpdatePostController#include — Property in class UpdatePostController
- {@inheritdoc}
- $UpdateUserController#include — Property in class UpdateUserController
- {@inheritdoc}
- Serializing::isSerializer() — Method in class Serializing
- WillGetData::isController() — Method in class WillGetData
- WillSerializeData::isController() — Method in class WillSerializeData
- InvalidAccessTokenException — Class in namespace Flarum\Api\Exception
- $AbstractCommand#input — Property in class AbstractCommand
- AbstractCommand::info() — Method in class AbstractCommand
- Send an info message to the user.
- $StartDiscussion#ipAddress — Property in class StartDiscussion
- The current ip address of the actor.
- $Discussion#id — Property in class Discussion
- $Discussion#is_private — Property in class Discussion
- IdWithTransliteratedSlugDriver — Class in namespace Flarum\Discussion
- GetApiRelationship::isRelationship() — Method in class GetApiRelationship
- Middleware::insertBefore() — Method in class Middleware
- Middleware::insertAfter() — Method in class Middleware
- $Extension#id — Property in class Extension
- Unique Id of the extension.
- $Extension#installed — Property in class Extension
- Whether the extension is installed.
- Extension::isInstalled() — Method in class Extension
- ExtensionManager::isEnabled() — Method in class ExtensionManager
- Whether the extension is enabled.
- Index — Class in namespace Flarum\Forum\Content
- Application::inDebugMode() — Method in class Application
- Check if Flarum is in debug mode.
- Application::isBooted() — Method in class Application
- Determine if the application has booted.
- Config::inDebugMode() — Method in class Config
- Config::inMaintenanceMode() — Method in class Config
- InfoCommand — Class in namespace Flarum\Foundation\Console
- IlluminateValidationExceptionHandler — Class in namespace Flarum\Foundation\ErrorHandling\ExceptionHandler
- 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#incrementing — Property in class AccessToken
- Use a custom primary key for this model.
- InstallCommand — Class in namespace Flarum\Install\Console
- $InstallCommand#installation — Property in class InstallCommand
- InstallCommand::init() — Method in class InstallCommand
- InstallCommand::install() — Method in class InstallCommand
- $UserDataProvider#input — Property in class UserDataProvider
- IndexController — Class in namespace Flarum\Install\Controller
- $IndexController#installation — Property in class IndexController
- InstallController — Class in namespace Flarum\Install\Controller
- $InstallController#installation — Property in class InstallController
- InstallServiceProvider — Class in namespace Flarum\Install
- Installation — Class in namespace Flarum\Install
- Installer — Class in namespace Flarum\Install
- $Notification#id — Property in class Notification
- $PostReply#ipAddress — Property in class PostReply
- The IP address of the actor.
- Floodgate::isFlooding() — Method in class Floodgate
- $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 or not this post is visible to the given user.
- $MemoryCacheSettingsRepository#inner — Property in class MemoryCacheSettingsRepository
- $MemoryCacheSettingsRepository#isCached — Property in class MemoryCacheSettingsRepository
- $OverrideSettingsRepository#inner — Property in class OverrideSettingsRepository
- IndexController — Class in namespace Flarum\Update\Controller
- $EmailToken#incrementing — Property in class EmailToken
- Use a custom primary key for this model.
- $AvatarSaving#image — Property in class AvatarSaving
- The image that will be saved.
- 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 or not the user is a guest.
- $LoginProvider#id — Property in class LoginProvider
- $LoginProvider#identifier — Property in class LoginProvider
- $PasswordToken#incrementing — Property in class PasswordToken
- Use a custom primary key for this model.
- $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
- Check whether or not the user is an administrator.
- User::isGuest() — Method in class User
- Check whether or not the user is a guest.
J
- JsonApiResponse — Class in namespace Flarum\Api
- Frontend::js() — Method in class Frontend
- JsonApiFormatter — Class in namespace Flarum\Foundation\ErrorHandling
- A formatter to render exceptions as valid {JSON:API} error object.
- Assets::js() — Method in class Assets
- JsCompiler — Class in namespace Flarum\Frontend\Compiler
- $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.
- $Serializing#key — Property in class Serializing
- The settings key being saved.
L
- $ApiKey#last_activity_at — Property in class ApiKey
- $AbstractSerializeController#limit — Property in class AbstractSerializeController
- The number of records included by default.
- ListDiscussionsController — Class in namespace Flarum\Api\Controller
- ListGroupsController — Class in namespace Flarum\Api\Controller
- ListNotificationsController — Class in namespace Flarum\Api\Controller
- $ListNotificationsController#limit — Property in class ListNotificationsController
- {@inheritdoc}
- 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
- Server::listen() — Method in class Server
- DatabaseMigrationRepository::log() — Method in class DatabaseMigrationRepository
- Log that a migration was run.
- MigrationRepositoryInterface::log() — Method in class MigrationRepositoryInterface
- Log that a migration was run.
- $ReadDiscussion#lastReadPostNumber — Property in class ReadDiscussion
- The number of the post to mark as read.
- $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
- Define the relationship with the discussion's last post.
- Discussion::lastPostedUser() — Method in class Discussion
- Define the relationship with the discussion's most recent author.
- $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.
- LanguagePack — Class in namespace Flarum\Extend
- LifecycleInterface — Class in namespace Flarum\Extend
- Locales — 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
- $ValidateCustomLess#locales — Property in class ValidateCustomLess
- $Application#loadedProviders — Property in class Application
- The names of the loaded service providers.
- LogReporter — Class in namespace Flarum\Foundation\ErrorHandling
- Log caught exceptions to a PSR-3 logger instance.
- $LogReporter#logger — Property in class LogReporter
- Site::loadConfig() — Method in class Site
- Site::loadExtenders() — Method in class Site
- $AddLocaleAssets#locales — Property in class AddLocaleAssets
- $AddTranslations#locales — Property in class AddTranslations
- $Assets#lessImportDirs — Property in class Assets
- Assets::localeJs() — Method in class Assets
- Assets::localeCss() — Method in class Assets
- LessCompiler — Class in namespace Flarum\Frontend\Compiler
- $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.
- $RecompileFrontendAssets#locales — Property in class RecompileFrontendAssets
- $AccessToken#last_activity_at — Property in class AccessToken
- $AccessToken#lifetime_seconds — Property in class AccessToken
- $SetLocale#locales — Property in class SetLocale
- Server::listen() — Method in class Server
- 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
- {@inheritdoc}
- LogDriver — Class in namespace Flarum\Mail
- ListenCommand — Class in namespace Flarum\Queue\Console
- Listener — Class in namespace Flarum\Queue
- 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() — Method in class User
- Get the user's login providers.
M
- $AbstractSerializeController#maxLimit — Property in class AbstractSerializeController
- The maximum number of records that can be requested.
- $SendTestMailController#mailer — Property in class SendTestMailController
- UploadFaviconController::makeImage() — Method in class UploadFaviconController
- UploadImageController::makeImage() — Method in class UploadImageController
- UploadLogoController::makeImage() — Method in class UploadLogoController
- $Serializing#model — Property in class Serializing
- The model being serialized.
- $AbstractSerializer#mutators — Property in class AbstractSerializer
- BasicDiscussionSerializer::mostRelevantPost() — Method in class BasicDiscussionSerializer
- MailSettingsSerializer — Class in namespace Flarum\Api\Serializer
- MigrateCommand — Class in namespace Flarum\Database\Console
- $ResetCommand#manager — Property in class ResetCommand
- Migration — Class in namespace Flarum\Database
- Migration factory.
- MigrationCreator — Class in namespace Flarum\Database
- 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
- Define the relationship with the discussion's most relevant post.
- $GetApiRelationship#model — Property in class GetApiRelationship
- $GetModelIsPrivate#model — Property in class GetModelIsPrivate
- $GetPermission#model — Property in class GetPermission
- ApiSerializer::mutate() — Method in class ApiSerializer
- Add to or modify the attributes array of this serializer.
- Mail — Class in namespace Flarum\Extend
- Middleware — Class in namespace Flarum\Extend
- Model — Class in namespace Flarum\Extend
- ModelUrl — Class in namespace Flarum\Extend
- ModelVisibility — Class in namespace Flarum\Extend
- Model visibility scoping allows us to scope queries based on the current user.
- 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.
- $MissingDependenciesException#missing_dependencies — Property in class MissingDependenciesException
- MissingDependenciesExceptionHandler — Class in namespace Flarum\Extension\Exception
- Extension::migrate() — Method in class Extension
- $ExtensionManager#migrator — Property in class ExtensionManager
- 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
- Make a new validator instance for this model.
- Application::markAsRegistered() — Method in class Application
- Mark the given provider as registered.
- 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::makeJsCompiler() — Method in class Assets
- Assets::makeLessCompiler() — Method in class Assets
- Meta — Class in namespace Flarum\Frontend\Content
- $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::makeHead() — Method in class Document
- Document::makeJs() — Method in class Document
- Document::makeFoot() — Method in class Document
- Permission::map() — Method in class Permission
- Get a map of permissions to the group IDs that have them.
- CookieFactory::make() — Method in class CookieFactory
- Make a new cookie instance.
- MethodNotAllowedException — Class in namespace Flarum\Http\Exception
- $PhpVersion#minVersion — Property in class PhpVersion
- MailServiceProvider — Class in namespace Flarum\Mail
- MailgunDriver — Class in namespace Flarum\Mail
- EmailNotificationDriver::mailNotifications() — Method in class EmailNotificationDriver
- Mail a notification to a list of users.
- MailableInterface — Class in namespace Flarum\Notification
- $NotificationMailer#mailer — Property in class NotificationMailer
- NotificationRepository::markAllAsRead() — Method in class NotificationRepository
- Mark all of a user's notifications as read.
- 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. - AbstractRegexGambit::match() — Method in class AbstractRegexGambit
- Match the bit against this gambit.
- MemoryCacheSettingsRepository — Class in namespace Flarum\Settings
- $AbstractPolicy#model — Property in class AbstractPolicy
- $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
- $ListNotificationsController#notifications — Property in class ListNotificationsController
- NotificationSerializer — Class in namespace Flarum\Api\Serializer
- Migrator::note() — Method in class Migrator
- Write a note to the conosle's output.
- $DiscussionRenamedLogger#notifications — Property in class DiscussionRenamedLogger
- 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
- $Assets#name — Property in class Assets
- $Group#name_singular — Property in class Group
- $Group#name_plural — Property in class Group
- NullDriver — Class in namespace Flarum\Mail
- $ReadAllNotificationsHandler#notifications — Property in class ReadAllNotificationsHandler
- $ReadNotification#notificationId — Property in class ReadNotification
- The ID of the notification to mark as read.
- 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.
- NotificationMailer — Class in namespace Flarum\Notification
- 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.
- $PostReplyHandler#notifications — Property in class PostReplyHandler
- $Post#number — Property in class Post
- Post::newFromBuilder() — Method in class Post
- Create a new model instance according to the post's type.
- NotAuthenticatedException — Class in namespace Flarum\User\Exception
- User::notifications() — Method in class User
- Define the relationship with the user's notifications.
O
- $AbstractSerializeController#optionalInclude — Property in class AbstractSerializeController
- The relationships that are available to be included.
- $ListDiscussionsController#optionalInclude — Property in class ListDiscussionsController
- {@inheritdoc}
- $ShowDiscussionController#optionalInclude — Property in class ShowDiscussionController
- {@inheritdoc}
- $AbstractCommand#output — Property in class AbstractCommand
- $Migrator#output — Property in class Migrator
- The output interface implementation.
- $Renamed#oldTitle — Property in class Renamed
- Formatter::onEnable() — Method in class Formatter
- Formatter::onDisable() — Method in class Formatter
- LanguagePack::onEnable() — Method in class LanguagePack
- LanguagePack::onDisable() — Method in class LanguagePack
- LifecycleInterface::onEnable() — Method in class LifecycleInterface
- LifecycleInterface::onDisable() — Method in class LifecycleInterface
- Locales::onEnable() — Method in class Locales
- Locales::onDisable() — Method in class Locales
- Config::offsetGet() — Method in class Config
- Config::offsetExists() — Method in class Config
- Config::offsetSet() — Method in class Config
- Config::offsetUnset() — Method in class Config
- $UserDataProvider#output — Property in class UserDataProvider
- Pipeline::on() — Method in class Pipeline
- $NotificationSyncer#onePerUser — Property in class NotificationSyncer
- Whether or not 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.
- OverrideSettingsRepository — Class in namespace Flarum\Settings
- A settings repository decorator that allows overriding certain values.
- $OverrideSettingsRepository#overrides — Property in class OverrideSettingsRepository
- $GroupsChanged#oldGroups — Property in class GroupsChanged
- $Renamed#oldUsername — Property in class Renamed
P
- AdminServiceProvider::populateRoutes() — Method in class AdminServiceProvider
- RequireAdministrateAbility::process() — Method in class RequireAdministrateAbility
- ApiServiceProvider::populateRoutes() — Method in class ApiServiceProvider
- Populate the API routes.
- $ListPostsController#posts — Property in class ListPostsController
- $ShowDiscussionController#posts — Property in class ShowDiscussionController
- $ShowPostController#posts — Property in class ShowPostController
- 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
- $MigrateCommand#paths — Property in class MigrateCommand
- $MigrationCreator#paths — Property in class MigrationCreator
- MigrationCreator::populateStub() — Method in class MigrationCreator
- Populate the place-holders in the migration stub.
- $Discussion#participant_count — Property in class Discussion
- $Discussion#post_number_index — Property in class Discussion
- $Discussion#posts — Property in class Discussion
- $Discussion#participants — Property in class Discussion
- Discussion::posts() — Method in class Discussion
- Define the relationship with the discussion's posts.
- Discussion::participants() — Method in class Discussion
- Query the discussion's participants (a list of unique users who have posted in the discussion).
- $AuthorGambit#pattern — Property in class AuthorGambit
- {@inheritdoc}
- $CreatedGambit#pattern — Property in class CreatedGambit
- {@inheritdoc}
- $HiddenGambit#pattern — Property in class HiddenGambit
- {@inheritdoc}
- $UnreadGambit#pattern — Property in class UnreadGambit
- {@inheritdoc}
- ApiController::prepareDataQuery() — Method in class ApiController
- ApiController::prepareDataForSerialization() — Method in class ApiController
- 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
- Routes::post() — Method in class Routes
- Routes::put() — Method in class Routes
- Routes::patch() — Method in class Routes
- User::permissionGroups() — Method in class User
- Dynamically process a user's list of groups when calculating permissions.
- $Extension#path — Property in class Extension
- The directory of this extension.
- $Extension#provide — Property in class Extension
- $ExtensionManager#paths — Property in class ExtensionManager
- ExtensionManager::publishAssets() — Method in class ExtensionManager
- Copy the assets from an extension's assets directory into public view.
- Parsing — Class in namespace Flarum\Formatter\Event
- $Parsing#parser — Property in class Parsing
- $Formatter#parsingCallbacks — Property in class Formatter
- Formatter::parse() — Method in class Formatter
- Parse text.
- $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
- Populate the forum client routes.
- $Application#paths — Property in class Application
- The paths for the Flarum installation.
- $CacheClearCommand#paths — Property in class CacheClearCommand
- $EventGeneratorTrait#pendingEvents — Property in class EventGeneratorTrait
- $InstalledSite#paths — Property in class InstalledSite
- Paths — Class in namespace Flarum\Foundation
- $UninstalledSite#paths — Property in class UninstalledSite
- RevisionCompiler::putRevision() — Method in class RevisionCompiler
- $FileSource#path — Property in class FileSource
- $Document#payload — Property in class Document
- Other variables to preload into the Flarum JS.
- Frontend::populate() — Method in class Frontend
- $Group#permissions — Property in class Group
- Group::permissions() — Method in class Group
- Define the relationship with the group's permissions.
- Permission — Class in namespace Flarum\Group
- $Permission#permission — Property in class Permission
- $AccessToken#primaryKey — Property in class AccessToken
- $CookieFactory#prefix — Property in class CookieFactory
- The prefix for the cookie names.
- $CookieFactory#path — Property in class CookieFactory
- A path scope for the cookies.
- AuthenticateWithHeader::process() — Method in class AuthenticateWithHeader
- AuthenticateWithSession::process() — Method in class AuthenticateWithSession
- CheckCsrfToken::process() — Method in class CheckCsrfToken
- CollectGarbage::process() — Method in class CollectGarbage
- ExecuteRoute::process() — Method in class ExecuteRoute
- Executes the route handler resolved in ResolveRoute.
- HandleErrors::process() — Method in class HandleErrors
- Catch all errors that happen during further middleware execution.
- ParseJsonBody — Class in namespace Flarum\Http\Middleware
- ParseJsonBody::process() — Method in class ParseJsonBody
- 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::post() — Method in class RouteCollection
- RouteCollection::put() — Method in class RouteCollection
- RouteCollection::patch() — Method in class RouteCollection
- RouteCollectionUrlGenerator::path() — Method in class RouteCollectionUrlGenerator
- Generate a URL to a path.
- InstallServiceProvider::populateRoutes() — Method in class InstallServiceProvider
- Installation::prerequisites() — Method in class Installation
- 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.
- PublishAssets — Class in namespace Flarum\Install\Steps
- PrefixedYamlFileLoader — Class in namespace Flarum\Locale
- $DiscussionRenamedBlueprint#post — Property in class DiscussionRenamedBlueprint
- PostPolicy — Class in namespace Flarum\Post\Access
- $DeletePost#postId — Property in class DeletePost
- The ID of the post to delete.
- $DeletePostHandler#posts — Property in class DeletePostHandler
- $EditPost#postId — Property in class EditPost
- The ID of the post to edit.
- $EditPostHandler#posts — Property in class EditPostHandler
- PostReply — Class in namespace Flarum\Post\Command
- PostReplyHandler — Class in namespace Flarum\Post\Command
- $CommentPost#parsed_content — Property in class CommentPost
- $Deleted#post — Property in class Deleted
- $Deleting#post — Property in class Deleting
- The post that is going to be deleted.
- $Hidden#post — Property in class Hidden
- Posted — Class in namespace Flarum\Post\Event
- $Posted#post — Property in class Posted
- $Restored#post — Property in class Restored
- $Revised#post — Property in class Revised
- $Saving#post — Property in class Saving
- The post that will be saved.
- Post — Class in namespace Flarum\Post
- PostRepository — Class in namespace Flarum\Post
- PostServiceProvider — Class in namespace Flarum\Post
- PostValidator — Class in namespace Flarum\Post
- $AbstractRegexGambit#pattern — Property in class AbstractRegexGambit
- The regex pattern to match the bit against.
- UpdateServiceProvider::populateRoutes() — Method in class UpdateServiceProvider
- $Gate#policyClasses — Property in class Gate
- $Gate#policies — Property in class Gate
- $EmailToken#primaryKey — Property in class EmailToken
- {@inheritdoc}
- $CheckingPassword#password — Property in class CheckingPassword
- PasswordChanged — Class in namespace Flarum\User\Event
- $RegisteringFromProvider#provider — Property in class RegisteringFromProvider
- $RegisteringFromProvider#payload — Property in class RegisteringFromProvider
- 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
- {@inheritdoc}
- $RegistrationToken#primaryKey — Property in class RegistrationToken
- {@inheritdoc}
- $RegistrationToken#provider — Property in class RegistrationToken
- $RegistrationToken#payload — Property in class RegistrationToken
- $EmailGambit#pattern — Property in class EmailGambit
- {@inheritdoc}
- $GroupGambit#pattern — Property in class GroupGambit
- {@inheritdoc}
- $User#permissions — Property in class User
- An array of permissions that this user has.
- $User#preferences — Property in class User
- $User#password — Property in class User
- User::posts() — Method in class User
- Define the relationship with the user's posts.
- User::permissions() — Method in class User
- Define the relationship with the permissions of all of the groups that the user is in.
Q
- $SendConfirmationEmailController#queue — Property in class SendConfirmationEmailController
- DiscussionRepository::query() — Method in class DiscussionRepository
- Get a new query builder for the discussions table.
- $ConfigurePostsQuery#query — Property in class ConfigurePostsQuery
- $ScopeModelVisibility#query — Property in class ScopeModelVisibility
- GroupRepository::query() — Method in class GroupRepository
- Get a new query builder for the groups table.
- $UserDataProvider#questionHelper — Property in class UserDataProvider
- PostRepository::query() — Method in class PostRepository
- Get a new query builder for the posts table.
- PostRepository::queryVisibleTo() — Method in class PostRepository
- PostRepository::queryIds() — Method in class PostRepository
- QueueFactory — Class in namespace Flarum\Queue
- QueueServiceProvider — Class in namespace Flarum\Queue
- $AbstractSearch#query — Property in class AbstractSearch
- $SearchCriteria#query — Property in class SearchCriteria
- The search query.
- $AccountActivationMailer#queue — Property in class AccountActivationMailer
- $RequestPasswordResetHandler#queue — Property in class RequestPasswordResetHandler
- $EmailConfirmationMailer#queue — Property in class EmailConfirmationMailer
- UserRepository::query() — Method in class UserRepository
- Get a new query builder for the users table.
R
- AdminServiceProvider::register() — Method in class AdminServiceProvider
- {@inheritdoc}
- RequireAdministrateAbility — Class in namespace Flarum\Admin\Middleware
- ApiServiceProvider::register() — Method in class ApiServiceProvider
- {@inheritdoc}
- $Client#registry — Property in class Client
- 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
- WillGetData::removeInclude() — Method in class WillGetData
- Don't include the given relationship by default.
- WillGetData::removeOptionalInclude() — Method in class WillGetData
- Don't allow the given relationship to be included.
- WillGetData::removeSortField() — Method in class WillGetData
- Disallow sorting results by the given field.
- $WillSerializeData#request — Property in class WillSerializeData
- $AbstractSerializer#request — Property in class AbstractSerializer
- AbstractSerializer::resolveSerializer() — Method in class AbstractSerializer
- AbstractSerializer::resolveSerializerClass() — Method in class AbstractSerializer
- BusServiceProvider::register() — Method in class BusServiceProvider
- {@inheritdoc}
- ConsoleServiceProvider::register() — Method in class ConsoleServiceProvider
- {@inheritdoc}
- 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
- {@inheritdoc}
- Migration::renameTable() — Method in class Migration
- Rename a table.
- Migration::renameColumn() — Method in class Migration
- Rename a column.
- Migration::renameColumns() — Method in class Migration
- Rename multiple columns.
- MigrationRepositoryInterface::repositoryExists() — Method in class MigrationRepositoryInterface
- Determine if the migration repository exists.
- $Migrator#repository — Property in class Migrator
- The migration repository implementation.
- Migrator::run() — Method in class Migrator
- Run the outstanding migrations at a given path.
- Migrator::runMigrationList() — Method in class Migrator
- Run an array of migrations.
- Migrator::runUp() — Method in class Migrator
- Run "up" a migration instance.
- Migrator::reset() — Method in class Migrator
- Rolls all of 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::resolve() — Method in class Migrator
- Resolve a migration instance from a file.
- Migrator::repositoryExists() — Method in class Migrator
- Determine if the migration repository exists.
- 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
- Rename the discussion. Raises the DiscussionWasRenamed event.
- Discussion::restore() — Method in class Discussion
- Restore the discussion.
- Discussion::refreshLastPost() — Method in class Discussion
- Refresh a discussion's last post details.
- Discussion::refreshCommentCount() — Method in class Discussion
- Refresh the discussion's comment count.
- Discussion::refreshParticipantCount() — Method in class Discussion
- Refresh the discussion's participant count.
- Discussion::readers() — Method in class Discussion
- Define the relationship with the discussion's readers.
- DiscussionMetadataUpdater::removePost() — Method in class DiscussionMetadataUpdater
- $DiscussionValidator#rules — Property in class DiscussionValidator
- Renamed — Class in namespace Flarum\Discussion\Event
- Restored — Class in namespace Flarum\Discussion\Event
- $DiscussionSearch#relevantPostIds — Property in class DiscussionSearch
- UserState::read() — Method in class UserState
- Mark the discussion as being read up to a certain point. Raises the DiscussionWasRead event.
- $GetApiRelationship#relationship — Property in class GetApiRelationship
- ApiController::removeInclude() — Method in class ApiController
- Don't include the given relationship by default.
- ApiController::removeOptionalInclude() — Method in class ApiController
- Don't allow the given relationship to be included.
- ApiController::removeSortField() — Method in class ApiController
- Disallow sorting results by the given field.
- ApiSerializer::relationship() — Method in class ApiSerializer
- Add a relationship from this serializer to another serializer.
- 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.
- Frontend::route() — Method in class Frontend
- Middleware::replace() — Method in class Middleware
- Middleware::remove() — Method in class Middleware
- Model::relationship() — Method in class Model
- Add a relationship from this model to another model.
- Routes — Class in namespace Flarum\Extend
- ServiceProvider::register() — Method in class ServiceProvider
- Register a service provider.
- 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
- ExtensionServiceProvider::register() — Method in class ExtensionServiceProvider
- {@inheritdoc}
- Rendering — Class in namespace Flarum\Formatter\Event
- $Rendering#renderer — Property in class Rendering
- $Rendering#request — Property in class Rendering
- $Formatter#renderingCallbacks — Property in class Formatter
- Formatter::render() — Method in class Formatter
- Render parsed XML.
- FormatterServiceProvider::register() — Method in class FormatterServiceProvider
- {@inheritdoc}
- Registration — Class in namespace Flarum\Forum\Auth
- ResponseFactory — Class in namespace Flarum\Forum\Auth
- $ResponseFactory#rememberer — Property in class ResponseFactory
- $LogInController#rememberer — Property in class LogInController
- $LogOutController#rememberer — Property in class LogOutController
- RegisterController — Class in namespace Flarum\Forum\Controller
- $RegisterController#rememberer — Property in class RegisterController
- ResetPasswordController — Class in namespace Flarum\Forum\Controller
- ResetPasswordController::render() — Method in class ResetPasswordController
- ForumServiceProvider::register() — Method in class ForumServiceProvider
- {@inheritdoc}
- AbstractServiceProvider::register() — Method in class AbstractServiceProvider
- {@inheritdoc}
- $AbstractValidator#rules — Property in class AbstractValidator
- Application::registerBaseBindings() — Method in class Application
- Register the basic bindings into the container.
- Application::registerBaseServiceProviders() — Method in class Application
- Register all of the base service providers.
- Application::register() — Method in class Application
- Register a service provider with the application.
- Application::resolveProviderClass() — Method in class Application
- Resolve a service provider instance from the class name.
- Application::registerCoreContainerAliases() — Method in class Application
- Register the core class aliases in the container.
- LogReporter::report() — Method in class LogReporter
- Report an error that Flarum was not able to handle to a backend.
- Registry — Class in namespace Flarum\Foundation\ErrorHandling
- Flarum's central registry of known error types.
- 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
- {@inheritdoc}
- EventGeneratorTrait::raise() — Method in class EventGeneratorTrait
- Raise a new event.
- EventGeneratorTrait::releaseEvents() — Method in class EventGeneratorTrait
- Return and reset all pending events.
- InstalledSite::registerLogger() — Method in class InstalledSite
- InstalledSite::registerCache() — Method in class InstalledSite
- UninstalledSite::registerLogger() — Method in class UninstalledSite
- $ValidationException#relationships — Property in class ValidationException
- RevisionCompiler — Class in namespace Flarum\Frontend\Compiler
- $Document#request — Property in class Document
- Document::render() — Method in class Document
- FrontendServiceProvider::register() — Method in class FrontendServiceProvider
- {@inheritdoc}
- RecompileFrontendAssets — Class in namespace Flarum\Frontend
- Renamed — Class in namespace Flarum\Group\Event
- Group::rename() — Method in class Group
- Rename the group.
- $GroupValidator#rules — Property in class GroupValidator
- AbstractHtmlController::render() — Method in class AbstractHtmlController
- RouteNotFoundException — Class in namespace Flarum\Http\Exception
- HttpServiceProvider::register() — Method in class HttpServiceProvider
- {@inheritdoc}
- $HandleErrors#registry — Property in class HandleErrors
- $HandleErrors#reporters — Property in class HandleErrors
- RememberFromCookie — Class in namespace Flarum\Http\Middleware
- ResolveRoute — Class in namespace Flarum\Http\Middleware
- $ResolveRoute#routes — Property in class ResolveRoute
- Rememberer — Class in namespace Flarum\Http
- Rememberer::remember() — Method in class Rememberer
- Rememberer::rememberUser() — Method in class Rememberer
- RouteCollection — Class in namespace Flarum\Http
- $RouteCollection#reverse — Property in class RouteCollection
- $RouteCollection#routeParser — Property in class RouteCollection
- RouteCollectionUrlGenerator — Class in namespace Flarum\Http
- $RouteCollectionUrlGenerator#routes — Property in class RouteCollectionUrlGenerator
- RouteCollectionUrlGenerator::route() — Method in class RouteCollectionUrlGenerator
- Generate a URL to a named route.
- RouteHandlerFactory — Class in namespace Flarum\Http
- $UrlGenerator#routes — Property in class UrlGenerator
- IndexController::render() — Method in class IndexController
- InstallServiceProvider::register() — Method in class InstallServiceProvider
- {@inheritdoc}
- 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.
- ConnectToDatabase::run() — Method in class ConnectToDatabase
- Do the work that constitutes this step.
- CreateAdminUser::run() — Method in class CreateAdminUser
- Do the work that constitutes this step.
- EnableBundledExtensions::run() — Method in class EnableBundledExtensions
- Do the work that constitutes this step.
- PublishAssets::run() — Method in class PublishAssets
- Do the work that constitutes this step.
- PublishAssets::revert() — Method in class PublishAssets
- RunMigrations — Class in namespace Flarum\Install\Steps
- RunMigrations::run() — Method in class RunMigrations
- Do the work that constitutes this step.
- StoreConfig::run() — Method in class StoreConfig
- Do the work that constitutes this step.
- StoreConfig::revert() — Method in class StoreConfig
- WriteSettings::run() — Method in class WriteSettings
- Do the work that constitutes this step.
- LocaleServiceProvider::register() — Method in class LocaleServiceProvider
- {@inheritdoc}
- MailServiceProvider::register() — Method in class MailServiceProvider
- {@inheritdoc}
- 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
- AlertNotificationDriver::registerType() — Method in class AlertNotificationDriver
- Logic for registering a notification type, generally used for adding a user preference.
- EmailNotificationDriver::registerType() — Method in class EmailNotificationDriver
- Logic for registering a notification type, generally used for adding a user preference.
- NotificationDriverInterface::registerType() — Method in class NotificationDriverInterface
- Logic for registering a notification type, generally used for adding a user preference.
- $Notification#read_at — Property in class Notification
- Notification::read() — Method in class Notification
- Mark a notification as read.
- NotificationServiceProvider::register() — Method in class NotificationServiceProvider
- {@inheritdoc}
- NotificationSyncer::restore() — Method in class NotificationSyncer
- Restore a notification for all users.
- CommentPost::reply() — Method in class CommentPost
- Create a new instance in reply to a discussion.
- CommentPost::revise() — Method in class CommentPost
- Revise the post's content.
- CommentPost::restore() — Method in class CommentPost
- Restore the post.
- DiscussionRenamedPost::reply() — Method in class DiscussionRenamedPost
- Create a new instance in reply to a discussion.
- Restored — Class in namespace Flarum\Post\Event
- Revised — Class in namespace Flarum\Post\Event
- PostServiceProvider::register() — Method in class PostServiceProvider
- {@inheritdoc}
- $PostValidator#rules — Property in class PostValidator
- RegisteredTypesScope — Class in namespace Flarum\Post
- ExceptionHandler::report() — Method in class ExceptionHandler
- Report or log an exception.
- ExceptionHandler::render() — Method in class ExceptionHandler
- Render an exception into an HTTP response.
- ExceptionHandler::renderForConsole() — Method in class ExceptionHandler
- Render an exception to the console.
- QueueServiceProvider::register() — Method in class QueueServiceProvider
- {@inheritdoc}
- $SearchResults#results — Property in class SearchResults
- SearchServiceProvider::register() — Method in class SearchServiceProvider
- Register the service provider.
- SearchServiceProvider::registerUserGambits() — Method in class SearchServiceProvider
- SearchServiceProvider::registerDiscussionGambits() — Method in class SearchServiceProvider
- SettingsServiceProvider::register() — Method in class SettingsServiceProvider
- {@inheritdoc}
- IndexController::render() — Method in class IndexController
- UpdateServiceProvider::register() — Method in class UpdateServiceProvider
- {@inheritdoc}
- 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
- RegisterUserHandler — Class in namespace Flarum\User\Command
- RequestPasswordReset — Class in namespace Flarum\User\Command
- RequestPasswordResetHandler — 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
- RegistrationToken — Class in namespace Flarum\User
- SessionServiceProvider::register() — Method in class SessionServiceProvider
- {@inheritdoc}
- $User#read_notifications_at — Property in class User
- User::register() — Method in class User
- Register a new user.
- User::rename() — Method in class User
- Rename the user.
- User::requestEmailChange() — Method in class User
- Request that the user's email be changed.
- User::read() — Method in class User
- Define the relationship with the user's read discussions.
- User::registerPreference() — Method in class User
- Register a preference with a transformer and a default value.
- User::refreshCommentCount() — Method in class User
- Refresh the user's comments count.
- User::refreshDiscussionCount() — Method in class User
- Refresh the user's comments count.
- UserServiceProvider::register() — Method in class UserServiceProvider
- {@inheritdoc}
- UserServiceProvider::registerDisplayNameDrivers() — Method in class UserServiceProvider
- UserServiceProvider::registerAvatarsFilesystem() — Method in class UserServiceProvider
S
- $AdminPayload#settings — Property in class AdminPayload
- $ApiKey#scopes — Property in class ApiKey
- ApiServiceProvider::setNotificationSerializers() — Method in class ApiServiceProvider
- Register notification serializers.
- 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 user.
- 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::setEventDispatcher() — Method in class AbstractSerializeController
- AbstractSerializeController::setContainer() — Method in class AbstractSerializeController
- $CreateDiscussionController#serializer — Property in class CreateDiscussionController
- {@inheritdoc}
- $CreateGroupController#serializer — Property in class CreateGroupController
- {@inheritdoc}
- $CreatePostController#serializer — Property in class CreatePostController
- {@inheritdoc}
- $CreateUserController#serializer — Property in class CreateUserController
- {@inheritdoc}
- $DeleteAvatarController#serializer — Property in class DeleteAvatarController
- {@inheritdoc}
- $DeleteFaviconController#settings — Property in class DeleteFaviconController
- $DeleteLogoController#settings — Property in class DeleteLogoController
- $ListDiscussionsController#serializer — Property in class ListDiscussionsController
- {@inheritdoc}
- $ListDiscussionsController#sortFields — Property in class ListDiscussionsController
- {@inheritdoc}
- $ListDiscussionsController#searcher — Property in class ListDiscussionsController
- $ListGroupsController#serializer — Property in class ListGroupsController
- {@inheritdoc}
- $ListNotificationsController#serializer — Property in class ListNotificationsController
- {@inheritdoc}
- $ListPostsController#serializer — Property in class ListPostsController
- {@inheritdoc}
- $ListPostsController#sortFields — Property in class ListPostsController
- {@inheritdoc}
- $ListUsersController#serializer — Property in class ListUsersController
- {@inheritdoc}
- $ListUsersController#sortFields — Property in class ListUsersController
- {@inheritdoc}
- $ListUsersController#searcher — Property in class ListUsersController
- SendConfirmationEmailController — Class in namespace Flarum\Api\Controller
- $SendConfirmationEmailController#settings — Property in class SendConfirmationEmailController
- SendTestMailController — Class in namespace Flarum\Api\Controller
- SetPermissionController — Class in namespace Flarum\Api\Controller
- SetSettingsController — Class in namespace Flarum\Api\Controller
- $SetSettingsController#settings — Property in class SetSettingsController
- ShowDiscussionController — Class in namespace Flarum\Api\Controller
- $ShowDiscussionController#slugManager — Property in class ShowDiscussionController
- $ShowDiscussionController#serializer — Property in class ShowDiscussionController
- {@inheritdoc}
- ShowForumController — Class in namespace Flarum\Api\Controller
- $ShowForumController#serializer — Property in class ShowForumController
- {@inheritdoc}
- ShowMailSettingsController — Class in namespace Flarum\Api\Controller
- $ShowMailSettingsController#serializer — Property in class ShowMailSettingsController
- {@inheritdoc}
- ShowPostController — Class in namespace Flarum\Api\Controller
- $ShowPostController#serializer — Property in class ShowPostController
- {@inheritdoc}
- ShowUserController — Class in namespace Flarum\Api\Controller
- $ShowUserController#serializer — Property in class ShowUserController
- {@inheritdoc}
- $ShowUserController#slugManager — Property in class ShowUserController
- $UpdateDiscussionController#serializer — Property in class UpdateDiscussionController
- {@inheritdoc}
- $UpdateGroupController#serializer — Property in class UpdateGroupController
- {@inheritdoc}
- $UpdateNotificationController#serializer — Property in class UpdateNotificationController
- {@inheritdoc}
- $UpdatePostController#serializer — Property in class UpdatePostController
- {@inheritdoc}
- $UpdateUserController#serializer — Property in class UpdateUserController
- {@inheritdoc}
- $UploadAvatarController#serializer — Property in class UploadAvatarController
- {@inheritdoc}
- $UploadImageController#settings — Property in class UploadImageController
- Serializing — Class in namespace Flarum\Api\Event
- Prepare API attributes.
- $Serializing#serializer — Property in class Serializing
- The class doing the serializing.
- WillGetData::setSerializer() — Method in class WillGetData
- Set the serializer that will serialize data for the endpoint.
- WillGetData::setLimit() — Method in class WillGetData
- Set the default number of results.
- WillGetData::setMaxLimit() — Method in class WillGetData
- Set the maximum number of results.
- WillGetData::setSort() — Method in class WillGetData
- Set the default sort order for the results.
- AbstractSerializer::setRequest() — Method in class AbstractSerializer
- AbstractSerializer::setEventDispatcher() — Method in class AbstractSerializer
- AbstractSerializer::setContainer() — Method in class AbstractSerializer
- AbstractSerializer::setRelationship() — Method in class AbstractSerializer
- $BasicDiscussionSerializer#slugManager — Property in class BasicDiscussionSerializer
- $BasicUserSerializer#slugManager — Property in class BasicUserSerializer
- $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
- Server — Class in namespace Flarum\Console
- $Migrator#schemaBuilder — Property in class Migrator
- The database schema builder instance.
- Migrator::setOutput() — Method in class Migrator
- Set the output implementation that should be used by the console.
- 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.
- $DiscussionPolicy#settings — Property in class DiscussionPolicy
- 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
- Start a new discussion. Raises the DiscussionWasStarted event.
- Discussion::setFirstPost() — Method in class Discussion
- Set the discussion's first post details.
- Discussion::setLastPost() — Method in class Discussion
- Set the discussion's last post details.
- Discussion::state() — Method in class Discussion
- Define the relationship with the discussion's state for a particular user.
- 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.
- DiscussionMetadataUpdater::subscribe() — Method in class DiscussionMetadataUpdater
- 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
- Searching — Class in namespace Flarum\Discussion\Event
- $Searching#search — Property in class Searching
- Started — Class in namespace Flarum\Discussion\Event
- $UserDataSaving#state — Property in class UserDataSaving
- $UserRead#state — Property in class UserRead
- DiscussionSearch::setRelevantPostIds() — Method in class DiscussionSearch
- Set the relevant post IDs for the results.
- DiscussionSearcher::search() — Method in class DiscussionSearcher
- UserState::setKeysForSaveQuery() — Method in class UserState
- Set the keys for a save update query.
- $GetApiRelationship#serializer — Property in class GetApiRelationship
- ScopeModelVisibility — Class in namespace Flarum\Event
- The
ScopeModelVisibility
event allows constraints to be applied in a query to fetch a model, effectively scoping that model's visibility to the user. - ApiController::setSerializer() — Method in class ApiController
- Set the serializer that will serialize data for the endpoint.
- ApiController::setLimit() — Method in class ApiController
- Set the default number of results.
- ApiController::setMaxLimit() — Method in class ApiController
- Set the maximum number of results.
- ApiController::setSort() — Method in class ApiController
- Set the default sort order for the results.
- ErrorHandling::status() — Method in class ErrorHandling
- Define the corresponding HTTP status code for a well-known error type.
- ModelVisibility::scope() — Method in class ModelVisibility
- Add a scoper for a given ability.
- ModelVisibility::scopeAll() — Method in class ModelVisibility
- Add a scoper scoper that will always run for this model, regardless of requested ability.
- ServiceProvider — 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).
- $DefaultLanguagePackGuard#settings — Property in class DefaultLanguagePackGuard
- $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::setEnabled() — Method in class ExtensionManager
- Persist the currently enabled extensions.
- $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
- $Index#settings — Property in class Index
- SavePasswordController — Class in namespace Flarum\Forum\Controller
- ForumServiceProvider::setDefaultRoute() — Method in class ForumServiceProvider
- Determine the default route.
- $Application#serviceProviders — Property in class Application
- All of the registered service providers.
- HandledError::shouldBeReported() — Method in class HandledError
- $ViewFormatter#settings — Property in class ViewFormatter
- InstalledApp::subPath() — Method in class InstalledApp
- 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
- JsCompiler::save() — Method in class JsCompiler
- LessCompiler::setCacheDir() — Method in class LessCompiler
- LessCompiler::setImportDirs() — Method in class LessCompiler
- $RevisionCompiler#sourcesCallbacks — Property in class RevisionCompiler
- RevisionCompiler::setFilename() — Method in class RevisionCompiler
- RevisionCompiler::save() — Method in class RevisionCompiler
- 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
- 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.
- $CookieFactory#secure — Property in class CookieFactory
- Whether the cookie(s) can be requested only over HTTPS.
- $CookieFactory#samesite — Property in class CookieFactory
- Same Site cookie value.
- $CollectGarbage#sessionHandler — Property in class CollectGarbage
- $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
- Server — 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
- Installation::settings() — Method in class Installation
- Step — Class in namespace Flarum\Install
- StepFailed — Class in namespace Flarum\Install
- StoreConfig — Class in namespace Flarum\Install\Steps
- LocaleManager::setLocale() — Method in class LocaleManager
- LocaleManager::setTranslator() — Method in class LocaleManager
- SendRawEmailJob — Class in namespace Flarum\Mail\Job
- SendmailDriver — Class in namespace Flarum\Mail
- SmtpDriver — Class in namespace Flarum\Mail
- AlertNotificationDriver::send() — Method in class AlertNotificationDriver
- Conditionally sends a notification to users, generally using a queue.
- EmailNotificationDriver::send() — Method in class EmailNotificationDriver
- Conditionally sends a notification to users, generally using a queue.
- NotificationDriverInterface::send() — Method in class NotificationDriverInterface
- Conditionally sends a notification to users, generally using a queue.
- Sending — Class in namespace Flarum\Notification\Event
- SendEmailNotificationJob — Class in namespace Flarum\Notification\Job
- SendNotificationsJob — Class in namespace Flarum\Notification\Job
- $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::setDataAttribute() — Method in class Notification
- When setting the data attribute, serialize it into JSON for storage in the database.
- Notification::subject() — Method in class Notification
- Define the relationship with the notification's subject.
- 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.
- NotificationMailer::send() — Method in class NotificationMailer
- NotificationServiceProvider::setNotificationDrivers() — Method in class NotificationServiceProvider
- Register notification drivers.
- NotificationServiceProvider::setNotificationTypes() — Method in class NotificationServiceProvider
- Register notification types.
- $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.
- $PostPolicy#settings — Property in class PostPolicy
- ScopePostVisibility — Class in namespace Flarum\Post\Access
- CommentPost::setContentAttribute() — Method in class CommentPost
- Parse the content before it is saved to the database.
- CommentPost::setParsedContentAttribute() — Method in class CommentPost
- Set the parsed/raw content.
- CommentPost::setFormatter() — Method in class CommentPost
- Set the text formatter instance.
- 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
- Set the model for the given post type.
- PostServiceProvider::setPostTypes() — Method in class PostServiceProvider
- ExceptionHandler::shouldReport() — Method in class ExceptionHandler
- Determine if the exception should be reported.
- AbstractSearch::setDefaultSort() — Method in class AbstractSearch
- 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.
- GambitManager::setFulltextGambit() — Method in class GambitManager
- Set the gambit to handle fulltext searching.
- SearchCriteria — Class in namespace Flarum\Search
- Represents the criteria that will determine the entire result set of a search. The limit and offset are not included because they only determine which part of the entire result set will be returned.
- $SearchCriteria#sort — Property in class SearchCriteria
- An array of sort-order pairs, where the column is the key, and the order is the value. The order may be 'asc', 'desc', or an array of IDs to order by.
- SearchResults — Class in namespace Flarum\Search
- SearchServiceProvider — Class in namespace Flarum\Search
- DatabaseSettingsRepository::set() — Method in class DatabaseSettingsRepository
- $Deserializing#settings — Property in class Deserializing
- The settings array to be unserialized.
- Saved — Class in namespace Flarum\Settings\Event
- $Saved#settings — Property in class Saved
- Saving — Class in namespace Flarum\Settings\Event
- $Saving#settings — Property in class Saving
- 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
- UninstalledSettingsRepository::set() — Method in class UninstalledSettingsRepository
- AbstractPolicy::subscribe() — Method in class AbstractPolicy
- AbstractPolicy::scopeModelVisibility() — Method in class AbstractPolicy
- ScopeUserVisibility — Class in namespace Flarum\User\Access
- $AccountActivationMailer#settings — Property in class AccountActivationMailer
- $RegisterUserHandler#settings — Property in class RegisterUserHandler
- $RequestPasswordResetHandler#settings — Property in class RequestPasswordResetHandler
- $EmailConfirmationMailer#settings — Property in class EmailConfirmationMailer
- 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
- Searching — Class in namespace Flarum\User\Event
- $Searching#search — Property in class Searching
- RegistrationToken::scopeValidOrFail() — Method in class RegistrationToken
- Find the token with the given ID, and assert that it has not expired.
- UserSearcher::search() — Method in class UserSearcher
- SelfDemotionGuard — Class in namespace Flarum\User
- SessionServiceProvider — Class in namespace Flarum\User
- $User#session — Property in class User
- User::setGate() — Method in class User
- User::setDisplayNameDriver() — Method in class User
- Set the display name driver.
- 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 or not the user should receive an alert for a notification type.
- User::shouldEmail() — Method in class User
- Check whether or not the user should receive an email for a notification type.
- User::setPreference() — Method in class User
- Set the value of a preference for this user.
- User::setSession() — Method in class User
- User::setHasher() — Method in class User
- Set the hasher with which to hash passwords.
- UserMetadataUpdater::subscribe() — Method in class UserMetadataUpdater
- UserRepository::scopeVisibleTo() — Method in class UserRepository
- Scope a query to only include records that are visible to a user.
- UserValidator::setUser() — Method in class UserValidator
T
- ApiKey::touch() — Method in class ApiKey
- $SendConfirmationEmailController#translator — Property in class SendConfirmationEmailController
- $SendTestMailController#translator — Property in class SendTestMailController
- ThrottleApi — Class in namespace Flarum\Api\Middleware
- $ThrottleApi#throttlers — Property in class ThrottleApi
- ThrottleApi::throttle() — Method in class ThrottleApi
- $BasicDiscussionSerializer#type — Property in class BasicDiscussionSerializer
- {@inheritdoc}
- $BasicPostSerializer#type — Property in class BasicPostSerializer
- {@inheritdoc}
- $BasicUserSerializer#type — Property in class BasicUserSerializer
- {@inheritdoc}
- $ForumSerializer#type — Property in class ForumSerializer
- {@inheritdoc}
- $GroupSerializer#type — Property in class GroupSerializer
- {@inheritdoc}
- $MailSettingsSerializer#type — Property in class MailSettingsSerializer
- {@inheritdoc}
- $NotificationSerializer#type — Property in class NotificationSerializer
- {@inheritdoc}
- $AbstractModel#timestamps — Property in class AbstractModel
- Indicates if the model should be timestamped. Turn off by default.
- $DatabaseMigrationRepository#table — Property in class DatabaseMigrationRepository
- The name of the migration table.
- 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
- {@inheritdoc}
- 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.
- ThrottleApi — Class in namespace Flarum\Extend
- $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.
- $Parsing#text — Property in class Parsing
- $Index#translator — Property in class Index
- $AbstractValidator#translator — Property in class AbstractValidator
- $ViewFormatter#translator — Property in class ViewFormatter
- $Validating#type — Property in class Validating
- 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
tag. - $Permission#table — Property in class Permission
- {@inheritdoc}
- $AccessToken#token — Property in class AccessToken
- AccessToken::touch() — Method in class AccessToken
- TokenMismatchException — Class in namespace Flarum\Http\Exception
- RouteHandlerFactory::toController() — Method in class RouteHandlerFactory
- RouteHandlerFactory::toFrontend() — Method in class RouteHandlerFactory
- RouteHandlerFactory::toForum() — Method in class RouteHandlerFactory
- RouteHandlerFactory::toAdmin() — Method in class RouteHandlerFactory
- SlugDriverInterface::toSlug() — Method in class SlugDriverInterface
- UrlGenerator::to() — Method in class UrlGenerator
- Retrieve an URL generator instance for the given named route collection.
- BaseUrl::toEmail() — Method in class BaseUrl
- Generate a valid e-mail address for this base URL's domain.
- DatabaseConfig::toArray() — Method in class DatabaseConfig
- $LocaleManager#translator — Property in class LocaleManager
- Translator — Class in namespace Flarum\Locale
- $Notification#type — Property in class Notification
- $NotificationMailer#translator — Property in class NotificationMailer
- $CommentPost#type — Property in class CommentPost
- {@inheritdoc}
- $DiscussionRenamedPost#type — Property in class DiscussionRenamedPost
- {@inheritdoc}
- $Post#table — Property in class Post
- $Post#type — Property in class Post
- $AccountActivationMailer#translator — Property in class AccountActivationMailer
- $ConfirmEmail#token — Property in class ConfirmEmail
- The email confirmation token.
- $RequestPasswordResetHandler#translator — Property in class RequestPasswordResetHandler
- $EmailConfirmationMailer#translator — Property in class EmailConfirmationMailer
- $EmailToken#token — Property in class EmailToken
- $LoggedIn#token — Property in class LoggedIn
- $LoginProvider#timestamps — Property in class LoginProvider
- $PasswordToken#token — Property in class PasswordToken
- $RegistrationToken#token — Property in class RegistrationToken
- UsernameSlugDriver::toSlug() — Method in class UsernameSlugDriver
U
- $ApiKey#user_id — Property in class ApiKey
- $ApiKey#user — Property in class ApiKey
- ApiKey::user() — Method in class ApiKey
- $CreateTokenController#users — Property in class CreateTokenController
- $DeleteFaviconController#uploadDir — Property in class DeleteFaviconController
- $DeleteLogoController#uploadDir — Property in class DeleteLogoController
- $ForgotPasswordController#users — Property in class ForgotPasswordController
- $ListDiscussionsController#url — Property in class ListDiscussionsController
- $ListNotificationsController#url — Property in class ListNotificationsController
- $ListUsersController#url — Property in class ListUsersController
- $SendConfirmationEmailController#url — Property in class SendConfirmationEmailController
- $ShowUserController#users — Property in class ShowUserController
- UninstallExtensionController — Class in namespace Flarum\Api\Controller
- UpdateDiscussionController — Class in namespace Flarum\Api\Controller
- UpdateExtensionController — Class in namespace Flarum\Api\Controller
- UpdateGroupController — Class in namespace Flarum\Api\Controller
- UpdateNotificationController — Class in namespace Flarum\Api\Controller
- UpdatePostController — Class in namespace Flarum\Api\Controller
- UpdateUserController — Class in namespace Flarum\Api\Controller
- UploadAvatarController — Class in namespace Flarum\Api\Controller
- UploadFaviconController — Class in namespace Flarum\Api\Controller
- UploadImageController — Class in namespace Flarum\Api\Controller
- $UploadImageController#uploadDir — Property in class UploadImageController
- UploadLogoController — Class in namespace Flarum\Api\Controller
- BasicDiscussionSerializer::user() — Method in class BasicDiscussionSerializer
- BasicPostSerializer::user() — Method in class BasicPostSerializer
- $ForumSerializer#url — Property in class ForumSerializer
- NotificationSerializer::user() — Method in class NotificationSerializer
- PostSerializer::user() — Method in class PostSerializer
- UserSerializer — Class in namespace Flarum\Api\Serializer
- MigrateCommand::upgrade() — Method in class MigrateCommand
- $Discussion#user_id — Property in class Discussion
- $Discussion#user — Property in class Discussion
- Discussion::user() — Method in class Discussion
- Define the relationship with the discussion's author.
- UserDataSaving — Class in namespace Flarum\Discussion\Event
- UserRead — Class in namespace Flarum\Discussion\Event
- $AuthorGambit#users — Property in class AuthorGambit
- UnreadGambit — Class in namespace Flarum\Discussion\Search\Gambit
- UserState — Class in namespace Flarum\Discussion
- Models a discussion-user state record in the database.
- $UserState#user_id — Property in class UserState
- $UserState#user — Property in class UserState
- UserState::user() — Method in class UserState
- Define the relationship with the user that this state is for.
- User — Class in namespace Flarum\Extend
- Uninstalled — Class in namespace Flarum\Extension\Event
- ExtensionManager::uninstall() — Method in class ExtensionManager
- Uninstalls an extension.
- ExtensionManager::unpublishAssets() — Method in class ExtensionManager
- Delete an extension's assets from public view.
- Formatter::unparse() — Method in class Formatter
- Unparse XML.
- $Discussion#url — Property in class Discussion
- $Index#url — Property in class Index
- User — Class in namespace Flarum\Forum\Content
- $User#url — Property in class User
- $ConfirmEmailController#url — Property in class ConfirmEmailController
- $LogInController#users — Property in class LogInController
- $LogOutController#url — Property in class LogOutController
- $SavePasswordController#url — Property in class SavePasswordController
- Application::url() — Method in class Application
- Get the URL to the Flarum installation.
- Config::url() — Method in class Config
- HandledError::unknown() — Method in class HandledError
- UninstalledSite — Class in namespace Flarum\Foundation
- $Group#users — Property in class Group
- Group::users() — Method in class Group
- Define the relationship with the group's users.
- $AccessToken#user_id — Property in class AccessToken
- $AccessToken#user — Property in class AccessToken
- AccessToken::user() — Method in class AccessToken
- Define the relationship with the owner of this access token.
- UrlGenerator — Class in namespace Flarum\Http
- UserDataProvider — Class in namespace Flarum\Install\Console
- $Sending#users — Property in class Sending
- The users that the notification will be sent to.
- $Notification#user_id — Property in class Notification
- $Notification#user — Property in class Notification
- Notification::user() — Method in class Notification
- Define the relationship with the notification's recipient.
- $Post#user_id — Property in class Post
- $Post#user — Property in class Post
- Post::user() — Method in class Post
- Define the relationship with the post's author.
- UninstalledSettingsRepository — Class in namespace Flarum\Settings
- UpdateController — Class in namespace Flarum\Update\Controller
- UpdateServiceProvider — Class in namespace Flarum\Update
- UserPolicy — Class in namespace Flarum\User\Access
- $AccountActivationMailer#url — Property in class AccountActivationMailer
- $AvatarUploader#uploadDir — Property in class AvatarUploader
- AvatarUploader::upload() — Method in class AvatarUploader
- $ConfirmEmailHandler#users — Property in class ConfirmEmailHandler
- $DeleteAvatar#userId — Property in class DeleteAvatar
- The ID of the user to delete the avatar of.
- $DeleteAvatarHandler#users — Property in class DeleteAvatarHandler
- $DeleteAvatarHandler#uploader — Property in class DeleteAvatarHandler
- $DeleteUser#userId — Property in class DeleteUser
- The ID of the user to delete.
- $DeleteUserHandler#users — Property in class DeleteUserHandler
- $EditUser#userId — Property in class EditUser
- The ID of the user to edit.
- $EditUserHandler#users — Property in class EditUserHandler
- $RequestPasswordResetHandler#users — Property in class RequestPasswordResetHandler
- $RequestPasswordResetHandler#url — Property in class RequestPasswordResetHandler
- UploadAvatar — Class in namespace Flarum\User\Command
- $UploadAvatar#userId — Property in class UploadAvatar
- The ID of the user to upload the avatar for.
- UploadAvatarHandler — Class in namespace Flarum\User\Command
- $UploadAvatarHandler#users — Property in class UploadAvatarHandler
- $UploadAvatarHandler#uploader — Property in class UploadAvatarHandler
- UsernameDriver — Class in namespace Flarum\User\DisplayName
- The default driver, which returns the user's username.
- $EmailConfirmationMailer#url — Property in class EmailConfirmationMailer
- $EmailToken#user_id — Property in class EmailToken
- EmailToken::user() — Method in class EmailToken
- Define the relationship with the owner of this email token.
- $Activated#user — Property in class Activated
- $AvatarChanged#user — Property in class AvatarChanged
- $AvatarDeleting#user — Property in class AvatarDeleting
- The user whose avatar will be deleted.
- $AvatarSaving#user — Property in class AvatarSaving
- The user whose avatar will be saved.
- $CheckingPassword#user — Property in class CheckingPassword
- $Deleted#user — Property in class Deleted
- $Deleting#user — Property in class Deleting
- The user who will be deleted.
- $EmailChangeRequested#user — Property in class EmailChangeRequested
- The user who requested the email change.
- $EmailChanged#user — Property in class EmailChanged
- $GroupsChanged#user — Property in class GroupsChanged
- The user whose groups were changed.
- $LoggedIn#user — Property in class LoggedIn
- $LoggedOut#user — Property in class LoggedOut
- $PasswordChanged#user — Property in class PasswordChanged
- $Registered#user — Property in class Registered
- $RegisteringFromProvider#user — Property in class RegisteringFromProvider
- $Renamed#user — Property in class Renamed
- $Saving#user — Property in class Saving
- The user that will be saved.
- $LoginProvider#user_id — Property in class LoginProvider
- LoginProvider::user() — Method in class LoginProvider
- Get the user that the login provider belongs to.
- $PasswordToken#user_id — Property in class PasswordToken
- PasswordToken::user() — Method in class PasswordToken
- Define the relationship with the owner of this password token.
- $RegistrationToken#user_attributes — Property in class RegistrationToken
- $EmailGambit#users — Property in class EmailGambit
- $FulltextGambit#users — Property in class FulltextGambit
- UserSearch — Class in namespace Flarum\User\Search
- UserSearcher — Class in namespace Flarum\User\Search
- Takes a UserSearchCriteria object, performs a search using gambits, and spits out a UserSearchResults object.
- $UserSearcher#users — Property in class UserSearcher
- User — Class in namespace Flarum\User
- $User#username — Property in class User
- User::updateLastSeen() — Method in class User
- Set the user as being last seen just now.
- UserMetadataUpdater — Class in namespace Flarum\User
- UserRepository — Class in namespace Flarum\User
- UserServiceProvider — Class in namespace Flarum\User
- UserValidator — Class in namespace Flarum\User
- $UserValidator#user — Property in class UserValidator
- UsernameSlugDriver — Class in namespace Flarum\User
- $UsernameSlugDriver#users — Property in class UsernameSlugDriver
V
- $ScopeVisibilityTrait#visibilityScopers — Property in class ScopeVisibilityTrait
- $EditDiscussionHandler#validator — Property in class EditDiscussionHandler
- $StartDiscussionHandler#validator — Property in class StartDiscussionHandler
- Validator — Class in namespace Flarum\Extend
- View — Class in namespace Flarum\Extend
- $Extension#version — Property in class Extension
- The installed version of the extension.
- $Discussion#view — Property in class Discussion
- $Index#view — Property in class Index
- $LogOutController#view — Property in class LogOutController
- $ResetPasswordController#view — Property in class ResetPasswordController
- $SavePasswordController#validator — Property in class SavePasswordController
- $SavePasswordController#validatorFactory — Property in class SavePasswordController
- ValidateCustomLess — Class in namespace Flarum\Forum
- $AbstractValidator#validator — Property in class AbstractValidator
- ValidationExceptionHandler — Class in namespace Flarum\Foundation\ErrorHandling\ExceptionHandler
- ViewFormatter — Class in namespace Flarum\Foundation\ErrorHandling
- A formatter for turning caught exceptions into "pretty" HTML error pages.
- $ViewFormatter#view — Property in class ViewFormatter
- Validating — Class in namespace Flarum\Foundation\Event
- $Validating#validator — Property in class Validating
- ValidationException — Class in namespace Flarum\Foundation
- $Document#view — Property in class Document
- $Frontend#view — Property in class Frontend
- $CreateGroupHandler#validator — Property in class CreateGroupHandler
- $EditGroupHandler#validator — Property in class EditGroupHandler
- $ShareErrorsFromSession#view — Property in class ShareErrorsFromSession
- $IndexController#view — Property in class IndexController
- ValidationFailed — Class in namespace Flarum\Install
- DriverInterface::validate() — Method in class DriverInterface
- Ensure the given settings are enough to send emails.
- LogDriver::validate() — Method in class LogDriver
- Ensure the given settings are enough to send emails.
- MailgunDriver::validate() — Method in class MailgunDriver
- Ensure the given settings are enough to send emails.
- NullDriver::validate() — Method in class NullDriver
- Ensure the given settings are enough to send emails.
- SendmailDriver::validate() — Method in class SendmailDriver
- Ensure the given settings are enough to send emails.
- SmtpDriver::validate() — Method in class SmtpDriver
- Ensure the given settings are enough to send emails.
- $EditPostHandler#validator — Property in class EditPostHandler
- $PostReplyHandler#validator — Property in class PostReplyHandler
- $Serializing#value — Property in class Serializing
- The settings value to save.
- $IndexController#view — Property in class IndexController
- $EditUserHandler#validator — Property in class EditUserHandler
- $RegisterUserHandler#validator — Property in class RegisterUserHandler
- $RequestPasswordResetHandler#validatorFactory — Property in class RequestPasswordResetHandler
- $UploadAvatarHandler#validator — Property in class UploadAvatarHandler
- User::visibleGroups() — Method in class User
W
- WillGetData — Class in namespace Flarum\Api\Event
- WillSerializeData — Class in namespace Flarum\Api\Event
- GenerateMigrationCommand::writeMigration() — Method in class GenerateMigrationCommand
- Write the migration file to disk.
- DiscussionMetadataUpdater::whenPostWasPosted() — Method in class DiscussionMetadataUpdater
- DiscussionMetadataUpdater::whenPostWasDeleted() — Method in class DiscussionMetadataUpdater
- DiscussionMetadataUpdater::whenPostWasHidden() — Method in class DiscussionMetadataUpdater
- DiscussionMetadataUpdater::whenPostWasRestored() — Method in class DiscussionMetadataUpdater
- ValidateCustomLess::whenSettingsSaving() — Method in class ValidateCustomLess
- ValidateCustomLess::whenSettingsSaved() — Method in class ValidateCustomLess
- ContainerUtil::wrapCallback() — Method in class ContainerUtil
- Wraps a callback so that string-based invokable classes get resolved only when actually used.
- HandledError::withDetails() — Method in class HandledError
- WhoopsFormatter — Class in namespace Flarum\Foundation\ErrorHandling
- Handle errors using the Whoops error handler for debugging.
- RecompileFrontendAssets::whenSettingsSaved() — Method in class RecompileFrontendAssets
- WritablePaths — Class in namespace Flarum\Install\Prerequisite
- WriteSettings — Class in namespace Flarum\Install\Steps
- WorkCommand — Class in namespace Flarum\Queue\Console
- UserMetadataUpdater::whenPostWasPosted() — Method in class UserMetadataUpdater
- UserMetadataUpdater::whenPostWasDeleted() — Method in class UserMetadataUpdater
- UserMetadataUpdater::whenDiscussionWasStarted() — Method in class UserMetadataUpdater
- UserMetadataUpdater::whenDiscussionWasDeleted() — Method in class UserMetadataUpdater
X
- $Rendering#xml — Property in class Rendering
_
- AdminPayload::__construct() — Method in class AdminPayload
- AdminPayload::__invoke() — Method in class AdminPayload
- Client::__construct() — Method in class Client
- ClearCacheController::__construct() — Method in class ClearCacheController
- CreateDiscussionController::__construct() — Method in class CreateDiscussionController
- CreateGroupController::__construct() — Method in class CreateGroupController
- CreatePostController::__construct() — Method in class CreatePostController
- CreateTokenController::__construct() — Method in class CreateTokenController
- CreateUserController::__construct() — Method in class CreateUserController
- DeleteAvatarController::__construct() — Method in class DeleteAvatarController
- DeleteDiscussionController::__construct() — Method in class DeleteDiscussionController
- DeleteFaviconController::__construct() — Method in class DeleteFaviconController
- DeleteGroupController::__construct() — Method in class DeleteGroupController
- DeleteLogoController::__construct() — Method in class DeleteLogoController
- DeletePostController::__construct() — Method in class DeletePostController
- DeleteUserController::__construct() — Method in class DeleteUserController
- ForgotPasswordController::__construct() — Method in class ForgotPasswordController
- ListDiscussionsController::__construct() — Method in class ListDiscussionsController
- ListNotificationsController::__construct() — Method in class ListNotificationsController
- ListPostsController::__construct() — Method in class ListPostsController
- ListUsersController::__construct() — Method in class ListUsersController
- ReadAllNotificationsController::__construct() — Method in class ReadAllNotificationsController
- SendConfirmationEmailController::__construct() — Method in class SendConfirmationEmailController
- SendTestMailController::__construct() — Method in class SendTestMailController
- SetSettingsController::__construct() — Method in class SetSettingsController
- ShowDiscussionController::__construct() — Method in class ShowDiscussionController
- ShowPostController::__construct() — Method in class ShowPostController
- ShowUserController::__construct() — Method in class ShowUserController
- UninstallExtensionController::__construct() — Method in class UninstallExtensionController
- UpdateDiscussionController::__construct() — Method in class UpdateDiscussionController
- UpdateExtensionController::__construct() — Method in class UpdateExtensionController
- UpdateGroupController::__construct() — Method in class UpdateGroupController
- UpdateNotificationController::__construct() — Method in class UpdateNotificationController
- UpdatePostController::__construct() — Method in class UpdatePostController
- UpdateUserController::__construct() — Method in class UpdateUserController
- UploadAvatarController::__construct() — Method in class UploadAvatarController
- UploadImageController::__construct() — Method in class UploadImageController
- Serializing::__construct() — Method in class Serializing
- WillGetData::__construct() — Method in class WillGetData
- WillSerializeData::__construct() — Method in class WillSerializeData
- JsonApiResponse::__construct() — Method in class JsonApiResponse
- {@inheritdoc}
- ThrottleApi::__construct() — Method in class ThrottleApi
- BasicDiscussionSerializer::__construct() — Method in class BasicDiscussionSerializer
- BasicUserSerializer::__construct() — Method in class BasicUserSerializer
- ForumSerializer::__construct() — Method in class ForumSerializer
- GroupSerializer::__construct() — Method in class GroupSerializer
- Server::__construct() — Method in class Server
- AbstractModel::__construct() — Method in class AbstractModel
- {@inheritdoc}
- AbstractModel::__call() — Method in class AbstractModel
- {@inheritdoc}
- GenerateMigrationCommand::__construct() — Method in class GenerateMigrationCommand
- MigrateCommand::__construct() — Method in class MigrateCommand
- ResetCommand::__construct() — Method in class ResetCommand
- DatabaseMigrationRepository::__construct() — Method in class DatabaseMigrationRepository
- Create a new database migration repository instance.
- MigrationCreator::__construct() — Method in class MigrationCreator
- Create a new migrator instance.
- Migrator::__construct() — Method in class Migrator
- Create a new migrator instance.
- DiscussionPolicy::__construct() — Method in class DiscussionPolicy
- ScopeDiscussionVisibility::__invoke() — Method in class ScopeDiscussionVisibility
- DeleteDiscussion::__construct() — Method in class DeleteDiscussion
- DeleteDiscussionHandler::__construct() — Method in class DeleteDiscussionHandler
- EditDiscussion::__construct() — Method in class EditDiscussion
- EditDiscussionHandler::__construct() — Method in class EditDiscussionHandler
- ReadDiscussion::__construct() — Method in class ReadDiscussion
- ReadDiscussionHandler::__construct() — Method in class ReadDiscussionHandler
- StartDiscussion::__construct() — Method in class StartDiscussion
- StartDiscussionHandler::__construct() — Method in class StartDiscussionHandler
- DiscussionRenamedLogger::__construct() — Method in class DiscussionRenamedLogger
- Deleted::__construct() — Method in class Deleted
- Deleting::__construct() — Method in class Deleting
- Hidden::__construct() — Method in class Hidden
- Renamed::__construct() — Method in class Renamed
- Restored::__construct() — Method in class Restored
- Saving::__construct() — Method in class Saving
- Searching::__construct() — Method in class Searching
- Started::__construct() — Method in class Started
- UserDataSaving::__construct() — Method in class UserDataSaving
- UserRead::__construct() — Method in class UserRead
- IdWithTransliteratedSlugDriver::__construct() — Method in class IdWithTransliteratedSlugDriver
- DiscussionSearcher::__construct() — Method in class DiscussionSearcher
- AuthorGambit::__construct() — Method in class AuthorGambit
- UnreadGambit::__construct() — Method in class UnreadGambit
- AbstractConfigureGambits::__construct() — Method in class AbstractConfigureGambits
- ConfigureNotificationTypes::__construct() — Method in class ConfigureNotificationTypes
- ConfigurePostTypes::__construct() — Method in class ConfigurePostTypes
- ConfigurePostsQuery::__construct() — Method in class ConfigurePostsQuery
- GetApiRelationship::__construct() — Method in class GetApiRelationship
- GetModelIsPrivate::__construct() — Method in class GetModelIsPrivate
- GetPermission::__construct() — Method in class GetPermission
- ScopeModelVisibility::__construct() — Method in class ScopeModelVisibility
- ApiController::__construct() — Method in class ApiController
- ApiSerializer::__construct() — Method in class ApiSerializer
- Compat::__construct() — Method in class Compat
- Frontend::__construct() — Method in class Frontend
- LanguagePack::__construct() — Method in class LanguagePack
- LanguagePack constructor.
- Locales::__construct() — Method in class Locales
- Middleware::__construct() — Method in class Middleware
- Model::__construct() — Method in class Model
- ModelUrl::__construct() — Method in class ModelUrl
- ModelVisibility::__construct() — Method in class ModelVisibility
- Routes::__construct() — Method in class Routes
- Validator::__construct() — Method in class Validator
- DefaultLanguagePackGuard::__construct() — Method in class DefaultLanguagePackGuard
- Disabled::__construct() — Method in class Disabled
- Disabling::__construct() — Method in class Disabling
- Enabled::__construct() — Method in class Enabled
- Enabling::__construct() — Method in class Enabling
- Uninstalled::__construct() — Method in class Uninstalled
- DependentExtensionsException::__construct() — Method in class DependentExtensionsException
- MissingDependenciesException::__construct() — Method in class MissingDependenciesException
- Extension::__construct() — Method in class Extension
- Extension::__get() — Method in class Extension
- {@inheritdoc}
- Extension::__isset() — Method in class Extension
- {@inheritdoc}
- ExtensionManager::__construct() — Method in class ExtensionManager
- Configuring::__construct() — Method in class Configuring
- Parsing::__construct() — Method in class Parsing
- Rendering::__construct() — Method in class Rendering
- Formatter::__construct() — Method in class Formatter
- ResponseFactory::__construct() — Method in class ResponseFactory
- AssertRegistered::__invoke() — Method in class AssertRegistered
- Discussion::__construct() — Method in class Discussion
- Discussion::__invoke() — Method in class Discussion
- Index::__construct() — Method in class Index
- Index::__invoke() — Method in class Index
- User::__construct() — Method in class User
- User::__invoke() — Method in class User
- ConfirmEmailController::__construct() — Method in class ConfirmEmailController
- LogInController::__construct() — Method in class LogInController
- LogOutController::__construct() — Method in class LogOutController
- RegisterController::__construct() — Method in class RegisterController
- ResetPasswordController::__construct() — Method in class ResetPasswordController
- SavePasswordController::__construct() — Method in class SavePasswordController
- ValidateCustomLess::__construct() — Method in class ValidateCustomLess
- AbstractServiceProvider::__construct() — Method in class AbstractServiceProvider
- AbstractValidator::__construct() — Method in class AbstractValidator
- Application::__construct() — Method in class Application
- Create a new Flarum application instance.
- Config::__construct() — Method in class Config
- CacheClearCommand::__construct() — Method in class CacheClearCommand
- InfoCommand::__construct() — Method in class InfoCommand
- HandledError::__construct() — Method in class HandledError
- JsonApiFormatter::__construct() — Method in class JsonApiFormatter
- LogReporter::__construct() — Method in class LogReporter
- Registry::__construct() — Method in class Registry
- ViewFormatter::__construct() — Method in class ViewFormatter
- Validating::__construct() — Method in class Validating
- InstalledApp::__construct() — Method in class InstalledApp
- InstalledSite::__construct() — Method in class InstalledSite
- Paths::__construct() — Method in class Paths
- Paths::__get() — Method in class Paths
- UninstalledSite::__construct() — Method in class UninstalledSite
- ValidationException::__construct() — Method in class ValidationException
- AddLocaleAssets::__construct() — Method in class AddLocaleAssets
- AddTranslations::__construct() — Method in class AddTranslations
- Assets::__construct() — Method in class Assets
- RevisionCompiler::__construct() — Method in class RevisionCompiler
- FileSource::__construct() — Method in class FileSource
- StringSource::__construct() — Method in class StringSource
- Assets::__construct() — Method in class Assets
- Assets::__invoke() — Method in class Assets
- CorePayload::__construct() — Method in class CorePayload
- CorePayload::__invoke() — Method in class CorePayload
- Meta::__construct() — Method in class Meta
- Meta::__invoke() — Method in class Meta
- Controller::__construct() — Method in class Controller
- Document::__construct() — Method in class Document
- Frontend::__construct() — Method in class Frontend
- RecompileFrontendAssets::__construct() — Method in class RecompileFrontendAssets
- ScopeGroupVisibility::__invoke() — Method in class ScopeGroupVisibility
- CreateGroup::__construct() — Method in class CreateGroup
- CreateGroupHandler::__construct() — Method in class CreateGroupHandler
- DeleteGroup::__construct() — Method in class DeleteGroup
- DeleteGroupHandler::__construct() — Method in class DeleteGroupHandler
- EditGroup::__construct() — Method in class EditGroup
- EditGroupHandler::__construct() — Method in class EditGroupHandler
- Created::__construct() — Method in class Created
- Deleted::__construct() — Method in class Deleted
- Deleting::__construct() — Method in class Deleting
- Renamed::__construct() — Method in class Renamed
- Saving::__construct() — Method in class Saving
- CookieFactory::__construct() — Method in class CookieFactory
- CheckCsrfToken::__construct() — Method in class CheckCsrfToken
- CollectGarbage::__construct() — Method in class CollectGarbage
- HandleErrors::__construct() — Method in class HandleErrors
- RememberFromCookie::__construct() — Method in class RememberFromCookie
- ResolveRoute::__construct() — Method in class ResolveRoute
- Create the middleware instance.
- SetLocale::__construct() — Method in class SetLocale
- ShareErrorsFromSession::__construct() — Method in class ShareErrorsFromSession
- StartSession::__construct() — Method in class StartSession
- Rememberer::__construct() — Method in class Rememberer
- RouteCollection::__construct() — Method in class RouteCollection
- RouteCollectionUrlGenerator::__construct() — Method in class RouteCollectionUrlGenerator
- RouteHandlerFactory::__construct() — Method in class RouteHandlerFactory
- Server::__construct() — Method in class Server
- SlugManager::__construct() — Method in class SlugManager
- UrlGenerator::__construct() — Method in class UrlGenerator
- AdminUser::__construct() — Method in class AdminUser
- BaseUrl::__toString() — Method in class BaseUrl
- FileDataProvider::__construct() — Method in class FileDataProvider
- InstallCommand::__construct() — Method in class InstallCommand
- UserDataProvider::__construct() — Method in class UserDataProvider
- IndexController::__construct() — Method in class IndexController
- InstallController::__construct() — Method in class InstallController
- InstallController constructor.
- DatabaseConfig::__construct() — Method in class DatabaseConfig
- Installation::__construct() — Method in class Installation
- Installer::__construct() — Method in class Installer
- Pipeline::__construct() — Method in class Pipeline
- Composite::__construct() — Method in class Composite
- PhpExtensions::__construct() — Method in class PhpExtensions
- PhpVersion::__construct() — Method in class PhpVersion
- WritablePaths::__construct() — Method in class WritablePaths
- ConnectToDatabase::__construct() — Method in class ConnectToDatabase
- CreateAdminUser::__construct() — Method in class CreateAdminUser
- EnableBundledExtensions::__construct() — Method in class EnableBundledExtensions
- PublishAssets::__construct() — Method in class PublishAssets
- RunMigrations::__construct() — Method in class RunMigrations
- StoreConfig::__construct() — Method in class StoreConfig
- WriteSettings::__construct() — Method in class WriteSettings
- LocaleManager::__construct() — Method in class LocaleManager
- SendRawEmailJob::__construct() — Method in class SendRawEmailJob
- LogDriver::__construct() — Method in class LogDriver
- DiscussionRenamedBlueprint::__construct() — Method in class DiscussionRenamedBlueprint
- ReadAllNotifications::__construct() — Method in class ReadAllNotifications
- ReadAllNotificationsHandler::__construct() — Method in class ReadAllNotificationsHandler
- ReadNotification::__construct() — Method in class ReadNotification
- AlertNotificationDriver::__construct() — Method in class AlertNotificationDriver
- EmailNotificationDriver::__construct() — Method in class EmailNotificationDriver
- Sending::__construct() — Method in class Sending
- SendEmailNotificationJob::__construct() — Method in class SendEmailNotificationJob
- SendNotificationsJob::__construct() — Method in class SendNotificationsJob
- NotificationMailer::__construct() — Method in class NotificationMailer
- PostPolicy::__construct() — Method in class PostPolicy
- ScopePostVisibility::__invoke() — Method in class ScopePostVisibility
- DeletePost::__construct() — Method in class DeletePost
- DeletePostHandler::__construct() — Method in class DeletePostHandler
- EditPost::__construct() — Method in class EditPost
- EditPostHandler::__construct() — Method in class EditPostHandler
- PostReply::__construct() — Method in class PostReply
- PostReplyHandler::__construct() — Method in class PostReplyHandler
- CheckingForFlooding::__construct() — Method in class CheckingForFlooding
- Deleted::__construct() — Method in class Deleted
- Deleting::__construct() — Method in class Deleting
- Hidden::__construct() — Method in class Hidden
- Posted::__construct() — Method in class Posted
- Restored::__construct() — Method in class Restored
- Revised::__construct() — Method in class Revised
- Saving::__construct() — Method in class Saving
- Floodgate::__construct() — Method in class Floodgate
- ListenCommand::__construct() — Method in class ListenCommand
- ExceptionHandler::__construct() — Method in class ExceptionHandler
- QueueFactory::__construct() — Method in class QueueFactory
- QueueFactory constructor.
- QueueServiceProvider::__construct() — Method in class QueueServiceProvider
- QueueServiceProvider::__call() — Method in class QueueServiceProvider
- AbstractSearch::__construct() — Method in class AbstractSearch
- GambitManager::__construct() — Method in class GambitManager
- SearchCriteria::__construct() — Method in class SearchCriteria
- SearchResults::__construct() — Method in class SearchResults
- DatabaseSettingsRepository::__construct() — Method in class DatabaseSettingsRepository
- Deserializing::__construct() — Method in class Deserializing
- Saved::__construct() — Method in class Saved
- Saving::__construct() — Method in class Saving
- Serializing::__construct() — Method in class Serializing
- MemoryCacheSettingsRepository::__construct() — Method in class MemoryCacheSettingsRepository
- OverrideSettingsRepository::__construct() — Method in class OverrideSettingsRepository
- IndexController::__construct() — Method in class IndexController
- UpdateController::__construct() — Method in class UpdateController
- Gate::__construct() — Method in class Gate
- ScopeUserVisibility::__invoke() — Method in class ScopeUserVisibility
- AccountActivationMailer::__construct() — Method in class AccountActivationMailer
- AvatarUploader::__construct() — Method in class AvatarUploader
- ConfirmEmail::__construct() — Method in class ConfirmEmail
- ConfirmEmailHandler::__construct() — Method in class ConfirmEmailHandler
- DeleteAvatar::__construct() — Method in class DeleteAvatar
- DeleteAvatarHandler::__construct() — Method in class DeleteAvatarHandler
- DeleteUser::__construct() — Method in class DeleteUser
- DeleteUserHandler::__construct() — Method in class DeleteUserHandler
- EditUser::__construct() — Method in class EditUser
- EditUserHandler::__construct() — Method in class EditUserHandler
- RegisterUser::__construct() — Method in class RegisterUser
- RegisterUserHandler::__construct() — Method in class RegisterUserHandler
- RequestPasswordReset::__construct() — Method in class RequestPasswordReset
- RequestPasswordResetHandler::__construct() — Method in class RequestPasswordResetHandler
- UploadAvatar::__construct() — Method in class UploadAvatar
- UploadAvatarHandler::__construct() — Method in class UploadAvatarHandler
- EmailConfirmationMailer::__construct() — Method in class EmailConfirmationMailer
- Activated::__construct() — Method in class Activated
- AvatarChanged::__construct() — Method in class AvatarChanged
- AvatarDeleting::__construct() — Method in class AvatarDeleting
- AvatarSaving::__construct() — Method in class AvatarSaving
- CheckingPassword::__construct() — Method in class CheckingPassword
- Deleted::__construct() — Method in class Deleted
- Deleting::__construct() — Method in class Deleting
- EmailChangeRequested::__construct() — Method in class EmailChangeRequested
- EmailChanged::__construct() — Method in class EmailChanged
- GroupsChanged::__construct() — Method in class GroupsChanged
- LoggedIn::__construct() — Method in class LoggedIn
- LoggedOut::__construct() — Method in class LoggedOut
- PasswordChanged::__construct() — Method in class PasswordChanged
- Registered::__construct() — Method in class Registered
- RegisteringFromProvider::__construct() — Method in class RegisteringFromProvider
- Renamed::__construct() — Method in class Renamed
- Saving::__construct() — Method in class Saving
- Searching::__construct() — Method in class Searching
- EmailGambit::__construct() — Method in class EmailGambit
- FulltextGambit::__construct() — Method in class FulltextGambit
- GroupGambit::__construct() — Method in class GroupGambit
- UserSearcher::__construct() — Method in class UserSearcher
- UsernameSlugDriver::__construct() — Method in class UsernameSlugDriver