Neuron-PHP

IEventRepository

Repository interface for Event entities.

Table of Contents

Methods

all()  : array<string|int, Event>
Get all events
create()  : Event
Create new event
delete()  : bool
Delete event
findById()  : Event|null
Find event by ID
findBySlug()  : Event|null
Find event by slug
getByCategory()  : array<string|int, Event>
Get events by category
getByCreator()  : array<string|int, Event>
Get events by creator
getByDateRange()  : array<string|int, Event>
Get events by date range
getPast()  : array<string|int, Event>
Get past events
getUpcoming()  : array<string|int, Event>
Get upcoming events
incrementViewCount()  : void
Increment view count for an event
slugExists()  : bool
Check if event slug exists (excluding a specific ID)
update()  : Event
Update event

Methods

findBySlug()

Find event by slug

public findBySlug(string $slug) : Event|null
Parameters
$slug : string
Return values
Event|null

getByCategory()

Get events by category

public getByCategory(int $categoryId[, string $status = 'published' ]) : array<string|int, Event>
Parameters
$categoryId : int
$status : string = 'published'

Filter by status (default: 'published')

Return values
array<string|int, Event>

getByCreator()

Get events by creator

public getByCreator(int $userId) : array<string|int, Event>
Parameters
$userId : int
Return values
array<string|int, Event>

getByDateRange()

Get events by date range

public getByDateRange(DateTimeImmutable $startDate, DateTimeImmutable $endDate[, string $status = 'published' ]) : array<string|int, Event>
Parameters
$startDate : DateTimeImmutable
$endDate : DateTimeImmutable
$status : string = 'published'

Filter by status (default: 'published')

Return values
array<string|int, Event>

getPast()

Get past events

public getPast([int|null $limit = null ][, string $status = 'published' ]) : array<string|int, Event>
Parameters
$limit : int|null = null

Maximum number of events to return

$status : string = 'published'

Filter by status (default: 'published')

Return values
array<string|int, Event>

getUpcoming()

Get upcoming events

public getUpcoming([int|null $limit = null ][, string $status = 'published' ]) : array<string|int, Event>
Parameters
$limit : int|null = null

Maximum number of events to return

$status : string = 'published'

Filter by status (default: 'published')

Return values
array<string|int, Event>

incrementViewCount()

Increment view count for an event

public incrementViewCount(Event $event) : void
Parameters
$event : Event

slugExists()

Check if event slug exists (excluding a specific ID)

public slugExists(string $slug[, int|null $excludeId = null ]) : bool
Parameters
$slug : string
$excludeId : int|null = null
Return values
bool

        
On this page

Search results