Documentation

Event extends EntityBase
in package

Event

Tags
copyright

Cloudrexx AG

author

Project Team SS4U info@cloudrexx.com

subpackage

module_calendar

Table of Contents

Properties

$access  : int
$allDay  : bool
$attach  : string
$author  : string
$categories  : Collection
$confirmed  : bool
$emailTemplate  : string
$endDate  : datetime
$eventFields  : Collection
$excludedCrmGroups  : string
$google  : int
$hostMediadirId  : int
$hostType  : bool
$id  : int
$independentSeries  : int
$invitationEmailTemplate  : string
$invitationSent  : int
$invite  : Collection
$invitedCrmGroups  : string
$invitedGroups  : string
$invitedMails  : text
$link  : string
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$locationType  : bool
$nestingCount  : int
Counts the nesting level of __call()
$numSeating  : text
$orgEmail  : string
$orgLink  : string
$orgName  : string
$orgPhone  : string
$orgStreet  : string
$orgWebsite  : string
$orgZip  : string
$pic  : string
$placeId  : int
$placeLink  : string
$placeMap  : string
$placeMediadirId  : int
$placePhone  : string
$placeStreet  : string
$placeWebsite  : string
$placeZip  : string
$price  : int
$priority  : int
$registration  : int
$registrationExternalFullyBooked  : bool
$registrationExternalLink  : string
$registrationForm  : RegistrationForm
$registrationNotification  : string
$registrationNum  : string
$registrations  : Collection
$seriesAdditionalRecurrences  : text
$seriesPatternBegin  : int
$seriesPatternCount  : int
$seriesPatternDay  : int
$seriesPatternDouranceType  : int
$seriesPatternEnd  : int
$seriesPatternEndDate  : datetime
$seriesPatternExceptions  : text
$seriesPatternMonth  : int
$seriesPatternType  : int
$seriesPatternWeek  : int
$seriesPatternWeekday  : string
$seriesStatus  : smallint
$seriesType  : int
$showDetailView  : bool
$showEndDateDetail  : int
$showEndDateList  : int
$showEndTimeDetail  : int
$showEndTimeList  : int
$showIn  : string
$showStartDateDetail  : int
$showStartDateList  : int
$showStartTimeDetail  : int
$showStartTimeList  : int
$showTimeTypeDetail  : int
$showTimeTypeList  : int
$startDate  : datetime
$status  : bool
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$ticketSales  : bool
$type  : int
$useCustomDateDisplay  : bool
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed
Route methods like getName(), getType(), getDirectory(), etc.
__construct()  : mixed
__get()  : mixed
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString()  : string
Returns this entity's identifying value
addCategories()  : mixed
Add a category
addCategory()  : Event
Add categories
addEventField()  : mixed
Add eventFields
addEventFields()  : mixed
Add eventFields
addInvite()  : mixed
Add invites
addRegistration()  : mixed
Add registrations
addRegistrations()  : mixed
Add registrations
getAccess()  : int
Get access
getAllDay()  : bool
Get allDay
getAttach()  : string
Get attach
getAuthor()  : string
Get author
getCategories()  : Collection
Get categories
getComponentController()  : SystemComponent
Returns the component controller for this component
getConfirmed()  : bool
Get confirmed
getEmailTemplate()  : ArrayCollection
Get emailTemplate
getEndDate()  : datetime
Get endDate
getEventFieldByLangId()  : null|EventField
Get EventFieldByLangId
getEventFields()  : Collection
Get eventFields
getExcludedCrmGroups()  : string
Get excludedCrmGroups
getGoogle()  : int
Get google
getHostMediadirId()  : int
Get hostMediadirId
getHostType()  : bool
Get hostType
getId()  : int
Get id
getIndependentSeries()  : smallint
Get independentSeries
getInvitationEmailTemplate()  : ArrayCollection
Get invitationEmailTemplate
getInvitationSent()  : int
Get invitationSent
getInvite()  : Invite
Get invite
getInvitedCrmGroups()  : string
Get invitedCrmGroups
getInvitedGroups()  : string
Get invitedGroups
getInvitedMails()  : text
Get invitedMails
getKeyAsString()  : string
Returns this entity's key
getLink()  : string
Get link
getLocationType()  : bool
Get locationType
getMail()  : ArrayCollection
Get mail
getNumSeating()  : text
Get numSeating
getOrgEmail()  : string
Get orgEmail
getOrgLink()  : string
Get orgLink
getOrgPhone()  : string
Get orgPhone
getOrgStreet()  : string
Get orgStreet
getOrgWebsite()  : string
Get orgWebsite
getOrgZip()  : string
Get orgZip
getPic()  : string
Get pic
getPlaceId()  : int
Get placeId
getPlaceLink()  : string
Get placeLink
getPlaceMap()  : string
Get placeMap
getPlaceMediadirId()  : int
Get placeMediadirId
getPlacePhone()  : string
Get placePhone
getPlaceStreet()  : string
Get placeStreet
getPlaceWebsite()  : string
Get placeWebsite
getPlaceZip()  : string
Get placeZip
getPrice()  : int
Get price
getPriority()  : int
Get priority
getRegistration()  : int
Get registration
getRegistrationExternalFullyBooked()  : string
Get registrationExternalFullyBooked
getRegistrationExternalLink()  : string
Get registrationExternalLink
getRegistrationForm()  : RegistrationForm
Get registrationForm
getRegistrationNotification()  : string
Get registrationNotification
getRegistrationNum()  : string
Get registrationNum
getRegistrations()  : Collection
Get registrations
getSeriesAdditionalRecurrences()  : text
Get seriesAdditionalRecurrences
getSeriesPatternBegin()  : int
Get seriesPatternBegin
getSeriesPatternCount()  : int
Get seriesPatternCount
getSeriesPatternDay()  : int
Get seriesPatternDay
getSeriesPatternDouranceType()  : int
Get seriesPatternDouranceType
getSeriesPatternEnd()  : int
Get seriesPatternEnd
getSeriesPatternEndDate()  : datetime
Get seriesPatternEndDate
getSeriesPatternExceptions()  : text
Get seriesPatternExceptions
getSeriesPatternMonth()  : int
Get seriesPatternMonth
getSeriesPatternType()  : int
Get seriesPatternType
getSeriesPatternWeek()  : int
Get seriesPatternWeek
getSeriesPatternWeekday()  : string
Get seriesPatternWeekday
getSeriesStatus()  : smallint
Get seriesStatus
getSeriesType()  : int
Get seriesType
getShowDetailView()  : bool
Get showDetailView
getShowEndDateDetail()  : int
Get showEndDateDetail
getShowEndDateList()  : int
Get showEndDateList
getShowEndTimeDetail()  : int
Get showEndTimeDetail
getShowEndTimeList()  : int
Get showEndTimeList
getShowIn()  : string
Get showIn
getShowStartDateDetail()  : int
Get showStartDateDetail
getShowStartDateList()  : int
Get showStartDateList
getShowStartTimeDetail()  : int
Get showStartTimeDetail
getShowStartTimeList()  : int
Get showStartTimeList
getShowTimeTypeDetail()  : int
Get showTimeTypeDetail
getShowTimeTypeList()  : int
Get showTimeTypeList
getStartDate()  : datetime
Get startDate
getStatus()  : bool
Get status
getTicketSales()  : bool
Get ticketSales
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
getType()  : int
Get type
getUseCustomDateDisplay()  : bool
Get useCustomDateDisplay
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
removeCategories()  : mixed
Remove categories
removeCategory()  : mixed
Remove categories
removeEventField()  : mixed
Remove eventFields
removeEventFields()  : mixed
Remove eventFields
removeInvite()  : mixed
Remove invite
removeRegistration()  : mixed
Remove registrations
removeRegistrations()  : mixed
Remove registrations
setAccess()  : mixed
Set access
setAllDay()  : mixed
Set allDay
setAttach()  : mixed
Set attach
setAuthor()  : mixed
Set author
setCategories()  : mixed
Set categories
setConfirmed()  : mixed
Set confirmed
setEmailTemplate()  : mixed
Set emailTemplate
setEndDate()  : mixed
Set endDate
setEventFields()  : mixed
Set eventFields
setExcludedCrmGroups()  : mixed
Set excludedCrmGroups
setGoogle()  : mixed
Set google
setHostMediadirId()  : mixed
Set hostMediadirId
setHostType()  : mixed
Set hostType
setIndependentSeries()  : mixed
Set independentSeries
setInvitationEmailTemplate()  : mixed
Set invitationEmailTemplate
setInvitationSent()  : mixed
Set invitationSent
setInvite()  : mixed
Set invite
setInvitedCrmGroups()  : mixed
Set invitedCrmGroups
setInvitedGroups()  : mixed
Set invitedGroups
setInvitedMails()  : mixed
Set invitedMails
setLink()  : mixed
Set link
setLocationType()  : mixed
Set locationType
setNumSeating()  : mixed
Set numSeating
setOrgEmail()  : mixed
Set orgEmail
setOrgLink()  : mixed
Set orgLink
setOrgPhone()  : mixed
Set orgPhone
setOrgStreet()  : mixed
Set orgStreet
setOrgWebsite()  : mixed
Set orgWebsite
setOrgZip()  : mixed
Set orgZip
setPic()  : mixed
Set pic
setPlaceId()  : mixed
Set placeId
setPlaceLink()  : mixed
Set placeLink
setPlaceMap()  : mixed
Set placeMap
setPlaceMediadirId()  : mixed
Set placeMediadirId
setPlacePhone()  : mixed
Set placePhone
setPlaceStreet()  : mixed
Set placeStreet
setPlaceWebsite()  : mixed
Set placeWebsite
setPlaceZip()  : mixed
Set placeZip
setPrice()  : mixed
Set price
setPriority()  : mixed
Set priority
setRegistration()  : mixed
Set registration
setRegistrationExternalFullyBooked()  : mixed
Set registrationExternalFullyBooked
setRegistrationExternalLink()  : mixed
Set registrationExternalLink
setRegistrationForm()  : mixed
Set registrationForm
setRegistrationNotification()  : mixed
Set registrationNotification
setRegistrationNum()  : mixed
Set registrationNum
setRegistrations()  : mixed
Set registrations
setSeriesAdditionalRecurrences()  : mixed
Set seriesAdditionalRecurrences
setSeriesPatternBegin()  : mixed
Set seriesPatternBegin
setSeriesPatternCount()  : mixed
Set seriesPatternCount
setSeriesPatternDay()  : mixed
Set seriesPatternDay
setSeriesPatternDouranceType()  : mixed
Set seriesPatternDouranceType
setSeriesPatternEnd()  : mixed
Set seriesPatternEnd
setSeriesPatternEndDate()  : mixed
Set seriesPatternEndDate
setSeriesPatternExceptions()  : mixed
Set seriesPatternExceptions
setSeriesPatternMonth()  : mixed
Set seriesPatternMonth
setSeriesPatternType()  : mixed
Set seriesPatternType
setSeriesPatternWeek()  : mixed
Set seriesPatternWeek
setSeriesPatternWeekday()  : mixed
Set seriesPatternWeekday
setSeriesStatus()  : mixed
Set seriesStatus
setSeriesType()  : mixed
Set seriesType
setShowDetailView()  : mixed
Set showDetailView
setShowEndDateDetail()  : mixed
Set showEndDateDetail
setShowEndDateList()  : mixed
Set showEndDateList
setShowEndTimeDetail()  : mixed
Set showEndTimeDetail
setShowEndTimeList()  : mixed
Set showEndTimeList
setShowIn()  : mixed
Set showIn
setShowStartDateDetail()  : mixed
Set showStartDateDetail
setShowStartDateList()  : mixed
Set showStartDateList
setShowStartTimeDetail()  : mixed
Set showStartTimeDetail
setShowStartTimeList()  : mixed
Set showStartTimeList
setShowTimeTypeDetail()  : mixed
Set showTimeTypeDetail
setShowTimeTypeList()  : mixed
Set showTimeTypeList
setStartDate()  : mixed
Set startDate
setStatus()  : mixed
Set status
setTicketSales()  : mixed
Set ticketSales
setType()  : mixed
Set type
setUseCustomDateDisplay()  : mixed
Set useCustomDateDisplay
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation

