*
* Generated from xml/schema/CRM/Event/Event.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:51b2702ee6856d74a9f38e9cf86da5bf)
+ * (GenCodeChecksum:894f53608aa8036de5fab1dc90a407d5)
*/
/**
/**
* Event
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $id;
/**
* Event Title (e.g. Fall Fundraiser Dinner)
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $title;
/**
* Brief summary of event. Text and html allowed. Displayed on Event Registration form and can be used on other CMS pages which need an event summary.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $summary;
/**
* Full description of event. Text and html allowed. Displayed on built-in Event Information screens.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $description;
/**
* Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $event_type_id;
/**
* Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $participant_listing_id;
/**
* Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_public;
/**
* Date and time that event starts.
*
- * @var datetime
+ * @var string|null
+ * (SQL type: datetime)
+ * Note that values will be retrieved from the database as a string.
*/
public $start_date;
/**
* Date and time that event ends. May be NULL if no defined end date/time
*
- * @var datetime
+ * @var string|null
+ * (SQL type: datetime)
+ * Note that values will be retrieved from the database as a string.
*/
public $end_date;
/**
* If true, include registration link on Event Info page.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_online_registration;
/**
* Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $registration_link_text;
/**
* Date and time that online registration starts.
*
- * @var datetime
+ * @var string|null
+ * (SQL type: datetime)
+ * Note that values will be retrieved from the database as a string.
*/
public $registration_start_date;
/**
* Date and time that online registration ends.
*
- * @var datetime
+ * @var string|null
+ * (SQL type: datetime)
+ * Note that values will be retrieved from the database as a string.
*/
public $registration_end_date;
/**
* Maximum number of registered participants to allow. After max is reached, a custom Event Full message is displayed. If NULL, allow unlimited number of participants.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $max_participants;
/**
* Message to display on Event Information page and INSTEAD OF Event Registration form if maximum participants are signed up. Can include email address/info about getting on a waiting list, etc. Text and html allowed.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $event_full_text;
/**
* If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_monetary;
/**
* Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $financial_type_id;
/**
* Payment Processors configured for this Event (if is_monetary is true)
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(128))
+ * Note that values will be retrieved from the database as a string.
*/
public $payment_processor;
/**
* Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_map;
/**
* Is this Event enabled or disabled/cancelled?
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_active;
/**
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $fee_label;
/**
* If true, show event location.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_show_location;
/**
* FK to Location Block ID
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $loc_block_id;
/**
* Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $default_role_id;
/**
* Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $intro_text;
/**
* Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $footer_text;
/**
* Title for Confirmation page.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $confirm_title;
/**
* Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $confirm_text;
/**
* Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $confirm_footer_text;
/**
* If true, confirmation is automatically emailed to contact on successful registration.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_email_confirm;
/**
* text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $confirm_email_text;
/**
* FROM email name used for confirmation emails.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $confirm_from_name;
/**
* FROM email address used for confirmation emails.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $confirm_from_email;
/**
* comma-separated list of email addresses to cc each time a confirmation is sent
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $cc_confirm;
/**
* comma-separated list of email addresses to bcc each time a confirmation is sent
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $bcc_confirm;
/**
* FK to civicrm_option_value.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $default_fee_id;
/**
* FK to civicrm_option_value.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $default_discount_fee_id;
/**
* Title for ThankYou page.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $thankyou_title;
/**
* ThankYou Text.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $thankyou_text;
/**
* Footer message.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $thankyou_footer_text;
/**
* if true - allows the user to send payment directly to the org later
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_pay_later;
/**
* The text displayed to the user in the main form
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $pay_later_text;
/**
* The receipt sent to the user instead of the normal receipt text
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $pay_later_receipt;
/**
* is partial payment enabled for this event
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_partial_payment;
/**
* Initial amount label for partial payment
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $initial_amount_label;
/**
* Initial amount help text for partial payment
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $initial_amount_help_text;
/**
* Minimum initial amount for partial payment
*
- * @var float
+ * @var float|string|null
+ * (SQL type: decimal(20,2))
+ * Note that values will be retrieved from the database as a string.
*/
public $min_initial_amount;
/**
* if true - allows the user to register multiple participants for event
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_multiple_registrations;
/**
* Maximum number of additional participants that can be registered on a single booking
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $max_additional_participants;
/**
* if true - allows the user to register multiple registrations from same email address.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $allow_same_participant_emails;
/**
* Whether the event has waitlist support.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $has_waitlist;
/**
* Whether participants require approval before they can finish registering.
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $requires_approval;
/**
* Expire pending but unconfirmed registrations after this many hours.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $expiration_time;
/**
* Allow self service cancellation or transfer for event?
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $allow_selfcancelxfer;
/**
* Number of hours prior to event start date to allow self-service cancellation or transfer.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int)
+ * Note that values will be retrieved from the database as a string.
*/
public $selfcancelxfer_time;
/**
* Text to display when the event is full, but participants can signup for a waitlist.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $waitlist_text;
/**
* Text to display when the approval is required to complete registration for an event.
*
- * @var text
+ * @var string|null
+ * (SQL type: text)
+ * Note that values will be retrieved from the database as a string.
*/
public $approval_req_text;
/**
* whether the event has template
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_template;
/**
* Event Template Title
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(255))
+ * Note that values will be retrieved from the database as a string.
*/
public $template_title;
/**
* FK to civicrm_contact, who created this event
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $created_id;
/**
* Date and time that event was created.
*
- * @var datetime
+ * @var string|null
+ * (SQL type: datetime)
+ * Note that values will be retrieved from the database as a string.
*/
public $created_date;
/**
* 3 character string, value from config setting or input via user.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(3))
+ * Note that values will be retrieved from the database as a string.
*/
public $currency;
/**
* The campaign for which this event has been created.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $campaign_id;
/**
* Can people share the event through social media?
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_share;
/**
* If false, the event booking confirmation screen gets skipped
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_confirm_enabled;
/**
* Implicit FK to civicrm_event: parent event
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $parent_event_id;
/**
* Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $slot_label_id;
/**
* Rule to use when matching registrations for this event
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $dedupe_rule_group_id;
/**
* if true than billing block is required this event
*
- * @var bool
+ * @var bool|string|null
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_billing_required;
projects / civicrm-core.git / blobdiff