Class Aurora\Modules\Calendar\Manager

`extends`	`AbstractManagerWithStorage`


					
	public

__construct(AbstractModule $oModule = null)

Overrides

Aurora\System\Managers\AbstractManagerWithStorage::__construct()

#


					
	public

getCalendarAccess(string $sUserUUID, string $sCalendarId): bool

Determines whether read/write or read-only permissions are set for accessing calendar from this account.

Parameters

`$sUserUUID`	Account object
`$sCalendarId`	Calendar ID

Returns

ECalendarPermission::Write or ECalendarPermission::Read accordingly.

#


					
	public

getTenantAccount(Account $oAccount): Account|false

Returns

$oAccount

#


					
	public

getPublicCalendarByHash(string $sHash): Calendar|false

Returns

$oCalendar

#


					
	public

getPublicCalendar(string $sCalendarId): Calendar|false

Returns

$oCalendar

#


					
	public

getCalendar(int $sUserPublicId, string $sCalendarId): Calendar|false

Loads calendar.

Parameters

$sCalendarId

Calendar ID

Returns

$oCalendar

#


					
	public

getPublicCalendarHash(string $sCalendarId): string|false

#


					
	public

getCalendarUsers(string $sUserPublicId, Calendar $oCalendar): array|bool

(Aurora only) Returns list of user account the calendar was shared with.

Parameters

$oCalendar

Calendar object

#


					
	public

getPublicUser(): string|bool

#


					
	public

getTenantUser($oUser = null): string|bool

#


					
	public

getPublicAccount(): Account|false

Returns

$oAccount

#


					
	public

getUserCalendars(string $sUserPublicId): array

Returns list of calendars for the account.

#


					
	public

createCalendar(
	string $sUserPublicId,
	string $sName,
	string $sDescription,
	int $iOrder,
	string $sColor,
	$sUUID = null,
): Calendar|false

Creates new calendar.

Parameters

`$sName`	Name of the calendar
`$sDescription`	Description of the calendar
`$iOrder`	Ordinal number of the calendar in calendars list
`$sColor`	Color code

#


					
	public

validateSubscribedCalebdarSource($sSource)

#


					
	public

createSubscribedCalendar($sUserPublicId, $sName, $sSource, $iOrder, $sColor, $sUUID = null)

#


					
	public

updateCalendar(
	string $sUserPublicId,
	string $sCalendarId,
	string $sName,
	string $sDescription,
	int $iOrder,
	string $sColor,
): Calendar|false

Updates calendar properties.

Parameters

`$sCalendarId`	Calendar ID
`$sName`	Name of the calendar
`$sDescription`	Description of the calendar
`$iOrder`	Ordinal number of the calendar in calendars list
`$sColor`	Color code

#


					
	public

updateSubscribedCalendar(
	string $sUserPublicId,
	string $sCalendarId,
	string $sName,
	$sSource,
	int $iOrder,
	string $sColor,
): Calendar|false

Updates calendar properties.

Parameters

`$sCalendarId`	Calendar ID
`$sName`	Name of the calendar
`$iOrder`	Ordinal number of the calendar in calendars list
`$sColor`	Color code

#


					
	public

updateCalendarVisible(string $sCalendarId, int $iVisible): bool

#


					
	public

updateCalendarColor(string $sUserPublicId, string $sCalendarId, string $sColor): bool

Change color of the calendar.

Parameters

`$sCalendarId`	Calendar ID
`$sColor`	New color code

#


					
	public

deletePrincipalCalendars($sUserPublicId)

#


					
	public

deleteCalendar(string $sUserPublicId, string $sCalendarId): bool

Deletes calendar.

Parameters

$sCalendarId

Calendar ID

#


					
	public

unsubscribeCalendar(string $sUserPublicId, string $sCalendarId): bool

