EventBaseRepository
extends AbstractSearchableRepository
in package
Table of Contents
- __construct() : mixed
- create() : array<string|int, mixed>|null
- fetchCollection() : Collection
- fetchSingle() : array<string|int, mixed>|null
- findAll() : Collection
- Returns a collection of all items in the collection
- findAllWithEvents() : Collection
- Returns a collection of all event bases including their event records
- findById() : array<string|int, mixed>
- Returns a single event base having child relations expanded.
- findBySearchPhrase() : Collection
- Returns a collection of items, matched by a given search phrase.
- findBySlug() : array<string|int, mixed>
- Returns a single event base having child relations expanded.
- getClient() : RestClient
- getEndpointPath() : string
- setClient() : Repository
Methods
__construct()
public
__construct(RestClient $client) : mixed
Parameters
- $client : RestClient
Return values
mixed —create()
public
create([array<string|int, mixed> $data = [] ]) : array<string|int, mixed>|null
Parameters
- $data : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null —fetchCollection()
public
fetchCollection([array<string|int, mixed> $params = [] ][, array<string|int, mixed> $overrideParams = [] ]) : Collection
Parameters
- $params : array<string|int, mixed> = []
- $overrideParams : array<string|int, mixed> = []
Return values
Collection —fetchSingle()
public
fetchSingle(mixed $idOrSlug[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $overrideParams = [] ]) : array<string|int, mixed>|null
Parameters
- $idOrSlug : mixed
- $params : array<string|int, mixed> = []
- $overrideParams : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null —findAll()
Returns a collection of all items in the collection
public
findAll([array<string|int, mixed> $params = [] ]) : Collection
Parameters
- $params : array<string|int, mixed> = []
-
Optional query parameters to filter the results
Return values
Collection —The collection of items
findAllWithEvents()
Returns a collection of all event bases including their event records
public
findAllWithEvents([array<string|int, mixed> $params = [] ]) : Collection
Parameters
- $params : array<string|int, mixed> = []
-
Optional query parameters to filter the results
Return values
Collection —The collection of event bases
findById()
Returns a single event base having child relations expanded.
public
findById(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $id : int
-
The unique ID of the event base
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed> —The event base as array or NULL, if matching event base was not found
findBySearchPhrase()
Returns a collection of items, matched by a given search phrase.
public
findBySearchPhrase(string $searchPhrase[, array<string|int, mixed> $params = [] ]) : Collection
Parameters
- $searchPhrase : string
-
The search phrase
- $params : array<string|int, mixed> = []
-
Optional query parameters to filter the results
Return values
Collection —The collection of items
findBySlug()
Returns a single event base having child relations expanded.
public
findBySlug(string $slug[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $slug : string
-
The unique slug of the event base
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed> —The event base as array or NULL, if matching event base was not found
getClient()
public
getClient() : RestClient
Return values
RestClient —getEndpointPath()
public
static getEndpointPath() : string
Return values
string —setClient()
public
setClient(RestClient $client) : Repository
Parameters
- $client : RestClient