Properties

$excludedCrmGroups

protected string $excludedCrmGroups

$independentSeries

protected int $independentSeries

$invitationEmailTemplate

protected string $invitationEmailTemplate

$invitedCrmGroups

protected string $invitedCrmGroups

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$registrationExternalFullyBooked

protected bool $registrationExternalFullyBooked

$registrationExternalLink

protected string $registrationExternalLink

$registrationForm

protected RegistrationForm $registrationForm

$registrationNotification

protected string $registrationNotification

$seriesAdditionalRecurrences

protected text $seriesAdditionalRecurrences

$seriesPatternBegin

protected int $seriesPatternBegin = 0

$seriesPatternCount

protected int $seriesPatternCount

$seriesPatternDouranceType

protected int $seriesPatternDouranceType

$seriesPatternEndDate

protected datetime $seriesPatternEndDate

$seriesPatternExceptions

protected text $seriesPatternExceptions

$seriesPatternMonth

protected int $seriesPatternMonth

$seriesPatternType

protected int $seriesPatternType

$seriesPatternWeek

protected int $seriesPatternWeek

$seriesPatternWeekday

protected string $seriesPatternWeekday

$showEndDateDetail

protected int $showEndDateDetail

$showEndTimeDetail

protected int $showEndTimeDetail

$showStartDateDetail