Removes calendar from list of those shared with the specific account. [Aurora only.](http://dev.afterlogic.com/aurora)

Removes calendar from list of those shared with the specific account. Aurora only.

Parameters

`$sUserPublicId`	Account object
`$sCalendarId`	Calendar ID

#


					
	public

updateCalendarShareToAll(string $sUserPublicId, string $sCalendarId, bool $bShareToAll, int $iPermission): bool

(Aurora only) Share or remove sharing calendar with all users.

Parameters

`$sCalendarId`	Calendar ID
`$bShareToAll`	If set to true, add sharing; if false, sharing is removed
`$iPermission`	Permissions set for the account. Accepted values: - ECalendarPermission::Read (read-only access); - ECalendarPermission::Write (read/write access); - ECalendarPermission::RemovePermission (effectively removes sharing with the account).

#


					
	public

updateCalendarShares(string $sUserPublicId, string $sCalendarId, array $aShares): bool

(Aurora only) Share or remove sharing calendar with the listed users.

Parameters

`$sCalendarId`	Calendar ID
`$aShares`	Array defining list of users and permissions. Each array item needs to have the following keys: ["email"] - email which denotes user the calendar is shared to; ["access"] - permission settings equivalent to those used in updateCalendarShare method.

#


					
	public

publicCalendar(string $sUserPublicId, string $sCalendarId, bool $bIsPublic = false, $oUser = null): bool

Set/unset calendar as public.

Parameters

`$sUserPublicId`	Account object
`$sCalendarId`	Calendar ID
`$bIsPublic`	If set to true, calendar is made public; if false, setting as public gets cancelled

#


					
	public

getPublishStatus(string $sCalendarId): bool

Set/unset calendar as public.

Parameters

$sCalendarId

Calendar ID

#


					
	public

updateCalendarShare(string $sUserPublicId, string $sCalendarId, string $sUserId, int $iPermission): bool

Share or remove sharing calendar with the specific user account. [Aurora only.](http://dev.afterlogic.com/aurora)

Share or remove sharing calendar with the specific user account. Aurora only.

Parameters

`$sUserPublicId`	Account object
`$sCalendarId`	Calendar ID
`$sUserId`	User Id
`$iPermission`	Permissions set for the account. Accepted values: - ECalendarPermission::Read (read-only access); - ECalendarPermission::Write (read/write access); - ECalendarPermission::RemovePermission (effectively removes sharing with the account).

#


					
	public

exportCalendarToIcs(string $sUserPublicId, string $sCalendarId): string|bool

Returns calendar data as ICS data.

Parameters

$sCalendarId

Calendar ID

#


					
	public

importToCalendarFromIcs(string $sUserPublicId, string $sCalendarId, string $sTempFileName): int|bool

Populates calendar from .ICS file.

Parameters

`$sCalendarId`	Calendar ID
`$sTempFileName`	.ICS file name data are imported from

Returns

integer (number of events added)

#


					
	public

getEvents(string $sUserUUID, array|string $mCalendarId, string $dStart = null, string $dFinish = null): array|bool

Account object

Parameters

`$mCalendarId`	Calendar ID
`$dStart`	Date range start
`$dFinish`	Date range end

#


					
	public

getPublicEvents(
	array|string $mCalendarId,
	string $dStart = null,
	string $dFinish = null,
	$bExpand = true,
	$sDefaultTimeZone = null,
): array|bool

Parameters

`$mCalendarId`	Calendar ID
`$dStart`	Date range start
`$dFinish`	Date range end

#


					
	public

getTasks(
	string $sUserPublicId,
	array|string $mCalendarId,
	$bCompeted = true,
	$sSearch = '',
	string $dStart = null,
	string $dFinish = null,
	$bExpand = true,
): array|bool

Account object

Parameters

`$mCalendarId`	Calendar ID
`$dStart`	Date range start
`$dFinish`	Date range end

#


					
	public

getEventsInfo(
	string $sUserPublicId,
	mixed $mCalendarId,
	object $dStart = null,
	object $dEnd = null,
	bool $bGetData = false,
): string

Parameters

$sUserPublicId

Account object

#


					
	public

getEvent(string $sUserPublicId, string $sCalendarId, string $sEventId): array|bool

Return specific event.

Parameters

`$sCalendarId`	Calendar ID
`$sEventId`	Event ID

#


					
	public

getBaseEvent(string $sUserPublicId, string $sCalendarId, string $sEventId): array|bool

For recurring event, gets a base one.

Parameters

`$sCalendarId`	Calendar ID
`$sEventId`	Event ID

#


					
	public

getExpandedEvent(
	string $sUserPublicId,
	string $sCalendarId,
	string $sEventId,
	string $dStart = null,
	string $dEnd = null,
): array|bool

For recurring event, gets all occurences within a date range.

Parameters

`$sCalendarId`	Calendar ID
`$sEventId`	Event ID
`$dStart`	Date range start
`$dEnd`	Date range end

#


					
	public

createEventFromRaw(string $sUserPublicId, string $sCalendarId, string $sEventId, array $sData): mixed

#


					
	public

createEvent(string $sUserPublicId, Event $oEvent): mixed

Creates event from event object.

Parameters

$oEvent

Event object

#


					
	public

updateEvent(string $sUserPublicId, Event $oEvent): bool

Update events using event object.

Parameters

$oEvent

Event object

#


					
	public

updateEventRaw(string $sUserPublicId, string $sCalendarId, string $sEventUrl, string $sData): bool

#


					
	public

moveEvent(string $sUserPublicId, string $sCalendarId, string $sCalendarIdNew, string $sEventId): bool

Moves event to a different calendar.

Parameters

`$sCalendarId`	Current calendar ID
`$sCalendarIdNew`	New calendar ID
`$sEventId`	Event ID

#


					
	public

updateEventGroupByMoving(string $sCalendarId, string $sEventId, string $sNewCalendarId)

#


					
	public

updateExclusion(string $sUserPublicId, Event $oEvent, string $sRecurrenceId, bool $bDelete = false): bool

Updates or deletes exclusion from recurring event.

Parameters

`$oEvent`	Event object
`$sRecurrenceId`	Recurrence ID
`$bDelete`	If true, exclusion is deleted

#


					
	public

deleteExclusion(string $sUserPublicId, string $sCalendarId, string $sEventId, string $iRecurrenceId): bool

deleteExclusion

Parameters

`$sUserPublicId`	Account object
`$sCalendarId`	Calendar ID
`$sEventId`	Event ID
`$iRecurrenceId`	Recurrence ID

#


					
	public

getReminders(int $start = null, int $end = null): array|bool

#


					
	public

deleteReminder(string $sEventId): bool

#


					
	public

deleteReminderByCalendar(string $sCalendarUri): bool

#


					
	public

updateReminder(string $sEmail, string $sCalendarUri, string $sEventId, string $sData): bool

#


					
	public

getDefaultCalendar(string $sUserPublicId): Calendar|false

Returns default calendar of the account.

Returns

$oCalendar

#


					
	public

getCalendars(string $sUserPublicId): bool

#


					
	public

getSharedCalendars($sUserPublicId)

#


					
	public

deleteEvent(string $sUserPublicId, string $sCalendarId, string $sEventId): bool

Deletes event.

Parameters

`$sCalendarId`	Calendar ID
`$sEventId`	Event ID

#


					
	public

deleteEventByUrl(string $sUserPublicId, string $sCalendarId, string $sEventUrl): bool

Deletes event.

Parameters

`$sCalendarId`	Calendar ID
`$sEventUrl`	Event URL

#


					
	public

processICS(string $sUserPublicId, string $sData, string $mFromEmail, bool $bUpdateAttendeeStatus = false): array|bool

#


					
	public

getAccountFromAccountList(Account $oAccount, string $sEmail): Account|false

Returns

$oAccount

#


					
	public

clearAllCalendars(string $sUserPublicId): bool

#

Namespaces

Classes

Overrides

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns