Matukio Events 7.0 API for Joomla » \MatukioHelperRecurring

Methods

Class MatukioHelperRecurring

since	3.1.0
package	MatukioEvents

Methods

Cancels an recurring event and notfies (if enabled) all participants

cancelRecurringEvents(array $ids, integer $cancelled) : boolean

Static

Parameters

$ids

array

Array of recurring events

$cancelled

integer

Should it be cancelled or reactivated?

Exceptions

`\Exception`	on Error

Returns

boolean

Confirms (notfies organizer + participants) an event

confirmRecurringEvent(object $event) : boolean

Static

Parameters

$event

object

An recurring event

Exceptions

`\Exception`	on Error

Returns

boolean

Deletes recurring events of an event incl. notifications

deleteEventsRecurringEvents(integer $event_id) : Null

Static

Parameters

$event_id

integer

The event id

Exceptions

`\Exception`

Returns

Null

Publish or unpublish the recurring events

deleteRecurringEvents(array $ids) : boolean

Static

since	7.0.0

Parameters

$ids

array

Ids of the recurring events

Exceptions

`\Exception`

Returns

boolean

Get the EVENT id for the Recurring Date!

getEventIdForDateId(integer $rId) : integer | null

Static

since	7.0.0

Parameters

$rId

integer

The recurring Id

Returns

integernull

Gets the recurring dates (limit inc) for the given event id

getRecurringDates(integer $eventId, integer $begin = 2, integer $limit = 10, string $orderby = "r.begin ASC", integer $limitstart = 0) : array

Static

Parameters

$eventId

integer

The event id

$begin

integer

2 = future events, 0 = all events

$limit

integer

limit default is 10

$orderby

string

order by

$limitstart

integer

limit start default is 0

Returns

array- of objects (db rows)

Get only Matukio Recurring Dates data

getRecurringDatesMinimal(integer $eventId, string $begin = 'future', integer $offset = 0, integer $limit = 10, string $orderBy = 'r.begin ASC') : mixed

Static

since	7.0.0

Parameters

$eventId

integer

Event Id (Not Recurring)

$begin

string

Begin

$offset

integer

Offset

$limit

integer

Limit

$orderBy

string

Order By

Returns

mixed

Get the recurring table only (Joined with Location!)

getRecurringTableOnly(integer $eventId, integer $begin = 0, integer $limit = 10, string $orderby = 'begin ASC', integer $limitstart = 0) : mixed

Static

since	6.10

Parameters

$eventId

integer

$begin

integer

$limit

integer

$orderby

string

$limitstart

integer

Returns

mixed

Publish or unpublish the recurring events

publishRecurringEvents(array $ids, integer $publish) : boolean

Static

since	7.0.0

Parameters

$ids

array

Ids of the recurring events

$publish

integer

Publish or unpublish them

Exceptions

`\Exception`

Returns

boolean

Saves the recurring date

saveRecurring(boolean $frontend = false) : string

Static

Parameters

$frontend

boolean

Are we in the frontend?

Exceptions

`\Exception`	on db error

Returns

string- (id of the recurring date)

Saves a new recurring date for the given event

saveRecurringDateForEvent(object $row) : mixed

Static

deprecated	Events don't have a begin anymore

Parameters

$row

object

The event

Exceptions

`\Exception`

Returns

mixed