BMLT PHP Query Client

QuickSearch extends MeetingQueryBuilder
in package

Quick search helper with pre-built search patterns.

Extends MeetingQueryBuilder to provide convenient methods for common search patterns like "today's meetings", "evening meetings", etc. All methods are chainable and return the QuickSearch instance.

Tags
author

Patrick Joyce

since
1.0.0
example 
$quickSearch = new QuickSearch($client);

// Get today's virtual meetings
$meetings = $quickSearch->today()->virtualOnly()->execute();

// Get tonight's in-person meetings
$meetings = $quickSearch->tonight()->inPersonOnly()->execute();

Table of Contents

Methods

__construct()  : mixed
afternoon()  : self
Get afternoon meetings (12 PM - 5 PM)
beginnerFriendly()  : self
Get beginner-friendly meetings (searches for beginner-related text)
bookStudy()  : self
Get book study meetings (searches for book-related text)
closedMeetings()  : self
Get closed meetings (searches for closed-related text)
discussionMeetings()  : self
Get discussion meetings (searches for discussion-related text)
earlyMorning()  : self
Get early morning meetings (before 9 AM)
endingAfter()  : self
Filter meetings ending after specified time
endingBefore()  : self
Filter meetings ending before specified time
evening()  : self
Get evening meetings (after 5 PM)
execute()  : array<string|int, Meeting>
Execute the query and return meetings.
executeNearAddress()  : array<string|int, mixed>
Execute query near an address (uses geocoding)
executeNearAddressKm()  : array<string|int, mixed>
Execute query near an address in kilometers
getParams()  : array<string|int, mixed>
Get the current parameters (useful for debugging)
hybrid()  : self
Get hybrid meetings only
hybridOnly()  : self
Filter to hybrid meetings only
inLanguage()  : self
Filter by language
inPerson()  : self
Get in-person meetings only
inPersonOnly()  : self
Filter to in-person meetings only
inServiceBody()  : self
Filter by service body ID
lateNight()  : self
Get late night meetings (after 9 PM)
lunchtime()  : self
Get lunch time meetings (11 AM - 2 PM)
meditation()  : self
Get meetings with meditation (searches for meditation-related text)
morning()  : self
Get morning meetings (before 12 PM)
nearCoordinates()  : self
Filter by geographic coordinates and radius
nearCoordinatesKm()  : self
Filter by geographic coordinates and radius in kilometers
onWeekdays()  : self
Filter meetings by specific weekdays.
openMeetings()  : self
Get open meetings (searches for open-related text)
paginate()  : self
Set page size for results
reset()  : self
Reset all parameters
searchText()  : self
Search for text in meeting data
sortBy()  : self
Sort results by specified key
sortByDistance()  : self
Sort results by distance (requires coordinates)
speakerMeetings()  : self
Get speaker meetings (searches for speaker-related text)
startingAfter()  : self
Filter meetings starting after specified time
startingBefore()  : self
Filter meetings starting before specified time
stepMeetings()  : self
Get step meetings (searches for step-related text)
thisMorning()  : self
Get this morning's meetings (today + morning)
thisWeek()  : self
Get this week's meetings
today()  : self
Get meetings happening today.
todayVirtual()  : self
Combine today + virtual for quick remote access
tomorrow()  : self
Get meetings happening tomorrow
tonight()  : self
Get tonight's meetings (today + evening)
virtual()  : self
Get virtual meetings only
virtualOnly()  : self
Filter to virtual meetings only
weekdays()  : self
Get weekday meetings (Monday through Friday)
weekend()  : self
Get weekend meetings (Saturday and Sunday)
weekendInPerson()  : self
Combine weekend + in-person
withFormat()  : self
Filter by format shared ID
withFormats()  : self
Filter by multiple format shared IDs
withParam()  : self
Add custom parameter
withVenueType()  : self
Filter by venue type

Methods

afternoon()

Get afternoon meetings (12 PM - 5 PM)

public afternoon() : self
Return values
self

beginnerFriendly()

Get beginner-friendly meetings (searches for beginner-related text)

public beginnerFriendly() : self
Return values
self

bookStudy()

Get book study meetings (searches for book-related text)

public bookStudy() : self
Return values
self

closedMeetings()

Get closed meetings (searches for closed-related text)

public closedMeetings() : self
Return values
self

discussionMeetings()

Get discussion meetings (searches for discussion-related text)

public discussionMeetings() : self
Return values
self

earlyMorning()

Get early morning meetings (before 9 AM)

public earlyMorning() : self
Return values
self

endingAfter()

Filter meetings ending after specified time

public endingAfter(int $hour[, int $minute = 0 ]) : self
Parameters
$hour : int
$minute : int = 0
Return values
self

endingBefore()

Filter meetings ending before specified time

public endingBefore(int $hour[, int $minute = 0 ]) : self
Parameters
$hour : int
$minute : int = 0
Return values
self

evening()

Get evening meetings (after 5 PM)

public evening() : self
Return values
self

execute()

Execute the query and return meetings.

public execute() : array<string|int, Meeting>

Runs the constructed query against the BMLT server and returns an array of Meeting objects matching the specified criteria.

Tags
throws
BmltQueryException

If the request fails or returns invalid data

example 
$meetings = $builder->virtualOnly()->startingAfter(18, 0)->execute();
Return values
array<string|int, Meeting> —

