API Location (Hotspots aware)

since 6.0.10
package MatukioEvents
inherited_from \MatukioApi

 Methods

Get all locations

_() : array

index.php?option=com_matukio&view=api&request=location

since 6.0.10

Returns

array

MatukioApiLocation constructor.

__construct($config = array()
since 6.0.10

Parameters

$config

Load locations

loadLocations(string $search = null, integer $offset = 0, integer $limit = 0) : mixed
since 6.0.10

Parameters

$search

string

Search

$offset

integer

Offset if any

$limit

integer

The limit

Returns

mixed

Search for hotspots locations on title

searchHotspotsLocationTitle(string $search = null, integer $offset = 0, integer $limit = 0) : mixed
since 6.0.10

Parameters

$search

string

Search

$offset

integer

Offset if any

$limit

integer

The limit

Returns

mixed

Search for locations on title

searchLocationTitle(string $search = null, integer $offset = 0, integer $limit = 0) : mixed
since 6.0.10

Parameters

$search

string

Search

$offset

integer

Offset if any

$limit

integer

The limit

Returns

mixed

 Properties

 

Are the locations from hotspots

$isHotspots : boolean

Default

false
since 6.0.10
 

Array of locations

$locations : array

Default

array()
since 6.0.10