Classes
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.
Takes a DiscussionSearchCriteria object, performs a search using gambits,
and spits out a DiscussionSearchResults object.
A notification Blueprint, when instantiated, represents a notification about
something. The blueprint is used by the NotificationSyncer to commit the
notification to the database.
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.
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.
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.
Takes a UserSearchCriteria object, performs a search using gambits,
and spits out a UserSearchResults object.
The
ModelDates
event is called to retrieve a list of fields for a model
that should be converted into date objects.
The
ModelRelationship
event is called to retrieve Relation object for a
model. Listeners should return an Eloquent Relation object.
The
ModelValidator
event is called when a validator instance for a
model is being built. This event can be used to add custom rules/extensions
to the validator for when validation takes place.
The
ScopeModelVisibility
event allows constraints to be applied in a query
to fetch a model, effectively scoping that model's visibility to the user.
This action sets up a ClientView, and preloads it with the assets necessary
to boot a Flarum client.