protected int $showStartDateDetail

$showStartTimeDetail

protected int $showStartTimeDetail

$showTimeTypeDetail

protected int $showTimeTypeDetail

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$useCustomDateDisplay

protected bool $useCustomDateDisplay

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__call()

Route methods like getName(), getType(), getDirectory(), etc.

public __call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
$methodName : string

Name of method to call

$arguments : array<string|int, mixed>

List of arguments for the method to call

Tags
throws
Exception

If __call() nesting level reaches 20

Return values
mixed —

Return value of the method to call

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.

public __get(mixed $name) : mixed
Parameters
$name : mixed

__toString()

Returns this entity's identifying value

public __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values
string —

Identifying value for this entity

addCategory()

Add categories

public addCategory(Category $categories) : Event
Parameters
$categories : Category
Tags
todo

This method is most likely obsolete as the associated property is named static::$categories

Return values
Event

addEventField()

Add eventFields

public addEventField(EventField $eventField) : mixed
Parameters
$eventField : EventField
Tags
todo

This method is most likely obsolete as the associated property is named static::$eventFields

addEventFields()

Add eventFields

public addEventFields(EventField $eventField) : mixed
Parameters
$eventField : EventField

addInvite()

Add invites

public addInvite(Invite $invite) : mixed
Parameters
$invite : Invite