Array of Meeting objects matching the query criteria

executeNearAddress()

Execute query near an address (uses geocoding)

public executeNearAddress(string $address, float $radiusMiles[, bool $sortByDistance = true ]) : array<string|int, mixed>
Parameters
$address : string
$radiusMiles : float
$sortByDistance : bool = true
Return values
array<string|int, mixed>

executeNearAddressKm()

Execute query near an address in kilometers

public executeNearAddressKm(string $address, float $radiusKm[, bool $sortByDistance = true ]) : array<string|int, mixed>
Parameters
$address : string
$radiusKm : float
$sortByDistance : bool = true
Return values
array<string|int, mixed>

getParams()

Get the current parameters (useful for debugging)

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

hybrid()

Get hybrid meetings only

public hybrid() : self
Return values
self

hybridOnly()

Filter to hybrid meetings only

public hybridOnly() : self
Return values
self

inPerson()

Get in-person meetings only

public inPerson() : self
Return values
self

inPersonOnly()

Filter to in-person meetings only

public inPersonOnly() : self
Return values
self

inServiceBody()

Filter by service body ID

public inServiceBody(int $serviceBodyId) : self
Parameters
$serviceBodyId : int
Return values
self

lateNight()

Get late night meetings (after 9 PM)

public lateNight() : self
Return values
self

lunchtime()

Get lunch time meetings (11 AM - 2 PM)

public lunchtime() : self
Return values
self

meditation()

Get meetings with meditation (searches for meditation-related text)

public meditation() : self
Return values
self

morning()

Get morning meetings (before 12 PM)

public morning() : self
Return values
self

nearCoordinates()

Filter by geographic coordinates and radius

public nearCoordinates(Coordinates $coordinates, float $radiusMiles) : self
Parameters
$coordinates : Coordinates
$radiusMiles : float
Return values
self

nearCoordinatesKm()

Filter by geographic coordinates and radius in kilometers

public nearCoordinatesKm(Coordinates $coordinates, float $radiusKm) : self
Parameters
$coordinates : Coordinates
$radiusKm : float
Return values
self

onWeekdays()

Filter meetings by specific weekdays.

public onWeekdays(Weekday|int ...$weekdays) : self
Parameters
$weekdays : Weekday|int

One or more weekdays (1=Sunday, 7=Saturday)

Tags
example 
// Filter for Monday and Friday
$builder->onWeekdays(Weekday::MONDAY, Weekday::FRIDAY);

// Or use integers
$builder->onWeekdays(2, 6); // Monday, Friday
Return values
self —

Returns $this for method chaining

openMeetings()

Get open meetings (searches for open-related text)

public openMeetings() : self
Return values
self

paginate()

Set page size for results

public paginate(int $pageSize[, int $pageNum = 1 ]) : self
Parameters
$pageSize : int
$pageNum : int = 1
Return values
self

searchText()

Search for text in meeting data

public searchText(string $text) : self
Parameters
$text : string
Return values
self

sortByDistance()

Sort results by distance (requires coordinates)

public sortByDistance([bool $sort = true ]) : self
Parameters
$sort : bool = true
Return values
self

speakerMeetings()

Get speaker meetings (searches for speaker-related text)

public speakerMeetings() : self
Return values
self

startingAfter()

Filter meetings starting after specified time

public startingAfter(int $hour[, int $minute = 0 ]) : self
Parameters
$hour : int
$minute : int = 0
Return values
self

startingBefore()

Filter meetings starting before specified time

public startingBefore(int $hour[, int $minute = 0 ]) : self
Parameters
$hour : int
$minute : int = 0
Return values
self

stepMeetings()

Get step meetings (searches for step-related text)

public stepMeetings() : self
Return values
self

thisMorning()

Get this morning's meetings (today + morning)

public thisMorning() : self
Return values
self

thisWeek()

Get this week's meetings

public thisWeek() : self
Return values
self

today()

Get meetings happening today.

public today() : self

Filters meetings to only those occurring on the current day of the week.

Tags
example 
$todaysMeetings = $quickSearch->today()->execute();
Return values
self —

Returns $this for method chaining

todayVirtual()

Combine today + virtual for quick remote access

public todayVirtual() : self
Return values
self

tomorrow()

Get meetings happening tomorrow

public tomorrow() : self
Return values
self

tonight()

Get tonight's meetings (today + evening)

public tonight() : self
Return values
self

virtual()

Get virtual meetings only

public virtual() : self
Return values
self

virtualOnly()

Filter to virtual meetings only

public virtualOnly() : self
Return values
self

weekdays()

Get weekday meetings (Monday through Friday)

public weekdays() : self
Return values
self

weekend()

Get weekend meetings (Saturday and Sunday)

public weekend() : self
Return values
self

weekendInPerson()

Combine weekend + in-person

public weekendInPerson() : self
Return values
self

withFormat()

Filter by format shared ID

public withFormat(int $formatId) : self
Parameters
$formatId : int
Return values
self

withFormats()

Filter by multiple format shared IDs

public withFormats(int ...$formatIds) : self
Parameters
$formatIds : int
Return values
self

withParam()

Add custom parameter

public withParam(string $key, mixed $value) : self
Parameters
$key : string
$value : mixed
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results