Query Builder
FluentCommunity models inherit the WPFluent query builder. The generated scope inventory below comes directly from scope* methods in the model layer.
Scope Inventory
| Model | Scope | Parameters |
|---|---|---|
Activity | ByActions | $query, $actions = [] |
Activity | BySpace | $query, $spaceId |
BaseSpace | SearchBy | $query, $search |
BaseSpace | OnlyMain | $query |
BaseSpace | FilterByUserId | $query, $userId |
BaseSpace | ByUserAccess | $query, $userId |
Comment | SearchBy | $query, $search |
Comment | ByContentModerationAccessStatus | $query, $user, $space = null |
Feed | SearchBy | $query, $search, $in = [] |
Feed | ByUserAccess | $query, $userId |
Feed | ByContentModerationAccessStatus | $query, $user, $space = null |
Feed | ByBookMarked | $query, $userId |
Feed | ByTopicSlug | $query, $topicSlug |
Feed | FilterBySpaceSlug | $query, $space |
Feed | ByType | $query, $type |
Feed | CustomOrderBy | $query, $type |
Feed | ByStatus | $query, $status |
Feed | ByFollowing | $query, $userId = null |
Feed | FilterByUserId | $query, $userId |
Media | BySource | $query, $sources = [] |
Media | ByMediaKey | $query, $key |
Media | ByUser | $query, $userId |
Meta | ByType | $query, $type |
Meta | ByMetaKey | $query, $key |
Meta | ByObjectId | $query, $objectId |
Notification | ByStatus | $query, $status, $userId |
Notification | ByType | $query, $type |
NotificationSubscriber | Unread | $query |
NotificationSubscriber | Read | $query |
Reaction | TypeBy | $query, $type = 'like' |
Reaction | ObjectType | $query, $type = 'feed' |
SidebarLink | SearchBy | $query, $search |
SidebarLink | OnlyMain | $query |
SidebarLink | FilterByUserId | $query, $userId |
SidebarLink | ByUserAccess | $query, $userId |
Space | SearchBy | $query, $search |
Space | OnlyMain | $query |
Space | FilterByUserId | $query, $userId |
Space | ByUserAccess | $query, $userId |
SpaceGroup | SearchBy | $query, $search |
SpaceUserPivot | BySpace | $query, $spaceId |
SpaceUserPivot | ByUser | $query, $userId |
Term | SearchBy | $query, $search |
UserMeta | ByKey | $query, $key |
UserMeta | ByUser | $query, $userId |
XProfile | SearchBy | $query, $search |
XProfile | MentionBy | $query, $search |
Common Patterns
php
use FluentCommunity\App\Models\Feed;
use FluentCommunity\App\Models\Space;
$feeds = Feed::query()
->searchBy('release notes')
->byUserAccess(get_current_user_id())
->limit(10)
->get();
$spaces = Space::query()
->searchBy('marketing')
->orderBy('title', 'ASC')
->get();