addRegistration()

Add registrations

public addRegistration(Registration $registration) : mixed
Parameters
$registration : Registration
Tags
todo

This method is most likely obsolete as the associated property is named static::$registrations

addRegistrations()

Add registrations

public addRegistrations(Registration $registration) : mixed
Parameters
$registration : Registration

getAccess()

Get access

public getAccess() : int
Return values
int —

$access

getAllDay()

Get allDay

public getAllDay() : bool
Return values
bool —

$allDay

getAttach()

Get attach

public getAttach() : string
Return values
string —

$attach

getAuthor()

Get author

public getAuthor() : string
Return values
string —

$author

getConfirmed()

Get confirmed

public getConfirmed() : bool
Return values
bool —

$confirmed

getEmailTemplate()

Get emailTemplate

public getEmailTemplate() : ArrayCollection
Return values
ArrayCollection —

$emailTemplate

getEndDate()

Get endDate

public getEndDate() : datetime
Return values
datetime —

$endDate

getEventFieldByLangId()

Get EventFieldByLangId

public getEventFieldByLangId(int $langId) : null|EventField
Parameters
$langId : int

lang id

Return values
null|EventField

getEventFields()

Get eventFields

public getEventFields() : Collection
Return values
Collection —

$eventFields

getExcludedCrmGroups()

Get excludedCrmGroups

public getExcludedCrmGroups() : string
Return values
string —

$excludedCrmGroups

getGoogle()

Get google

public getGoogle() : int
Return values
int —

$google

getHostMediadirId()

Get hostMediadirId

public getHostMediadirId() : int
Return values
int —

$hostMediadirId

getHostType()

Get hostType

public getHostType() : bool
Return values
bool —

$hostType

getId()

Get id

public getId() : int
Return values
int —

$id

getIndependentSeries()

Get independentSeries

public getIndependentSeries() : smallint
Return values
smallint —

$independentSeries

getInvitationEmailTemplate()

Get invitationEmailTemplate

public getInvitationEmailTemplate() : ArrayCollection
Return values
ArrayCollection —

$invitationEmailTemplate

getInvitationSent()

Get invitationSent

public getInvitationSent() : int
Return values
int —

$invitationSent

getInvite()

Get invite

public getInvite() : Invite
Return values
Invite

getInvitedCrmGroups()

Get invitedCrmGroups

public getInvitedCrmGroups() : string
Return values
string —

$invitedCrmGroups

getInvitedGroups()

Get invitedGroups

public getInvitedGroups() : string
Return values
string —

$invitedGroups

getInvitedMails()

Get invitedMails

public getInvitedMails() : text
Return values
text —

$invitedMails

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

getLink()

Get link

public getLink() : string
Return values
string —

$link

getLocationType()

Get locationType

public getLocationType() : bool
Return values
bool —

$locationType

getMail()

Get mail

public getMail(string $mailString) : ArrayCollection
Parameters
$mailString : string
Return values
ArrayCollection —

$emailTemplates

getNumSeating()

Get numSeating

public getNumSeating() : text
Return values
text —

$numSeating

getOrgEmail()

Get orgEmail

public getOrgEmail() : string
Return values
string —

$orgEmail

getOrgLink()

Get orgLink

public getOrgLink() : string
Return values
string —

$orgLink

getOrgPhone()

Get orgPhone

public getOrgPhone() : string
Return values
string —

$orgPhone

getOrgStreet()

Get orgStreet

