Documentation

Calendar extends CalendarLibrary

in package

• cloudrexx
• module
• calendar

Calendar

Tags

subpackage

module_calendar

author

Cloudrexx info@cloudrexx.com

copyright

CLOUDREXX CMS - CLOUDREXX AG

version

1.00

Table of Contents

Constants

ATTACHMENT_FIELD_KEY  = 'attachment_id'

Attachment field key

MAP_FIELD_KEY  = 'map_id'

map field key

PICTURE_FIELD_KEY  = 'picture_id'

Picture field key

SHOW_EVENTS_OF_TODAY  = 0

Setting value for option frontendPastEvents defining that all events having their start date as of today shall be listed in frontend till the end of today.

SHOW_EVENTS_UNTIL_END  = 1

Setting value for option frontendPastEvents defining that only those events shall be listed in frontend that have not yet ended (end date lies in the past)

SHOW_EVENTS_UNTIL_START  = 2

Setting value for option frontendPastEvents defining that only those events shall be listed in frontend that have not yet started (start date lies in the future)

Properties

$_objTpl  : object

Template object

$arrCommunityGroups  : array<string|int, mixed>

Community group array

$arrFrontendLanguages  : array<string|int, mixed>

active frontend languages

$arrSettings  : array<string|int, mixed>

Settings array

$boxCount  : int

Event Box count

$csvSeparator  : string

CSV separator

$errMessage  : string

Error message

$metaTitle  : string

meta title

$moduleLangVar  : string

module language variable prefix

$moduleName  : string

module name

$moduleTablePrefix  : string

module table prefix

$okMessage  : type

Success message

$pageContent  : string

template content

$settings  : array<string|int, mixed>

Static settings array to cache the fetched data from the database

$cx  : Cx

$em  : EntityManager

$objEventManager  : object

Event manager object

$simulateCategoryView  : bool

When using the ID of a category, we will simulate as if cmd=category has been requested

$submissionId  : int

An id unique per form submission and user.

$author  : string

Author name

$categoryId  : int

Category id

$endDate  : int

End date Unix timestamp

$needAuth  : bool

Need authorization

$numEvents  : int

Number of events per page

$searchTerm  : string

Search term

$sortDirection  : string

Sort direction

$startDate  : int

Start date

$startPos  : int

Start position

Methods

__construct()  : mixed

Constructor

boxesEventList()  : null

Performs the list box view

checkAccess()  : null

Checks the access level for the given action

detachEntity()  : null

Detach the entity

detachJoinedEntity()  : null

Detach the jointed entity

format2userDate()  : string

Returns the date string (according to the calendar's configuration) from a \DateTime object.

format2userDateTime()  : string

Returns the date/time string (according to the calendar's configuration) from a \DateTime object.

format2userTime()  : string

Returns the time string 'H:i' from a \DateTime object

formatDateTime2user()  : string

Returns a date/time string from a \DateTime object.

generateKey()  : string

generates the random key

getCalendarPage()  : null

Performs the calendar page

getCommunityGroups()  : null

Initilize the available group

getComponent()  : SystemComponentController

Get component controller object

getDateFormat()  : string

Return's the dataformat based on the type

getDateTime()  : DateTime

Returns a \DateTime object from a calendar date/time string.

getDbDateTimeFromIntern()  : DateTime

Returns a \DateTime object in db timezone

getEventManager()  : mixed

Get the Event manager

getExeceptionDates()  : array<string|int, mixed>

Returns all series dates based on the given post data

getFrontendLanguages()  : null

Initialize the active frontend languages array

getHeadlinePlaceholders()  : array<string|int, mixed>

Get the list of calendar headline placeholders

getInternDateTimeFromDb()  : DateTime

Returns a \DateTime object from a date/time string.

getInternDateTimeFromUser()  : DateTime

Returns a \DateTime object from a date/time string.

getJavascript()  : string

Return's the billing address javascript

getSettings()  : null

Prepares the settings from database to array format

getUserDateTimeFromIntern()  : DateTime

Returns a \DateTime object in user timezone

init()  : mixed

Initialize $cx and $em

loadEventManager()  : null

Loads the event manager

modifyEvent()  : null

Add / Edit Event

myEvents()  : null

performs the my events page

overview()  : null

performs the overview page

showCategoryView()  : null

set the placeholders for the category view

showRegistrationForm()  : null

performs the registratio page

showSuccessPage()  : null

Display the success page

showThreeBoxes()  : null

Performs the box view

triggerEvent()  : null

Trigger the event

uploadFinished()  : array<string|int, mixed>

Uploader callback function

getUploaderCode()  : string

Get uploader code

parseDateTimeString()  : array<string|int, mixed>

Split a datetime string (i.E.: '08.06.2015 13:37') into an array containing the date, hour and minutes information as separate elements.

showEvent()  : null

Performs the Event details page

array(
     d.m.Y,
     G,
     m
)