public getOrgStreet() : string
Return values
string —

$orgStreet

getOrgWebsite()

Get orgWebsite

public getOrgWebsite() : string
Return values
string —

$orgWebsite

getOrgZip()

Get orgZip

public getOrgZip() : string
Return values
string —

$orgZip

getPic()

Get pic

public getPic() : string
Return values
string —

$pic

getPlaceId()

Get placeId

public getPlaceId() : int
Return values
int —

$placeId

getPlaceLink()

Get placeLink

public getPlaceLink() : string
Return values
string —

$placeLink

getPlaceMap()

Get placeMap

public getPlaceMap() : string
Return values
string —

$placeMap

getPlaceMediadirId()

Get placeMediadirId

public getPlaceMediadirId() : int
Return values
int —

$placeMediadirId

getPlacePhone()

Get placePhone

public getPlacePhone() : string
Return values
string —

$placePhone

getPlaceStreet()

Get placeStreet

public getPlaceStreet() : string
Return values
string —

$placeStreet

getPlaceWebsite()

Get placeWebsite

public getPlaceWebsite() : string
Return values
string —

$placeWebsite

getPlaceZip()

Get placeZip

public getPlaceZip() : string
Return values
string —

$placeZip

getPrice()

Get price

public getPrice() : int
Return values
int —

$price

getPriority()

Get priority

public getPriority() : int
Return values
int —

$priority

getRegistration()

Get registration

public getRegistration() : int
Return values
int —

$registration

getRegistrationExternalFullyBooked()

Get registrationExternalFullyBooked

public getRegistrationExternalFullyBooked() : string
Return values
string —

$registrationExternalFullyBooked

getRegistrationExternalLink()

Get registrationExternalLink

public getRegistrationExternalLink() : string
Return values
string —

$registrationExternalLink

getRegistrationForm()

Get registrationForm

public getRegistrationForm() : RegistrationForm
Return values
RegistrationForm —

$registrationForm

getRegistrationNotification()

Get registrationNotification

public getRegistrationNotification() : string
Return values
string —

$registrationNotification

getRegistrationNum()

Get registrationNum

public getRegistrationNum() : string
Return values
string —

$registrationNum

getRegistrations()

Get registrations

public getRegistrations() : Collection
Return values
Collection —

$registrations

getSeriesAdditionalRecurrences()

Get seriesAdditionalRecurrences

public getSeriesAdditionalRecurrences() : text
Return values
text —

$seriesAdditionalRecurrences

getSeriesPatternBegin()

Get seriesPatternBegin

public getSeriesPatternBegin() : int
Return values
int —

$seriesPatternBegin

getSeriesPatternCount()

Get seriesPatternCount

public getSeriesPatternCount() : int
Return values
int —

$seriesPatternCount

getSeriesPatternDay()

Get seriesPatternDay

public getSeriesPatternDay() : int
Return values
int —

$seriesPatternDay

getSeriesPatternDouranceType()

Get seriesPatternDouranceType

public getSeriesPatternDouranceType() : int
Return values
int —

$seriesPatternDouranceType

getSeriesPatternEnd()

Get seriesPatternEnd

public getSeriesPatternEnd() : int
Return values
int —

$seriesPatternEnd

getSeriesPatternEndDate()

Get seriesPatternEndDate

public getSeriesPatternEndDate() : datetime
Return values
datetime —

$seriesPatternEndDate

getSeriesPatternExceptions()

Get seriesPatternExceptions

public getSeriesPatternExceptions() : text
Return values
text —

$seriesPatternExceptions

getSeriesPatternMonth()

Get seriesPatternMonth

public getSeriesPatternMonth() : int
Return values
int —

$seriesPatternMonth

getSeriesPatternType()

Get seriesPatternType

public getSeriesPatternType() : int
Return values
int —

$seriesPatternType

getSeriesPatternWeek()

Get seriesPatternWeek

public getSeriesPatternWeek() : int
Return values
int —

$seriesPatternWeek

getSeriesPatternWeekday()

Get seriesPatternWeekday

public getSeriesPatternWeekday() : string
Return values
string —

$seriesPatternWeekday

getSeriesStatus()

Get seriesStatus

public getSeriesStatus() : smallint
Return values
smallint —

$seriesStatus

getSeriesType()

Get seriesType

public getSeriesType() : int
Return values
int —

$seriesType

getShowDetailView()

Get showDetailView

public getShowDetailView() : bool
Return values
bool —

$showDetailView

getShowEndDateDetail()

Get showEndDateDetail

public getShowEndDateDetail() : int
Return values
int —

$showEndDateDetail

getShowEndDateList()

Get showEndDateList

public getShowEndDateList() : int
Return values
int —

$showEndDateList

getShowEndTimeDetail()

Get showEndTimeDetail

public getShowEndTimeDetail() : int
Return values
int —

$showEndTimeDetail

getShowEndTimeList()

Get showEndTimeList

public getShowEndTimeList() : int
Return values
int —

$showEndTimeList

getShowIn()

Get showIn

public getShowIn() : string
Return values
string —

$showIn

getShowStartDateDetail()

Get showStartDateDetail

public getShowStartDateDetail() : int
Return values
int —

$showStartDateDetail

getShowStartDateList()

Get showStartDateList

public getShowStartDateList() : int
Return values
int —

$showStartDateList

getShowStartTimeDetail()

Get showStartTimeDetail

public getShowStartTimeDetail() : int
Return values
int —

$showStartTimeDetail

getShowStartTimeList()

Get showStartTimeList

public getShowStartTimeList() : int
Return values
int —

$showStartTimeList

getShowTimeTypeDetail()

Get showTimeTypeDetail

public getShowTimeTypeDetail() : int
Return values
int —

$showTimeTypeDetail

getShowTimeTypeList()

Get showTimeTypeList

public getShowTimeTypeList() : int
Return values
int —

$showTimeTypeList

getStartDate()

Get startDate

public getStartDate() : datetime
Return values
datetime —

$startDate

getStatus()

Get status

public getStatus() : bool
Return values
bool —

$status

getTicketSales()

Get ticketSales

public getTicketSales() : bool
Return values
bool —

$ticketSales

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms

public getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

  • Current locale
  • Default locale
  • All other locales
Parameters
$fieldName : string

Name of a translatable field

getType()

Get type

public getType() : int
Return values
int —

$type

getUseCustomDateDisplay()

Get useCustomDateDisplay

public getUseCustomDateDisplay() : bool
Return values
bool —

$useCustomDateDisplay

initializeValidators()

Set $this->validators

public initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

removeCategory()

Remove categories

public removeCategory(Category $categories) : mixed
Parameters
$categories : Category
Tags
todo

This method is most likely obsolete as the associated property is named static::$categories

removeEventField()

Remove eventFields

public removeEventField(EventField $eventFields) : mixed
Parameters
$eventFields : EventField
Tags
todo

This method is most likely obsolete as the associated property is named static::$eventFields

removeRegistration()

Remove registrations

public removeRegistration(Registration $registrations) : mixed
Parameters
$registrations : Registration
Tags
todo

This method is most likely obsolete as the associated property is named static::$registrations

setAccess()

Set access

public setAccess(int $access) : mixed
Parameters
$access : int

setAllDay()

Set allDay

public setAllDay(bool $allDay) : mixed
Parameters
$allDay : bool

setAttach()

Set attach

public setAttach(string $attach) : mixed
Parameters
$attach : string

setAuthor()

Set author

public setAuthor(string $author) : mixed
Parameters
$author : string

setConfirmed()

Set confirmed

public setConfirmed(bool $confirmed) : mixed
Parameters
$confirmed : bool

setEmailTemplate()

Set emailTemplate

public setEmailTemplate(string $emailTemplate) : mixed
Parameters
$emailTemplate : string

setEndDate()

Set endDate

public setEndDate(datetime $endDate) : mixed
Parameters
$endDate : datetime

setEventFields()

Set eventFields

public setEventFields(Collection $eventFields) : mixed
Parameters
$eventFields : Collection

setExcludedCrmGroups()

Set excludedCrmGroups

public setExcludedCrmGroups(string $excludedCrmGroups) : mixed
Parameters
$excludedCrmGroups : string

setGoogle()

Set google

public setGoogle(int $google) : mixed
Parameters
$google : int

setHostMediadirId()

Set hostMediadirId

public setHostMediadirId(int $hostMediadirId) : mixed
Parameters
$hostMediadirId : int

setHostType()

Set hostType

public setHostType(bool $hostType) : mixed
Parameters
$hostType : bool

setIndependentSeries()

Set independentSeries

public setIndependentSeries(smallint $independentSeries) : mixed
Parameters
$independentSeries : smallint

setInvitationEmailTemplate()

Set invitationEmailTemplate

public setInvitationEmailTemplate(string $invitationEmailTemplate) : mixed
Parameters
$invitationEmailTemplate : string

setInvitationSent()

Set invitationSent

public setInvitationSent(int $invitationSent) : mixed
Parameters
$invitationSent : int

setInvite()

Set invite

public setInvite(Invite $invite) : mixed
Parameters
$invite : Invite

setInvitedCrmGroups()

Set invitedCrmGroups

public setInvitedCrmGroups(string $invitedCrmGroups) : mixed
Parameters
$invitedCrmGroups : string

setInvitedGroups()

Set invitedGroups

public setInvitedGroups(string $invitedGroups) : mixed
Parameters
$invitedGroups : string

setInvitedMails()

Set invitedMails

public setInvitedMails(text $invitedMails) : mixed
Parameters
$invitedMails : text

setLink()

Set link

public setLink(string $link) : mixed
Parameters
$link : string

setLocationType()

Set locationType

public setLocationType(bool $locationType) : mixed
Parameters
$locationType : bool

setNumSeating()

Set numSeating

public setNumSeating(text $numSeating) : mixed
Parameters
$numSeating : text

setOrgEmail()

Set orgEmail

public setOrgEmail(string $orgEmail) : mixed
Parameters
$orgEmail : string

setOrgLink()

Set orgLink

public setOrgLink(string $orgLink) : mixed
Parameters
$orgLink : string

setOrgPhone()

Set orgPhone

public setOrgPhone(string $orgPhone) : mixed
Parameters
$orgPhone : string

setOrgStreet()

Set orgStreet

public setOrgStreet(string $orgStreet) : mixed
Parameters
$orgStreet : string

setOrgWebsite()

Set orgWebsite

public setOrgWebsite(string $orgWebsite) : mixed
Parameters
$orgWebsite : string

setOrgZip()

Set orgZip

public setOrgZip(string $orgZip) : mixed
Parameters
$orgZip : string

setPic()

Set pic

public setPic(string $pic) : mixed
Parameters
$pic : string

setPlaceId()

Set placeId

public setPlaceId(int $placeId) : mixed
Parameters
$placeId : int

setPlaceLink()

Set placeLink

public setPlaceLink(string $placeLink) : mixed
Parameters
$placeLink : string

setPlaceMap()

Set placeMap

public setPlaceMap(string $placeMap) : mixed
Parameters
$placeMap : string

setPlaceMediadirId()

Set placeMediadirId

public setPlaceMediadirId(int $placeMediadirId) : mixed
Parameters
$placeMediadirId : int

setPlacePhone()

Set placePhone

public setPlacePhone(string $placePhone) : mixed
Parameters
$placePhone : string

setPlaceStreet()

Set placeStreet

public setPlaceStreet(string $placeStreet) : mixed
Parameters
$placeStreet : string

setPlaceWebsite()

Set placeWebsite

public setPlaceWebsite(string $placeWebsite) : mixed
Parameters
$placeWebsite : string

setPlaceZip()

Set placeZip

public setPlaceZip(string $placeZip) : mixed
Parameters
$placeZip : string

setPrice()

Set price

public setPrice(int $price) : mixed
Parameters
$price : int

setPriority()

Set priority

public setPriority(int $priority) : mixed
Parameters
$priority : int

setRegistration()

Set registration

public setRegistration(int $registration) : mixed
Parameters
$registration : int

setRegistrationExternalFullyBooked()

Set registrationExternalFullyBooked

public setRegistrationExternalFullyBooked(string $registrationExternalFullyBooked) : mixed
Parameters
$registrationExternalFullyBooked : string

setRegistrationExternalLink()

Set registrationExternalLink

public setRegistrationExternalLink(string $registrationExternalLink) : mixed
Parameters
$registrationExternalLink : string

setRegistrationForm()

Set registrationForm

public setRegistrationForm(RegistrationForm $registrationForm) : mixed
Parameters
$registrationForm : RegistrationForm

setRegistrationNotification()

Set registrationNotification

public setRegistrationNotification(string $registrationNotification) : mixed
Parameters
$registrationNotification : string

setRegistrationNum()

Set registrationNum

public setRegistrationNum(string $registrationNum) : mixed
Parameters
$registrationNum : string

setRegistrations()

Set registrations

public setRegistrations(Collection $registrations) : mixed
Parameters
$registrations : Collection

setSeriesAdditionalRecurrences()

Set seriesAdditionalRecurrences

public setSeriesAdditionalRecurrences(text $seriesAdditionalRecurrences) : mixed
Parameters
$seriesAdditionalRecurrences : text

setSeriesPatternBegin()

Set seriesPatternBegin

public setSeriesPatternBegin(int $seriesPatternBegin) : mixed
Parameters
$seriesPatternBegin : int

setSeriesPatternCount()

Set seriesPatternCount

public setSeriesPatternCount(int $seriesPatternCount) : mixed
Parameters
$seriesPatternCount : int

setSeriesPatternDay()

Set seriesPatternDay

public setSeriesPatternDay(int $seriesPatternDay) : mixed
Parameters
$seriesPatternDay : int

setSeriesPatternDouranceType()

Set seriesPatternDouranceType

public setSeriesPatternDouranceType(int $seriesPatternDouranceType) : mixed
Parameters
$seriesPatternDouranceType : int

setSeriesPatternEnd()

Set seriesPatternEnd

public setSeriesPatternEnd(int $seriesPatternEnd) : mixed
Parameters
$seriesPatternEnd : int

setSeriesPatternEndDate()

Set seriesPatternEndDate

public setSeriesPatternEndDate(datetime $seriesPatternEndDate) : mixed
Parameters
$seriesPatternEndDate : datetime

setSeriesPatternExceptions()

Set seriesPatternExceptions

public setSeriesPatternExceptions(text $seriesPatternExceptions) : mixed
Parameters
$seriesPatternExceptions : text

setSeriesPatternMonth()

Set seriesPatternMonth

public setSeriesPatternMonth(int $seriesPatternMonth) : mixed
Parameters
$seriesPatternMonth : int

setSeriesPatternType()

Set seriesPatternType

public setSeriesPatternType(int $seriesPatternType) : mixed
Parameters
$seriesPatternType : int

setSeriesPatternWeek()

Set seriesPatternWeek

public setSeriesPatternWeek(int $seriesPatternWeek) : mixed
Parameters
$seriesPatternWeek : int

setSeriesPatternWeekday()

Set seriesPatternWeekday

public setSeriesPatternWeekday(string $seriesPatternWeekday) : mixed
Parameters
$seriesPatternWeekday : string

setSeriesStatus()

Set seriesStatus

public setSeriesStatus(smallint $seriesStatus) : mixed
Parameters
$seriesStatus : smallint

setSeriesType()

Set seriesType

public setSeriesType(int $seriesType) : mixed
Parameters
$seriesType : int

setShowDetailView()

Set showDetailView

public setShowDetailView(bool $showDetailView) : mixed
Parameters
$showDetailView : bool

setShowEndDateDetail()

Set showEndDateDetail

public setShowEndDateDetail(int $showEndDateDetail) : mixed
Parameters
$showEndDateDetail : int

setShowEndDateList()

Set showEndDateList

public setShowEndDateList(int $showEndDateList) : mixed
Parameters
$showEndDateList : int

setShowEndTimeDetail()

Set showEndTimeDetail

public setShowEndTimeDetail(int $showEndTimeDetail) : mixed
Parameters
$showEndTimeDetail : int

setShowEndTimeList()

Set showEndTimeList

public setShowEndTimeList(int $showEndTimeList) : mixed
Parameters
$showEndTimeList : int

setShowIn()

Set showIn

public setShowIn(string $showIn) : mixed
Parameters
$showIn : string

setShowStartDateDetail()

Set showStartDateDetail

public setShowStartDateDetail(int $showStartDateDetail) : mixed
Parameters
$showStartDateDetail : int

setShowStartDateList()

Set showStartDateList

public setShowStartDateList(int $showStartDateList) : mixed
Parameters
$showStartDateList : int

setShowStartTimeDetail()

Set showStartTimeDetail

public setShowStartTimeDetail(int $showStartTimeDetail) : mixed
Parameters
$showStartTimeDetail : int

setShowStartTimeList()

Set showStartTimeList

public setShowStartTimeList(int $showStartTimeList) : mixed
Parameters
$showStartTimeList : int

setShowTimeTypeDetail()

Set showTimeTypeDetail

public setShowTimeTypeDetail(int $showTimeTypeDetail) : mixed
Parameters
$showTimeTypeDetail : int

setShowTimeTypeList()

Set showTimeTypeList

public setShowTimeTypeList(int $showTimeTypeList) : mixed
Parameters
$showTimeTypeList : int

setStartDate()

Set startDate

public setStartDate(datetime $startDate) : mixed
Parameters
$startDate : datetime

setStatus()

Set status

public setStatus(bool $status) : mixed
Parameters
$status : bool

setTicketSales()

Set ticketSales

public setTicketSales(bool $ticketSales) : mixed
Parameters
$ticketSales : bool

setType()

Set type

public setType(int $type) : mixed
Parameters
$type : int

setUseCustomDateDisplay()

Set useCustomDateDisplay

public setUseCustomDateDisplay(bool $useCustomDateDisplay) : mixed
Parameters
$useCustomDateDisplay : bool

setVirtual()

Set the virtuality of the entity

public setVirtual(bool $virtual) : mixed
Parameters
$virtual : bool

TRUE to set the entity as virtual or otherwise to FALSE

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results