From 28979d65643a0f0907a0ba20b1cd2cca889d5c2c Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sun, 23 Jan 2022 14:27:37 -0500 Subject: [PATCH] Regenerate DAO files with improved var docblocks --- CRM/ACL/DAO/ACL.php | 42 ++- CRM/ACL/DAO/ACLCache.php | 18 +- CRM/ACL/DAO/ACLEntityRole.php | 20 +- CRM/Activity/DAO/Activity.php | 110 +++++-- CRM/Activity/DAO/ActivityContact.php | 18 +- CRM/Batch/DAO/Batch.php | 70 +++-- CRM/Batch/DAO/EntityBatch.php | 18 +- CRM/Campaign/DAO/Campaign.php | 68 +++-- CRM/Campaign/DAO/CampaignGroup.php | 22 +- CRM/Campaign/DAO/Survey.php | 80 +++-- CRM/Case/DAO/Case.php | 42 ++- CRM/Case/DAO/CaseActivity.php | 14 +- CRM/Case/DAO/CaseContact.php | 14 +- CRM/Case/DAO/CaseType.php | 30 +- CRM/Contact/DAO/ACLContactCache.php | 16 +- CRM/Contact/DAO/Contact.php | 210 +++++++++---- CRM/Contact/DAO/ContactType.php | 32 +- CRM/Contact/DAO/DashboardContact.php | 26 +- CRM/Contact/DAO/Group.php | 90 ++++-- CRM/Contact/DAO/GroupContact.php | 26 +- CRM/Contact/DAO/GroupContactCache.php | 14 +- CRM/Contact/DAO/GroupNesting.php | 14 +- CRM/Contact/DAO/GroupOrganization.php | 14 +- CRM/Contact/DAO/Relationship.php | 54 +++- CRM/Contact/DAO/RelationshipCache.php | 48 ++- CRM/Contact/DAO/RelationshipType.php | 50 +++- CRM/Contact/DAO/SavedSearch.php | 58 +++- CRM/Contact/DAO/SubscriptionHistory.php | 30 +- CRM/Contribute/DAO/Contribution.php | 126 ++++++-- CRM/Contribute/DAO/ContributionPage.php | 186 +++++++++--- CRM/Contribute/DAO/ContributionProduct.php | 42 ++- CRM/Contribute/DAO/ContributionRecur.php | 118 ++++++-- CRM/Contribute/DAO/ContributionSoft.php | 42 ++- CRM/Contribute/DAO/Premium.php | 44 ++- CRM/Contribute/DAO/PremiumsProduct.php | 22 +- CRM/Contribute/DAO/Product.php | 76 +++-- CRM/Contribute/DAO/Widget.php | 70 +++-- CRM/Core/DAO/ActionLog.php | 42 ++- CRM/Core/DAO/ActionMapping.php | 38 ++- CRM/Core/DAO/ActionSchedule.php | 170 ++++++++--- CRM/Core/DAO/Address.php | 118 ++++++-- CRM/Core/DAO/AddressFormat.php | 10 +- CRM/Core/DAO/Cache.php | 28 +- CRM/Core/DAO/Component.php | 12 +- CRM/Core/DAO/Country.php | 42 ++- CRM/Core/DAO/County.php | 22 +- CRM/Core/DAO/CustomField.php | 120 ++++++-- CRM/Core/DAO/CustomGroup.php | 88 ++++-- CRM/Core/DAO/Dashboard.php | 50 +++- CRM/Core/DAO/Discount.php | 26 +- CRM/Core/DAO/Domain.php | 30 +- CRM/Core/DAO/Email.php | 50 +++- CRM/Core/DAO/EntityFile.php | 18 +- CRM/Core/DAO/EntityTag.php | 18 +- CRM/Core/DAO/Extension.php | 30 +- CRM/Core/DAO/File.php | 34 ++- CRM/Core/DAO/IM.php | 30 +- CRM/Core/DAO/Job.php | 46 ++- CRM/Core/DAO/JobLog.php | 34 ++- CRM/Core/DAO/LocBlock.php | 38 ++- CRM/Core/DAO/LocationType.php | 34 ++- CRM/Core/DAO/Log.php | 24 +- CRM/Core/DAO/MailSettings.php | 70 +++-- CRM/Core/DAO/Managed.php | 26 +- CRM/Core/DAO/Mapping.php | 18 +- CRM/Core/DAO/MappingField.php | 58 +++- CRM/Core/DAO/Menu.php | 90 ++++-- CRM/Core/DAO/MessageTemplate.php | 50 +++- CRM/Core/DAO/Navigation.php | 48 ++- CRM/Core/DAO/Note.php | 40 ++- CRM/Core/DAO/OpenID.php | 26 +- CRM/Core/DAO/OptionGroup.php | 32 +- CRM/Core/DAO/OptionValue.php | 70 +++-- CRM/Core/DAO/Phone.php | 42 ++- CRM/Core/DAO/PreferencesDate.php | 28 +- CRM/Core/DAO/PrevNextCache.php | 30 +- CRM/Core/DAO/PrintLabel.php | 46 ++- CRM/Core/DAO/RecurringEntity.php | 20 +- CRM/Core/DAO/Setting.php | 38 ++- CRM/Core/DAO/StateProvince.php | 22 +- CRM/Core/DAO/StatusPreference.php | 32 +- CRM/Core/DAO/SystemLog.php | 28 +- CRM/Core/DAO/Tag.php | 44 ++- CRM/Core/DAO/Timezone.php | 26 +- CRM/Core/DAO/Translation.php | 24 +- CRM/Core/DAO/UFField.php | 74 +++-- CRM/Core/DAO/UFGroup.php | 108 +++++-- CRM/Core/DAO/UFJoin.php | 32 +- CRM/Core/DAO/UFMatch.php | 26 +- CRM/Core/DAO/Website.php | 18 +- CRM/Core/DAO/WordReplacement.php | 26 +- CRM/Core/DAO/Worldregion.php | 10 +- CRM/Cxn/DAO/Cxn.php | 46 ++- CRM/Dedupe/DAO/DedupeException.php | 14 +- CRM/Dedupe/DAO/DedupeRule.php | 22 +- CRM/Dedupe/DAO/DedupeRuleGroup.php | 28 +- CRM/Event/Cart/DAO/Cart.php | 14 +- CRM/Event/Cart/DAO/EventInCart.php | 14 +- CRM/Event/DAO/Event.php | 278 +++++++++++++----- CRM/Event/DAO/Participant.php | 78 +++-- CRM/Event/DAO/ParticipantPayment.php | 14 +- CRM/Event/DAO/ParticipantStatusType.php | 38 ++- CRM/Financial/DAO/Currency.php | 22 +- CRM/Financial/DAO/EntityFinancialAccount.php | 20 +- CRM/Financial/DAO/EntityFinancialTrxn.php | 20 +- CRM/Financial/DAO/FinancialAccount.php | 60 +++- CRM/Financial/DAO/FinancialItem.php | 46 ++- CRM/Financial/DAO/FinancialTrxn.php | 74 +++-- CRM/Financial/DAO/FinancialType.php | 24 +- CRM/Financial/DAO/PaymentProcessor.php | 94 ++++-- CRM/Financial/DAO/PaymentProcessorType.php | 88 ++++-- CRM/Financial/DAO/PaymentToken.php | 52 +++- CRM/Friend/DAO/Friend.php | 40 ++- CRM/Mailing/DAO/BouncePattern.php | 14 +- CRM/Mailing/DAO/BounceType.php | 16 +- CRM/Mailing/DAO/Mailing.php | 172 ++++++++--- CRM/Mailing/DAO/MailingAB.php | 58 +++- CRM/Mailing/DAO/MailingComponent.php | 34 ++- CRM/Mailing/DAO/MailingGroup.php | 28 +- CRM/Mailing/DAO/MailingJob.php | 46 ++- CRM/Mailing/DAO/Recipients.php | 22 +- CRM/Mailing/DAO/Spool.php | 30 +- CRM/Mailing/DAO/TrackableURL.php | 14 +- CRM/Mailing/Event/DAO/Bounce.php | 22 +- CRM/Mailing/Event/DAO/Confirm.php | 14 +- CRM/Mailing/Event/DAO/Delivered.php | 14 +- CRM/Mailing/Event/DAO/Forward.php | 18 +- CRM/Mailing/Event/DAO/Opened.php | 14 +- CRM/Mailing/Event/DAO/Queue.php | 24 +- CRM/Mailing/Event/DAO/Reply.php | 14 +- CRM/Mailing/Event/DAO/Subscribe.php | 20 +- CRM/Mailing/Event/DAO/TrackableURLOpen.php | 18 +- CRM/Mailing/Event/DAO/Unsubscribe.php | 18 +- CRM/Member/DAO/Membership.php | 66 +++-- CRM/Member/DAO/MembershipBlock.php | 54 +++- CRM/Member/DAO/MembershipLog.php | 38 ++- CRM/Member/DAO/MembershipPayment.php | 14 +- CRM/Member/DAO/MembershipStatus.php | 60 +++- CRM/Member/DAO/MembershipType.php | 80 +++-- CRM/PCP/DAO/PCP.php | 66 +++-- CRM/PCP/DAO/PCPBlock.php | 52 +++- CRM/Pledge/DAO/Pledge.php | 92 ++++-- CRM/Pledge/DAO/PledgeBlock.php | 46 ++- CRM/Pledge/DAO/PledgePayment.php | 42 ++- CRM/Price/DAO/LineItem.php | 60 +++- CRM/Price/DAO/PriceField.php | 64 +++- CRM/Price/DAO/PriceFieldValue.php | 74 +++-- CRM/Price/DAO/PriceSet.php | 48 ++- CRM/Price/DAO/PriceSetEntity.php | 16 +- CRM/Queue/DAO/Queue.php | 14 +- CRM/Queue/DAO/QueueItem.php | 24 +- CRM/Report/DAO/ReportInstance.php | 84 ++++-- CRM/SMS/DAO/Provider.php | 46 ++- .../core/CRM/Afform/DAO/AfformSubmission.php | 22 +- ext/civigrant/CRM/Grant/DAO/Grant.php | 60 +++- .../CRM/OAuth/DAO/OAuthClient.php | 30 +- .../CRM/OAuth/DAO/OAuthContactToken.php | 66 +++-- .../CRM/OAuth/DAO/OAuthSysToken.php | 62 +++- .../CRM/Search/DAO/SearchDisplay.php | 26 +- 159 files changed, 5458 insertions(+), 1872 deletions(-) diff --git a/CRM/ACL/DAO/ACL.php b/CRM/ACL/DAO/ACL.php index 4bddbd0eb7..2d72b764b7 100644 --- a/CRM/ACL/DAO/ACL.php +++ b/CRM/ACL/DAO/ACL.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/ACL/ACL.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:709746b9e63da79d9ee75de3a0687db4) + * (GenCodeChecksum:5245f10c478c4187d1fb420e76f2fd76) */ /** @@ -33,21 +33,27 @@ class CRM_ACL_DAO_ACL extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * ACL Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Is this ACL entry Allow (0) or Deny (1) ? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $deny; @@ -55,13 +61,17 @@ class CRM_ACL_DAO_ACL extends CRM_Core_DAO { * Table of the object possessing this ACL entry (Contact, Group, or ACL Group) * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * ID of the object possessing this ACL * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; @@ -69,41 +79,53 @@ class CRM_ACL_DAO_ACL extends CRM_Core_DAO { * What operation does this ACL entry control? * * @var string + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $operation; /** * The table of the object controlled by this ACL entry * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $object_table; /** * The ID of the object controlled by this ACL entry * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $object_id; /** * If this is a grant/revoke entry, what table are we granting? * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $acl_table; /** * ID of the ACL or ACL group being granted/revoked * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $acl_id; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/ACL/DAO/ACLCache.php b/CRM/ACL/DAO/ACLCache.php index 7fbc4bfaa6..100d028f80 100644 --- a/CRM/ACL/DAO/ACLCache.php +++ b/CRM/ACL/DAO/ACLCache.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/ACL/ACLCache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6593794a6e82670ad992cc331c22f33e) + * (GenCodeChecksum:329e9070bd70f3fb3d053eb731d1b266) */ /** @@ -33,28 +33,36 @@ class CRM_ACL_DAO_ACLCache extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign Key to Contact * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Foreign Key to ACL * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $acl_id; /** * When was this cache entry last modified * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/CRM/ACL/DAO/ACLEntityRole.php b/CRM/ACL/DAO/ACLEntityRole.php index b085e2e640..c99c67b975 100644 --- a/CRM/ACL/DAO/ACLEntityRole.php +++ b/CRM/ACL/DAO/ACLEntityRole.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/ACL/ACLEntityRole.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:fe3bd0baaffcc93590b3285c6cf96fc1) + * (GenCodeChecksum:22633176232bcef28b59ab0388720837) */ /** @@ -33,14 +33,18 @@ class CRM_ACL_DAO_ACLEntityRole extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign Key to ACL Role (which is an option value pair and hence an implicit FK) * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $acl_role_id; @@ -48,20 +52,26 @@ class CRM_ACL_DAO_ACLEntityRole extends CRM_Core_DAO { * Table of the object joined to the ACL Role (Contact or Group) * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * ID of the group/contact object being joined * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Activity/DAO/Activity.php b/CRM/Activity/DAO/Activity.php index a9a947a6fb..516386a36f 100644 --- a/CRM/Activity/DAO/Activity.php +++ b/CRM/Activity/DAO/Activity.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Activity/Activity.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:13ab76e26c4edb7764fd51a61cdf0e0f) + * (GenCodeChecksum:b37cf83d01ce6a8f72be6de97f00d7d3) */ /** @@ -59,179 +59,233 @@ class CRM_Activity_DAO_Activity extends CRM_Core_DAO { /** * Unique Other Activity ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Artificial FK to original transaction (e.g. contribution) IF it is not an Activity. Table can be figured out through activity_type_id, and further through component registry. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $source_record_id; /** * FK to civicrm_option_value.id, that has to be valid, registered activity type. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $activity_type_id; /** * The subject/purpose/short description of the activity. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** * Date and time this activity is scheduled to occur. Formerly named scheduled_date_time. * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $activity_date_time; /** * Planned or actual duration of activity expressed in minutes. Conglomerate of former duration_hours and duration_minutes. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $duration; /** * Location of the activity (optional, open text). * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $location; /** * Phone ID of the number called (optional - used if an existing phone number is selected). * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_id; /** * Phone number in case the number does not exist in the civicrm_phone table. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $phone_number; /** * Details about the activity (agenda, notes, etc). * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $details; /** * ID of the status this activity is currently in. Foreign key 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 $status_id; /** * ID of the priority given to this activity. Foreign key 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 $priority_id; /** * Parent meeting ID (if this is a follow-up item). This is not currently implemented * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** * Activity Medium, Implicit FK to civicrm_option_value where option_group = encounter_medium. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $medium_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_auto; /** * FK to Relationship ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $relationship_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_current_revision; /** * Activity ID of the first activity record in versioning chain. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $original_id; /** * Currently being used to store result id for survey activity, FK to option value. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $result; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_deleted; /** * The campaign for which this activity has been triggered. * - * @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; /** * Assign a specific level of engagement to this activity. Used for tracking constituents in ladder of engagement. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $engagement_level; /** - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Activity marked as favorite. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_star; /** * When was the activity was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When was the activity (or closely related entity) was created or modified or deleted. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/CRM/Activity/DAO/ActivityContact.php b/CRM/Activity/DAO/ActivityContact.php index cb434a9a45..426e978adf 100644 --- a/CRM/Activity/DAO/ActivityContact.php +++ b/CRM/Activity/DAO/ActivityContact.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Activity/ActivityContact.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9d55ecc09cc160c1cc41485bf7d026ef) + * (GenCodeChecksum:2e8b2b826a1e0f70d39ea967462796d4) */ /** @@ -33,28 +33,36 @@ class CRM_Activity_DAO_ActivityContact extends CRM_Core_DAO { /** * Activity contact id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign key to the activity for this record. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $activity_id; /** * Foreign key to the contact for this record. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Determines the contact's role in the activity (source, target, or assignee). * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $record_type_id; diff --git a/CRM/Batch/DAO/Batch.php b/CRM/Batch/DAO/Batch.php index 4b303f0866..1175aa77ec 100644 --- a/CRM/Batch/DAO/Batch.php +++ b/CRM/Batch/DAO/Batch.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Batch/Batch.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:965795e9c5cb8876ff6198abee5ffc71) + * (GenCodeChecksum:d7bcbc183569fc9cc52260eef81e84ad) */ /** @@ -33,117 +33,151 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO { /** * Unique Address ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Variable name/programmatic handle for this batch. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Friendly Name. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Description of this batch set. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * FK to Contact ID * - * @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; /** * When was this item created * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $modified_id; /** * When was this item modified * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * FK to Saved Search ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $saved_search_id; /** * fk to Batch Status options in civicrm_option_values * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * fk to Batch Type options in civicrm_option_values * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $type_id; /** * fk to Batch mode options in civicrm_option_values * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mode_id; /** * Total amount for this batch. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $total; /** * Number of items in a batch. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $item_count; /** * fk to Payment Instrument options in civicrm_option_values * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_instrument_id; /** - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $exported_date; /** * cache entered data * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $data; diff --git a/CRM/Batch/DAO/EntityBatch.php b/CRM/Batch/DAO/EntityBatch.php index 3a14e16132..4d851f0ad1 100644 --- a/CRM/Batch/DAO/EntityBatch.php +++ b/CRM/Batch/DAO/EntityBatch.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Batch/EntityBatch.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:916ca7535e5e9d344f17456a973fdad6) + * (GenCodeChecksum:98d4fc139c4903eb67dadd5a5ea72f5e) */ /** @@ -33,28 +33,36 @@ class CRM_Batch_DAO_EntityBatch extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * physical tablename for entity being joined to file, e.g. civicrm_contact * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * FK to civicrm_batch * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $batch_id; diff --git a/CRM/Campaign/DAO/Campaign.php b/CRM/Campaign/DAO/Campaign.php index a82c6fb444..99b8489ede 100644 --- a/CRM/Campaign/DAO/Campaign.php +++ b/CRM/Campaign/DAO/Campaign.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Campaign/Campaign.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9d4da1f7966af86e8426aa449826f41c) + * (GenCodeChecksum:dab6fdaa9d622daab580b32ae1172bc7) */ /** @@ -59,7 +59,9 @@ class CRM_Campaign_DAO_Campaign extends CRM_Core_DAO { /** * Unique Campaign ID. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -67,111 +69,143 @@ class CRM_Campaign_DAO_Campaign extends CRM_Core_DAO { * Name of the Campaign. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Title of the Campaign. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Full description of Campaign. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Date and time that Campaign 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 Campaign ends. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * Campaign Type ID.Implicit FK to civicrm_option_value where option_group = campaign_type * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $campaign_type_id; /** * Campaign status ID.Implicit FK to civicrm_option_value where option_group = campaign_status * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $external_identifier; /** * Optional parent id for this Campaign. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Is this Campaign 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; /** * FK to civicrm_contact, who created this Campaign. * - * @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 Campaign 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; /** * FK to civicrm_contact, who recently edited this Campaign. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $last_modified_id; /** * Date and time that Campaign was edited last time. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $last_modified_date; /** * General goals for Campaign. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $goal_general; /** * The target revenue for this campaign. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $goal_revenue; diff --git a/CRM/Campaign/DAO/CampaignGroup.php b/CRM/Campaign/DAO/CampaignGroup.php index cc967826b4..48351d8be0 100644 --- a/CRM/Campaign/DAO/CampaignGroup.php +++ b/CRM/Campaign/DAO/CampaignGroup.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Campaign/CampaignGroup.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:978c5e6110b6905764ed276943711ac4) + * (GenCodeChecksum:2f82c00377ac107ef95474e340b596d7) */ /** @@ -34,35 +34,45 @@ class CRM_Campaign_DAO_CampaignGroup extends CRM_Core_DAO { /** * Campaign Group id. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign key to the activity Campaign. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $campaign_id; /** * Type of Group. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $group_type; /** * Name of table where item being referenced is stored. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Entity id of referenced table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; diff --git a/CRM/Campaign/DAO/Survey.php b/CRM/Campaign/DAO/Survey.php index 83573a7148..410b6ea812 100644 --- a/CRM/Campaign/DAO/Survey.php +++ b/CRM/Campaign/DAO/Survey.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Campaign/Survey.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:8fec5a0ffb4667af4f00820de74aa577) + * (GenCodeChecksum:d0bc187a5dd2297f5c81a7a84460fc17) */ /** @@ -48,7 +48,9 @@ class CRM_Campaign_DAO_Survey extends CRM_Core_DAO { /** * Survey id. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -56,132 +58,170 @@ class CRM_Campaign_DAO_Survey extends CRM_Core_DAO { * Title of the Survey. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Foreign key to the Campaign. * - * @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; /** * Implicit FK to civicrm_option_value where option_group = activity_type * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $activity_type_id; /** * Recontact intervals for each status. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $recontact_interval; /** * Script instructions for volunteers to use for the survey. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $instructions; /** * Number of days for recurrence of release. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $release_frequency; /** * Maximum number of contacts to allow for survey. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $max_number_of_contacts; /** * Default number of contacts to allow for survey. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $default_number_of_contacts; /** * Is this survey 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; /** * Is this default survey? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * FK to civicrm_contact, who created this Survey. * - * @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 Survey 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; /** * FK to civicrm_contact, who recently edited this Survey. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $last_modified_id; /** * Date and time that Survey was edited last time. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $last_modified_date; /** * Used to store option group id. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $result_id; /** * Bypass the email verification. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $bypass_confirm; /** * Title for Thank-you page (header title tag, and display at the top of the 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; /** * text and html allowed. displayed above result on success page * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $thankyou_text; /** * Can people share the petition 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; diff --git a/CRM/Case/DAO/Case.php b/CRM/Case/DAO/Case.php index 7b78fd0b6b..49e5ba5611 100644 --- a/CRM/Case/DAO/Case.php +++ b/CRM/Case/DAO/Case.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Case/Case.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4f0e6fd0e12af2ec370f45171c017159) + * (GenCodeChecksum:9255efc8fc0b791899a006e23eb55341) */ /** @@ -48,68 +48,88 @@ class CRM_Case_DAO_Case extends CRM_Core_DAO { /** * Unique Case ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_case_type.id * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $case_type_id; /** * Short name of the case. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** * Date on which given case starts. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * Date on which given case ends. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * Details populated from Open Case. Only used in the CiviCase extension. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $details; /** * ID of case status. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_deleted; /** * When was the case was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When was the case (or closely related entity) was created or modified or deleted. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/CRM/Case/DAO/CaseActivity.php b/CRM/Case/DAO/CaseActivity.php index d887ef82de..bfb3a04997 100644 --- a/CRM/Case/DAO/CaseActivity.php +++ b/CRM/Case/DAO/CaseActivity.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Case/CaseActivity.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:e5c1c45fc5dc666a02a3c1e872ba9a2b) + * (GenCodeChecksum:473d4047af6f44f1082795d38ef3ff4d) */ /** @@ -34,21 +34,27 @@ class CRM_Case_DAO_CaseActivity extends CRM_Core_DAO { /** * Unique case-activity association id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Case ID of case-activity association. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $case_id; /** * Activity ID of case-activity association. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $activity_id; diff --git a/CRM/Case/DAO/CaseContact.php b/CRM/Case/DAO/CaseContact.php index 5cafa972a8..b7950e90c8 100644 --- a/CRM/Case/DAO/CaseContact.php +++ b/CRM/Case/DAO/CaseContact.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Case/CaseContact.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:e7ecd6e1648086f8925bad0dda6bec31) + * (GenCodeChecksum:92ba2cdb76569cdd69d488e73c495374) */ /** @@ -34,21 +34,27 @@ class CRM_Case_DAO_CaseContact extends CRM_Core_DAO { /** * Unique case-contact association id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Case ID of case-contact association. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $case_id; /** * Contact ID of contact record given case belongs to. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; diff --git a/CRM/Case/DAO/CaseType.php b/CRM/Case/DAO/CaseType.php index ec47d3d698..8b5f4651a4 100644 --- a/CRM/Case/DAO/CaseType.php +++ b/CRM/Case/DAO/CaseType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Case/CaseType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9080f32e76695319d1e6110372c0900c) + * (GenCodeChecksum:1102802dc49a9899f93c16fce57fa141) */ /** @@ -34,7 +34,9 @@ class CRM_Case_DAO_CaseType extends CRM_Core_DAO { /** * Autoincremented type id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,6 +44,8 @@ class CRM_Case_DAO_CaseType extends CRM_Core_DAO { * Machine name for Case Type * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -49,41 +53,53 @@ class CRM_Case_DAO_CaseType extends CRM_Core_DAO { * Natural language name for Case Type * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Description of the Case Type * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Is this case type enabled? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this case type a predefined system type? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Ordering of the case types * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * xml definition of case type * - * @var blob + * @var string|null + * (SQL type: blob) + * Note that values will be retrieved from the database as a string. */ public $definition; diff --git a/CRM/Contact/DAO/ACLContactCache.php b/CRM/Contact/DAO/ACLContactCache.php index 50bdac46fb..f477d8fe35 100644 --- a/CRM/Contact/DAO/ACLContactCache.php +++ b/CRM/Contact/DAO/ACLContactCache.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/ACLContactCache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:912d65e10ee9243dfa3cbe089e2a4ae3) + * (GenCodeChecksum:b9913f6181f2b09c71b99f8c41d65c1b) */ /** @@ -33,21 +33,27 @@ class CRM_Contact_DAO_ACLContactCache extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_contact (could be null for anon user) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $user_id; /** * FK to civicrm_contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; @@ -55,6 +61,8 @@ class CRM_Contact_DAO_ACLContactCache extends CRM_Core_DAO { * What operation does this user have permission on? * * @var string + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $operation; diff --git a/CRM/Contact/DAO/Contact.php b/CRM/Contact/DAO/Contact.php index a6bb970eea..3270f8789b 100644 --- a/CRM/Contact/DAO/Contact.php +++ b/CRM/Contact/DAO/Contact.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/Contact.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:5a410e3dd35c4d4b66fdeeacf1cfd971) + * (GenCodeChecksum:1ed20aff22fc1effbd05ea8411e48139) */ /** @@ -59,350 +59,454 @@ class CRM_Contact_DAO_Contact extends CRM_Core_DAO { /** * Unique Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Type of Contact. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $contact_type; /** * May be used to over-ride contact view and edit templates. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $contact_sub_type; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $do_not_email; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $do_not_phone; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $do_not_mail; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $do_not_sms; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $do_not_trade; /** * Has the contact opted out from receiving all bulk email from the organization or site domain? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_opt_out; /** * May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $legal_identifier; /** * Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $external_identifier; /** * Name used for sorting different contact types * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $sort_name; /** * Formatted name representing preferred format for display/print/other output. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $display_name; /** * Nickname. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $nick_name; /** * Legal Name. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $legal_name; /** * optional URL for preferred image (photo, logo, etc.) to display for this contact. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $image_URL; /** * What is the preferred mode of communication. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $preferred_communication_method; /** * Which language is preferred for communication. FK to languages in civicrm_option_value. * - * @var string + * @var string|null + * (SQL type: varchar(5)) + * Note that values will be retrieved from the database as a string. */ public $preferred_language; /** * What is the preferred mode of sending an email. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $preferred_mail_format; /** * Key for validating requests related to this contact. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $hash; /** * API Key for validating requests related to this contact. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $api_key; /** * where contact come from, e.g. import, donate module insert... * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $source; /** * First Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $first_name; /** * Middle Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $middle_name; /** * Last Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $last_name; /** * Prefix or Title for name (Ms, Mr...). FK to prefix ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $prefix_id; /** * Suffix for name (Jr, Sr...). FK to suffix ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $suffix_id; /** * Formal (academic or similar) title in front of name. (Prof., Dr. etc.) * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $formal_title; /** * Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in 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 $communication_style_id; /** * FK to civicrm_option_value.id, that has to be valid registered Email Greeting. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $email_greeting_id; /** * Custom Email Greeting. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $email_greeting_custom; /** * Cache Email Greeting. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $email_greeting_display; /** * FK to civicrm_option_value.id, that has to be valid registered Postal Greeting. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $postal_greeting_id; /** * Custom Postal greeting. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $postal_greeting_custom; /** * Cache Postal greeting. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $postal_greeting_display; /** * FK to civicrm_option_value.id, that has to be valid registered Addressee. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $addressee_id; /** * Custom Addressee. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $addressee_custom; /** * Cache Addressee. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $addressee_display; /** * Job Title * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $job_title; /** * FK to gender ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $gender_id; /** * Date of birth * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $birth_date; /** - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_deceased; /** * Date of deceased * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $deceased_date; /** * Household Name. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $household_name; /** * Optional FK to Primary Contact for this household. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $primary_contact_id; /** * Organization Name. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $organization_name; /** * Standard Industry Classification Code. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $sic_code; /** * the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $user_unique_id; /** * OPTIONAL FK to civicrm_contact record. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $employer_id; /** - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_deleted; /** * When was the contact was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When was the contact (or closely related entity) was created or modified or deleted. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/CRM/Contact/DAO/ContactType.php b/CRM/Contact/DAO/ContactType.php index 26db28868a..c97ef494e9 100644 --- a/CRM/Contact/DAO/ContactType.php +++ b/CRM/Contact/DAO/ContactType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/ContactType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f1913952f114c2ac041dfba5fef49d5d) + * (GenCodeChecksum:cc7d1501964e3a55b30e3df24aad8cf0) */ /** @@ -33,7 +33,9 @@ class CRM_Contact_DAO_ContactType extends CRM_Core_DAO { /** * Contact Type ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,48 +43,62 @@ class CRM_Contact_DAO_ContactType extends CRM_Core_DAO { * Internal name of Contact Type (or Subtype). * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * localized Name of Contact Type. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * localized Optional verbose description of the type. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * URL of image if any. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $image_URL; /** * Optional FK to parent contact type. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Is this entry active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this contact type a predefined system type * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; diff --git a/CRM/Contact/DAO/DashboardContact.php b/CRM/Contact/DAO/DashboardContact.php index 8cf85d6ef7..b8881db880 100644 --- a/CRM/Contact/DAO/DashboardContact.php +++ b/CRM/Contact/DAO/DashboardContact.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/DashboardContact.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:a2eac9e772485e4a551738ad107dc209) + * (GenCodeChecksum:fd3f7ea02b93c0dd3ecd46fb757bc2a3) */ /** @@ -31,42 +31,54 @@ class CRM_Contact_DAO_DashboardContact extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Dashboard ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $dashboard_id; /** * Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * column no for this widget * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $column_no; /** * Is this widget active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Ordering of the widgets. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; diff --git a/CRM/Contact/DAO/Group.php b/CRM/Contact/DAO/Group.php index 197127e341..b5cb1640a7 100644 --- a/CRM/Contact/DAO/Group.php +++ b/CRM/Contact/DAO/Group.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/Group.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:29b3646b12fccdf8a2d561dc483c8980) + * (GenCodeChecksum:f5efc579d0d67d8922a405a208cf83c3) */ /** @@ -56,152 +56,196 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO { /** * Group ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Internal name of Group. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Name of Group. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Optional verbose description of the group. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Module or process which created this group. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $source; /** * FK to saved search table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $saved_search_id; /** * Is this entry active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * In what context(s) is this field visible. * - * @var string + * @var string|null + * (SQL type: varchar(24)) + * Note that values will be retrieved from the database as a string. */ public $visibility; /** * the sql where clause if a saved search acl * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $where_clause; /** * the tables to be included in a select data * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $select_tables; /** * the tables to be included in the count statement * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $where_tables; /** * FK to group type * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $group_type; /** * Date when we created the cache for a smart group * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $cache_date; /** * Date and time when we need to refresh the cache next. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $refresh_date; /** * IDs of the parent(s) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $parents; /** * IDs of the child(ren) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $children; /** * Is this group hidden? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_hidden; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * FK to contact table. * - * @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; /** * FK to contact table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $modified_id; /** * Alternative public title for this Group. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $frontend_title; /** * Alternative public description of the group. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $frontend_description; diff --git a/CRM/Contact/DAO/GroupContact.php b/CRM/Contact/DAO/GroupContact.php index a00fcd6728..316309dc7f 100644 --- a/CRM/Contact/DAO/GroupContact.php +++ b/CRM/Contact/DAO/GroupContact.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/GroupContact.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:53a34c1b6c96fe915f0ab57b93994b72) + * (GenCodeChecksum:f7c8513020809cc974eec784b983a75d) */ /** @@ -33,42 +33,54 @@ class CRM_Contact_DAO_GroupContact extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_group * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_id; /** * FK to civicrm_contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * status of contact relative to membership in group * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $status; /** * Optional location to associate with this membership * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_id; /** * Optional email to associate with this membership * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $email_id; diff --git a/CRM/Contact/DAO/GroupContactCache.php b/CRM/Contact/DAO/GroupContactCache.php index 5b5e5bfa96..f07f6f1d34 100644 --- a/CRM/Contact/DAO/GroupContactCache.php +++ b/CRM/Contact/DAO/GroupContactCache.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/GroupContactCache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:26ac45cd1045e34353ef787013eeb84c) + * (GenCodeChecksum:06473218afb38f81fefca8e3e1a351e1) */ /** @@ -33,21 +33,27 @@ class CRM_Contact_DAO_GroupContactCache extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_group * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_id; /** * FK to civicrm_contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; diff --git a/CRM/Contact/DAO/GroupNesting.php b/CRM/Contact/DAO/GroupNesting.php index 80d27a44d7..bdb20df7e6 100644 --- a/CRM/Contact/DAO/GroupNesting.php +++ b/CRM/Contact/DAO/GroupNesting.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/GroupNesting.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:a2d08c11cd6a0aedbcdf816fdb772839) + * (GenCodeChecksum:f93c2699304caa24bcb30d71891621ad) */ /** @@ -33,21 +33,27 @@ class CRM_Contact_DAO_GroupNesting extends CRM_Core_DAO { /** * Relationship ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * ID of the child group * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $child_group_id; /** * ID of the parent group * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_group_id; diff --git a/CRM/Contact/DAO/GroupOrganization.php b/CRM/Contact/DAO/GroupOrganization.php index 807465028f..9415570b03 100644 --- a/CRM/Contact/DAO/GroupOrganization.php +++ b/CRM/Contact/DAO/GroupOrganization.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/GroupOrganization.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:406b553dbbfbfbf54fa3d32bc1e9fecc) + * (GenCodeChecksum:0058d88ce8ce0b5a017cfd91b1adc430) */ /** @@ -33,21 +33,27 @@ class CRM_Contact_DAO_GroupOrganization extends CRM_Core_DAO { /** * Relationship ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * ID of the group * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_id; /** * ID of the Organization Contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $organization_id; diff --git a/CRM/Contact/DAO/Relationship.php b/CRM/Contact/DAO/Relationship.php index 5ed913d219..0ecfdcf999 100644 --- a/CRM/Contact/DAO/Relationship.php +++ b/CRM/Contact/DAO/Relationship.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/Relationship.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:31dfa249bbf980b8094bce3ff7f70fc9) + * (GenCodeChecksum:9857c3a39c853ba7abfeb246af8a70ec) */ /** @@ -50,91 +50,117 @@ class CRM_Contact_DAO_Relationship extends CRM_Core_DAO { /** * Relationship ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * id of the first contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id_a; /** * id of the second contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id_b; /** * Type of relationship * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $relationship_type_id; /** * date when the relationship started * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * date when the relationship ended * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * is the relationship active ? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Optional verbose description for the relationship. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Permission that Contact A has to view/update Contact B * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $is_permission_a_b; /** * Permission that Contact B has to view/update Contact A * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $is_permission_b_a; /** * FK to civicrm_case * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $case_id; /** * Relationship created date. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * Relationship last modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/CRM/Contact/DAO/RelationshipCache.php b/CRM/Contact/DAO/RelationshipCache.php index 669646c3f6..41044bfeed 100644 --- a/CRM/Contact/DAO/RelationshipCache.php +++ b/CRM/Contact/DAO/RelationshipCache.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/RelationshipCache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f70f357cd7e45be254350f45ef41aee2) + * (GenCodeChecksum:1bc7c47a01326782645f1cfac11c6d14) */ /** @@ -51,21 +51,27 @@ class CRM_Contact_DAO_RelationshipCache extends CRM_Core_DAO { /** * Relationship Cache ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * id of the relationship (FK to civicrm_relationship.id) * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $relationship_id; /** * id of the relationship type * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $relationship_type_id; @@ -73,62 +79,80 @@ class CRM_Contact_DAO_RelationshipCache extends CRM_Core_DAO { * The cache record is a permutation of the original relationship record. The orientation indicates whether it is forward (a_b) or reverse (b_a) relationship. * * @var string + * (SQL type: char(3)) + * Note that values will be retrieved from the database as a string. */ public $orientation; /** * id of the first contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $near_contact_id; /** * name for relationship of near_contact to far_contact. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $near_relation; /** * id of the second contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $far_contact_id; /** * name for relationship of far_contact to near_contact. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $far_relation; /** * is the relationship active ? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * date when the relationship started * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * date when the relationship ended * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * FK to civicrm_case * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $case_id; diff --git a/CRM/Contact/DAO/RelationshipType.php b/CRM/Contact/DAO/RelationshipType.php index 7b8d02c91c..3bd1a0d80c 100644 --- a/CRM/Contact/DAO/RelationshipType.php +++ b/CRM/Contact/DAO/RelationshipType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/RelationshipType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:59f2be616e7324c1a2b34e840b24beb2) + * (GenCodeChecksum:b020221ec1e27cbaf4eba0b9457a8448) */ /** @@ -33,84 +33,108 @@ class CRM_Contact_DAO_RelationshipType extends CRM_Core_DAO { /** * Primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * name for relationship of contact_a to contact_b. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name_a_b; /** * label for relationship of contact_a to contact_b. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $label_a_b; /** * Optional name for relationship of contact_b to contact_a. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name_b_a; /** * Optional label for relationship of contact_b to contact_a. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $label_b_a; /** * Optional verbose description of the relationship type. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * If defined, contact_a in a relationship of this type must be a specific contact_type. * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $contact_type_a; /** * If defined, contact_b in a relationship of this type must be a specific contact_type. * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $contact_type_b; /** * If defined, contact_sub_type_a in a relationship of this type must be a specific contact_sub_type. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $contact_sub_type_a; /** * If defined, contact_sub_type_b in a relationship of this type must be a specific contact_sub_type. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $contact_sub_type_b; /** * Is this relationship type a predefined system type (can not be changed or de-activated)? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this relationship type currently active (i.e. can be used when creating or editing relationships)? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Contact/DAO/SavedSearch.php b/CRM/Contact/DAO/SavedSearch.php index 41fda3afb0..4666188af3 100644 --- a/CRM/Contact/DAO/SavedSearch.php +++ b/CRM/Contact/DAO/SavedSearch.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/SavedSearch.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:bca384578ea59c0cf4f0a80617c788fe) + * (GenCodeChecksum:935938d45a416234d369d2db97a08311) */ /** @@ -33,96 +33,124 @@ class CRM_Contact_DAO_SavedSearch extends CRM_Core_DAO { /** * Saved Search ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Unique name of saved search * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Administrative label for search * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * Submitted form values for this search * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $form_values; /** * Foreign key to civicrm_mapping used for saved search-builder searches. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mapping_id; /** * Foreign key to civicrm_option value table used for saved custom searches. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $search_custom_id; /** * Entity name for API based search * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $api_entity; /** * Parameters for API based search * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $api_params; /** * FK to contact table. * - * @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; /** * FK to contact table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $modified_id; /** * Optional date after which the search is not needed * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $expires_date; /** * When the search was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the search was last modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; diff --git a/CRM/Contact/DAO/SubscriptionHistory.php b/CRM/Contact/DAO/SubscriptionHistory.php index 9aa23278b5..712ff23181 100644 --- a/CRM/Contact/DAO/SubscriptionHistory.php +++ b/CRM/Contact/DAO/SubscriptionHistory.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contact/SubscriptionHistory.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f5eb6517b054998df7a07e5a81874a1b) + * (GenCodeChecksum:fd8cbc2ef621cc092f3f91c1f0f749d4) */ /** @@ -33,49 +33,63 @@ class CRM_Contact_DAO_SubscriptionHistory extends CRM_Core_DAO { /** * Internal ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Group ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_id; /** * Date of the (un)subscription * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $date; /** * How the (un)subscription was triggered * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $method; /** * The state of the contact within the group * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $status; /** * IP address or other tracking info * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $tracking; diff --git a/CRM/Contribute/DAO/Contribution.php b/CRM/Contribute/DAO/Contribution.php index b9093b4986..a53aeea42a 100644 --- a/CRM/Contribute/DAO/Contribution.php +++ b/CRM/Contribute/DAO/Contribution.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/Contribution.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:b14fa847767daf3723033f41dbca9612) + * (GenCodeChecksum:204947e70942c2db4fb9b84398818aa1) */ /** @@ -53,205 +53,267 @@ class CRM_Contribute_DAO_Contribution extends CRM_Core_DAO { /** * Contribution ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * FK to Financial Type for (total_amount - non_deductible_amount). * - * @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; /** * The Contribution Page which triggered this contribution * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_page_id; /** * FK to Payment Instrument * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_instrument_id; /** * Date contribution was received - not necessarily the creation date of the record * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $receive_date; /** * Portion of total amount which is NOT tax deductible. Equal to total_amount for non-deductible financial types. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $non_deductible_amount; /** * Total amount of this contribution. Use market value for non-monetary gifts. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $total_amount; /** * actual processor fee if known - may be 0. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $fee_amount; /** * actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $net_amount; /** * unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $trxn_id; /** * unique invoice id, system generated or passed in * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $invoice_id; /** * Human readable invoice number * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $invoice_number; /** * 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; /** * when was gift cancelled * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $cancel_date; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $cancel_reason; /** * when (if) receipt was sent. populated automatically for online donations w/ automatic receipting * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $receipt_date; /** * when (if) was donor thanked * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $thankyou_date; /** * Origin of this Contribution. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $source; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $amount_level; /** * Conditional foreign key to civicrm_contribution_recur id. Each contribution made in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_recur_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** - * @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; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_status_id; /** * Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $address_id; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $check_number; /** * The campaign for which this contribution has been triggered. * - * @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; /** * unique credit note id, system generated or passed in * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $creditnote_id; /** * Total tax amount of this contribution. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $tax_amount; /** * Stores the date when revenue should be recognized. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $revenue_recognition_date; /** * Shows this is a template for recurring contributions. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_template; diff --git a/CRM/Contribute/DAO/ContributionPage.php b/CRM/Contribute/DAO/ContributionPage.php index 6af62986b0..1efbad0a12 100644 --- a/CRM/Contribute/DAO/ContributionPage.php +++ b/CRM/Contribute/DAO/ContributionPage.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/ContributionPage.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:5f0160b47f79e1eeb1f920b4e221953d) + * (GenCodeChecksum:e33f9a31d9be56f20e20c753313478d1) */ /** @@ -41,322 +41,414 @@ class CRM_Contribute_DAO_ContributionPage extends CRM_Core_DAO { /** * Contribution ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Contribution Page title. For top of page display * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Text and html allowed. Displayed below title. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $intro_text; /** * default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution * - * @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 contribution Page * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $payment_processor; /** * if true - processing logic must reject transaction at confirmation stage if pay method != credit card * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_credit_card_only; /** * if true - allows real-time monetary transactions otherwise non-monetary transactions * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_monetary; /** * if true - allows recurring contributions, valid only for PayPal_Standard * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_recur; /** * if false, the confirm page in contribution pages 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; /** * Supported recurring frequency units. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $recur_frequency_unit; /** * if true - supports recurring intervals * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_recur_interval; /** * if true - asks user for recurring installments * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_recur_installments; /** * if true - user is able to adjust payment start date * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $adjust_recur_start_date; /** * 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 online contribution page * - * @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, page will include an input text field where user can enter their own amount * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_allow_other_amount; /** * 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_amount_id; /** * if other amounts allowed, user can configure minimum allowed. * - * @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_amount; /** * if other amounts allowed, user can configure maximum allowed. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $max_amount; /** * The target goal for this page, allows people to build a goal meter * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $goal_amount; /** * Title for Thank-you page (header title tag, and display at the top of the 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; /** * text and html allowed. displayed above result on success page * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $thankyou_text; /** * Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $thankyou_footer; /** * if true, receipt is automatically emailed to contact on success * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_email_receipt; /** * FROM email name used for receipts generated by contributions to this contribution page. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $receipt_from_name; /** * FROM email address used for receipts generated by contributions to this contribution page. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $receipt_from_email; /** * comma-separated list of email addresses to cc each time a receipt 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_receipt; /** * comma-separated list of email addresses to bcc each time a receipt 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_receipt; /** * text to include above standard receipt info on receipt 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 $receipt_text; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Text and html allowed. Displayed at the bottom of the first page of the contribution wizard. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $footer_text; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $amount_block_is_active; /** * Date and time that this page 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 this page 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; /** * FK to civicrm_contact, who created this contribution page * - * @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 contribution page 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 we are collecting contributions with this page. * - * @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 contribution page 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 true - billing block is required for online contribution page * - * @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; /** * Contribution Page Public title * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $frontend_title; diff --git a/CRM/Contribute/DAO/ContributionProduct.php b/CRM/Contribute/DAO/ContributionProduct.php index 6b90bff589..562d28f386 100644 --- a/CRM/Contribute/DAO/ContributionProduct.php +++ b/CRM/Contribute/DAO/ContributionProduct.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/ContributionProduct.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:b8b2fd54470db337ec6285ac53bc51b1) + * (GenCodeChecksum:55d9ad3d7acb1129577589352f6010cd) */ /** @@ -32,62 +32,82 @@ class CRM_Contribute_DAO_ContributionProduct extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $product_id; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_id; /** * Option value selected if applicable - e.g. color, size etc. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $product_option; /** - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $quantity; /** * Optional. Can be used to record the date this product was fulfilled or shipped. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $fulfilled_date; /** * Actual start date for a time-delimited premium (subscription, service or membership) * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * Actual end date for a time-delimited premium (subscription, service or membership) * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $comment; /** * FK to Financial Type(for membership price sets only). * - * @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; diff --git a/CRM/Contribute/DAO/ContributionRecur.php b/CRM/Contribute/DAO/ContributionRecur.php index 822ce923cc..9a2a9418ec 100644 --- a/CRM/Contribute/DAO/ContributionRecur.php +++ b/CRM/Contribute/DAO/ContributionRecur.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/ContributionRecur.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:5f08744178821ce074d21fe4cdddbdaa) + * (GenCodeChecksum:fd697cd9f74b697ebc373d3a62526be0) */ /** @@ -34,199 +34,257 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO { /** * Contribution Recur ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign key to civicrm_contact.id. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Amount to be collected (including any sales tax) by payment processor each recurrence. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount; /** * 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; /** * Time units for recurrence of payment. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $frequency_unit; /** * Number of time units for recurrence of payment. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $frequency_interval; /** * Total number of payments to be made. Set this to 0 if this is an open-ended commitment i.e. no set end date. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $installments; /** * The date the first scheduled recurring contribution occurs. * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * When this recurring contribution record was created. * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $create_date; /** * Last updated date for this record. mostly the last time a payment was received * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * Date this recurring contribution was cancelled by contributor- if we can get access to it * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $cancel_date; /** * Free text field for a reason for cancelling * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $cancel_reason; /** * Date this recurring contribution finished successfully * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * Possibly needed to store a unique identifier for this recurring payment order - if this is available from the processor?? * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $processor_id; /** * Optionally used to store a link to a payment token used for this recurring contribution. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_token_id; /** * unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $trxn_id; /** * unique invoice id, system generated or passed in * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $invoice_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_status_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** * Day in the period when the payment should be charged e.g. 1st of month, 15th etc. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $cycle_day; /** * Next scheduled date * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $next_sched_contribution_date; /** * Number of failed charge attempts since last success. Business rule could be set to deactivate on more than x failures. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $failure_count; /** * Date to retry failed attempt * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $failure_retry_date; /** * Some systems allow contributor to set a number of installments - but then auto-renew the subscription or commitment if they do not cancel. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $auto_renew; /** * Foreign key to civicrm_payment_processor.id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_processor_id; /** * FK to Financial Type * - * @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; /** * FK to Payment Instrument * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_instrument_id; /** * The campaign for which this contribution has been triggered. * - * @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; /** * if true, receipt is automatically emailed to contact on each successful payment * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_email_receipt; diff --git a/CRM/Contribute/DAO/ContributionSoft.php b/CRM/Contribute/DAO/ContributionSoft.php index d41e62bb5e..5db113938a 100644 --- a/CRM/Contribute/DAO/ContributionSoft.php +++ b/CRM/Contribute/DAO/ContributionSoft.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/ContributionSoft.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:48d432f2fe34f212c110e21cbd229fc5) + * (GenCodeChecksum:78899ec4310e1facc05fdb11cfac1432) */ /** @@ -34,64 +34,84 @@ class CRM_Contribute_DAO_ContributionSoft extends CRM_Core_DAO { /** * Soft Credit ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to contribution table. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_id; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Amount of this soft credit. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount; /** * 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; /** * FK to civicrm_pcp.id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $pcp_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $pcp_display_in_roll; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $pcp_roll_nickname; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $pcp_personal_note; /** * Soft Credit Type ID.Implicit FK to civicrm_option_value where option_group = soft_credit_type. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $soft_credit_type_id; diff --git a/CRM/Contribute/DAO/Premium.php b/CRM/Contribute/DAO/Premium.php index 6c9603b22d..803ac3598f 100644 --- a/CRM/Contribute/DAO/Premium.php +++ b/CRM/Contribute/DAO/Premium.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/Premium.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:7ea059e7d6ccfe258964ab274089ac60) + * (GenCodeChecksum:a458d7c03a26386d799d9d69db691051) */ /** @@ -32,7 +32,9 @@ class CRM_Contribute_DAO_Premium extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -40,65 +42,85 @@ class CRM_Contribute_DAO_Premium extends CRM_Core_DAO { * Joins these premium settings to another object. Always civicrm_contribution_page for now. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Is the Premiums feature enabled for this page? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $premiums_active; /** * Title for Premiums section. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $premiums_intro_title; /** * Displayed in
at top of Premiums section of page. 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 $premiums_intro_text; /** * This email address is included in receipts if it is populated and a premium has been selected. * - * @var string + * @var string|null + * (SQL type: varchar(100)) + * Note that values will be retrieved from the database as a string. */ public $premiums_contact_email; /** * This phone number is included in receipts if it is populated and a premium has been selected. * - * @var string + * @var string|null + * (SQL type: varchar(50)) + * Note that values will be retrieved from the database as a string. */ public $premiums_contact_phone; /** * Boolean. Should we automatically display minimum contribution amount text after the premium descriptions. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $premiums_display_min_contribution; /** * Label displayed for No Thank-you option in premiums block (e.g. No thank you) * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $premiums_nothankyou_label; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $premiums_nothankyou_position; diff --git a/CRM/Contribute/DAO/PremiumsProduct.php b/CRM/Contribute/DAO/PremiumsProduct.php index 29c595b380..7e68aed245 100644 --- a/CRM/Contribute/DAO/PremiumsProduct.php +++ b/CRM/Contribute/DAO/PremiumsProduct.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/PremiumsProduct.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:41745812fcc812419159f6a93b52a715) + * (GenCodeChecksum:46c21503a7dd4e0e8dc4b2221ae8bd0a) */ /** @@ -34,33 +34,43 @@ class CRM_Contribute_DAO_PremiumsProduct extends CRM_Core_DAO { /** * Contribution ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign key to premiums settings record. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $premiums_id; /** * Foreign key to each product object. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $product_id; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * FK to Financial Type. * - * @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; diff --git a/CRM/Contribute/DAO/Product.php b/CRM/Contribute/DAO/Product.php index 81b1ef81b2..70b7ddee7c 100644 --- a/CRM/Contribute/DAO/Product.php +++ b/CRM/Contribute/DAO/Product.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/Product.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:b70d9c858ea4a663872931e6028b0ead) + * (GenCodeChecksum:91d2e693a0c58cadf111686646d057d6) */ /** @@ -39,7 +39,9 @@ class CRM_Contribute_DAO_Product extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -47,83 +49,107 @@ class CRM_Contribute_DAO_Product extends CRM_Core_DAO { * Required product/premium name * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Optional description of the product/premium. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Optional product sku or code. * - * @var string + * @var string|null + * (SQL type: varchar(50)) + * Note that values will be retrieved from the database as a string. */ public $sku; /** * Store comma-delimited list of color, size, etc. options for the product. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $options; /** * Full or relative URL to uploaded image - fullsize. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $image; /** * Full or relative URL to image thumbnail. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $thumbnail; /** * Sell price or market value for premiums. For tax-deductible contributions, this will be stored as non_deductible_amount in the contribution record. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $price; /** * 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; /** * FK to Financial Type. * - * @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; /** * Minimum contribution required to be eligible to select this premium. * - * @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_contribution; /** * Actual cost of this product. Useful to determine net return from sale or using this as an incentive. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $cost; /** * Disabling premium removes it from the premiums_premium join table below. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; @@ -131,40 +157,52 @@ class CRM_Contribute_DAO_Product extends CRM_Core_DAO { * Rolling means we set start/end based on current day, fixed means we set start/end for current year or month * (e.g. 1 year + fixed -> we would set start/end for 1/1/06 thru 12/31/06 for any premium chosen in 2006) * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $period_type; /** * Month and day (MMDD) that fixed period type subscription or membership starts. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $fixed_period_start_day; /** - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $duration_unit; /** * Number of units for total duration of subscription, service, membership (e.g. 12 Months). * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $duration_interval; /** * Frequency unit and interval allow option to store actual delivery frequency for a subscription or service. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $frequency_unit; /** * Number of units for delivery frequency of subscription, service, membership (e.g. every 3 Months). * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $frequency_interval; diff --git a/CRM/Contribute/DAO/Widget.php b/CRM/Contribute/DAO/Widget.php index 9891471e38..c2d381e35c 100644 --- a/CRM/Contribute/DAO/Widget.php +++ b/CRM/Contribute/DAO/Widget.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Contribute/Widget.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:b27e8be28af42d6dfa9a76589ed05d7b) + * (GenCodeChecksum:4148353263bb1ae6e21aff61b94cc701) */ /** @@ -34,101 +34,135 @@ class CRM_Contribute_DAO_Widget extends CRM_Core_DAO { /** * Contribution ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The Contribution Page which triggered this contribution * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_page_id; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Widget title. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * URL to Widget logo * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_logo; /** * Button title. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $button_title; /** * About description. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $about; /** * URL to Homepage. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_homepage; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_title; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_button; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_bar; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_main_text; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_main; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_main_bg; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_bg; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_about_link; /** - * @var string + * @var string|null + * (SQL type: varchar(10)) + * Note that values will be retrieved from the database as a string. */ public $color_homepage_link; diff --git a/CRM/Core/DAO/ActionLog.php b/CRM/Core/DAO/ActionLog.php index 3857d49fbf..94ab9bdc8f 100644 --- a/CRM/Core/DAO/ActionLog.php +++ b/CRM/Core/DAO/ActionLog.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/ActionLog.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:b2a5ecdfd400bdf2fe892f9391f8a7ea) + * (GenCodeChecksum:5437b79ba43089ace75ed2e072e7677e) */ /** @@ -31,70 +31,90 @@ class CRM_Core_DAO_ActionLog extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * FK to id of the entity that the action was performed on. Pseudo - FK. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * name of the entity table for the above id, e.g. civicrm_activity, civicrm_participant * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to the action schedule that this action originated from. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $action_schedule_id; /** * date time that the action was performed on. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $action_date_time; /** * Was there any error sending the reminder? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_error; /** * Description / text in case there was an error encountered. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $message; /** * Keeps track of the sequence number of this repetition. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $repetition_number; /** * Stores the date from the entity which triggered this reminder action (e.g. membership.end_date for most membership renewal reminders) * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $reference_date; diff --git a/CRM/Core/DAO/ActionMapping.php b/CRM/Core/DAO/ActionMapping.php index a337d7dc50..232b5eeb5d 100644 --- a/CRM/Core/DAO/ActionMapping.php +++ b/CRM/Core/DAO/ActionMapping.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/ActionMapping.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:bbddce29b37d3352bf681595ee0d3ffd) + * (GenCodeChecksum:47aaf423930a3ec40089a4b21caaae2c) */ /** @@ -31,63 +31,81 @@ class CRM_Core_DAO_ActionMapping extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Entity for which the reminder is created * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity; /** * Entity value * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_value; /** * Entity value label * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_value_label; /** * Entity status * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_status; /** * Entity status label * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_status_label; /** * Entity date * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_date_start; /** * Entity date * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_date_end; /** * Entity recipient * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_recipient; diff --git a/CRM/Core/DAO/ActionSchedule.php b/CRM/Core/DAO/ActionSchedule.php index 5f6a148e4b..8a01d1a99f 100644 --- a/CRM/Core/DAO/ActionSchedule.php +++ b/CRM/Core/DAO/ActionSchedule.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/ActionSchedule.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:35dfd5d26ce9445b37c831c51ccc5d7e) + * (GenCodeChecksum:ea596948c02894437bcc1a3f5b5c4f9d) */ /** @@ -31,290 +31,374 @@ class CRM_Core_DAO_ActionSchedule extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name of the action(reminder) * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Title of the action(reminder) * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Recipient * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $recipient; /** * Is this the recipient criteria limited to OR in addition to? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $limit_to; /** * Entity value * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $entity_value; /** * Entity status * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_status; /** * Reminder Interval. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $start_action_offset; /** * Time units for reminder. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $start_action_unit; /** * Reminder Action * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $start_action_condition; /** * Entity date * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $start_action_date; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_repeat; /** * Time units for repetition of reminder. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $repetition_frequency_unit; /** * Time interval for repeating the reminder. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $repetition_frequency_interval; /** * Time units till repetition of reminder. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $end_frequency_unit; /** * Time interval till repeating the reminder. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $end_frequency_interval; /** * Reminder Action till repeating the reminder. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $end_action; /** * Entity end date * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * Is this option active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Contact IDs to which reminder should be sent. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $recipient_manual; /** * listing based on recipient field. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $recipient_listing; /** * Body of the mailing in text format. * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $body_text; /** * Body of the mailing in html format. * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $body_html; /** * Content of the SMS text. * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $sms_body_text; /** * Subject of mailing * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** * Record Activity for this reminder? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $record_activity; /** * Name/ID of the mapping to use on this table * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $mapping_id; /** * FK to Group * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_id; /** * FK to the message template. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $msg_template_id; /** * FK to the message template. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $sms_template_id; /** * Date on which the reminder be sent. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $absolute_date; /** * Name in "from" field * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $from_name; /** * Email address in "from" field * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $from_email; /** * Send the message as email or sms or both. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $mode; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $sms_provider_id; /** * Used for repeating entity * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $used_for; /** * Used for multilingual installation * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $filter_contact_language; /** * Used for multilingual installation * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $communication_language; /** * When was the scheduled reminder created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the reminder was created or modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * Earliest date to consider start events from. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $effective_start_date; /** * Latest date to consider end events from. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $effective_end_date; diff --git a/CRM/Core/DAO/Address.php b/CRM/Core/DAO/Address.php index 83f8f7891f..d0ab74783c 100644 --- a/CRM/Core/DAO/Address.php +++ b/CRM/Core/DAO/Address.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Address.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:40a96138e8081eaba0460889f49cc1cf) + * (GenCodeChecksum:80a3c43c953f8fe1ddb7ac96cd926139) */ /** @@ -40,35 +40,45 @@ class CRM_Core_DAO_Address extends CRM_Core_DAO { /** * Unique Address ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Which Location does this address belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * Is this the primary address. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_primary; /** * Is this the billing address. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_billing; @@ -77,166 +87,214 @@ class CRM_Core_DAO_Address extends CRM_Core_DAO { * number OR P.O. Box). Apps should be able to determine physical location with this data (for mapping, mail * delivery, etc.). * - * @var string + * @var string|null + * (SQL type: varchar(96)) + * Note that values will be retrieved from the database as a string. */ public $street_address; /** * Numeric portion of address number on the street, e.g. For 112A Main St, the street_number = 112. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $street_number; /** * Non-numeric portion of address number on the street, e.g. For 112A Main St, the street_number_suffix = A * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $street_number_suffix; /** * Directional prefix, e.g. SE Main St, SE is the prefix. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $street_number_predirectional; /** * Actual street name, excluding St, Dr, Rd, Ave, e.g. For 112 Main St, the street_name = Main. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $street_name; /** * St, Rd, Dr, etc. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $street_type; /** * Directional prefix, e.g. Main St S, S is the suffix. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $street_number_postdirectional; /** * Secondary unit designator, e.g. Apt 3 or Unit # 14, or Bldg 1200 * - * @var string + * @var string|null + * (SQL type: varchar(16)) + * Note that values will be retrieved from the database as a string. */ public $street_unit; /** * Supplemental Address Information, Line 1 * - * @var string + * @var string|null + * (SQL type: varchar(96)) + * Note that values will be retrieved from the database as a string. */ public $supplemental_address_1; /** * Supplemental Address Information, Line 2 * - * @var string + * @var string|null + * (SQL type: varchar(96)) + * Note that values will be retrieved from the database as a string. */ public $supplemental_address_2; /** * Supplemental Address Information, Line 3 * - * @var string + * @var string|null + * (SQL type: varchar(96)) + * Note that values will be retrieved from the database as a string. */ public $supplemental_address_3; /** * City, Town or Village Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $city; /** * Which County does this address belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $county_id; /** * Which State_Province does this address belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $state_province_id; /** * Store the suffix, like the +4 part in the USPS system. * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $postal_code_suffix; /** * Store both US (zip5) AND international postal codes. App is responsible for country/region appropriate validation. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $postal_code; /** * USPS Bulk mailing code. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $usps_adc; /** * Which Country does this address belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $country_id; /** * Latitude * - * @var float + * @var float|string|null + * (SQL type: double) + * Note that values will be retrieved from the database as a string. */ public $geo_code_1; /** * Longitude * - * @var float + * @var float|string|null + * (SQL type: double) + * Note that values will be retrieved from the database as a string. */ public $geo_code_2; /** * Is this a manually entered geo code * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $manual_geo_code; /** * Timezone expressed as a UTC offset - e.g. United States CST would be written as "UTC-6". * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $timezone; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * FK to Address ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $master_id; diff --git a/CRM/Core/DAO/AddressFormat.php b/CRM/Core/DAO/AddressFormat.php index aad2567193..242d8c3b87 100644 --- a/CRM/Core/DAO/AddressFormat.php +++ b/CRM/Core/DAO/AddressFormat.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/AddressFormat.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:fc7e6c978b71e38b5357cee46708a649) + * (GenCodeChecksum:bdb3bcc498465d39e8bd700f5c3b64df) */ /** @@ -33,14 +33,18 @@ class CRM_Core_DAO_AddressFormat extends CRM_Core_DAO { /** * Address Format ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The format of an address * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $format; diff --git a/CRM/Core/DAO/Cache.php b/CRM/Core/DAO/Cache.php index 981ceebaad..7ab70b4f85 100644 --- a/CRM/Core/DAO/Cache.php +++ b/CRM/Core/DAO/Cache.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Cache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:da6b1275fea0ffb19d09613211f7628e) + * (GenCodeChecksum:2b7084711ac3f619ce6f0cc8361dffa4) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_Cache extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,41 +43,53 @@ class CRM_Core_DAO_Cache extends CRM_Core_DAO { * group name for cache element, useful in cleaning cache elements * * @var string + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $group_name; /** * Unique path name for cache element * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $path; /** * data associated with this path * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $data; /** * Component that this menu item belongs to * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $component_id; /** * When was the cache item created * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When should the cache item expire * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $expired_date; diff --git a/CRM/Core/DAO/Component.php b/CRM/Core/DAO/Component.php index 54b4aa5e2d..632b8ee610 100644 --- a/CRM/Core/DAO/Component.php +++ b/CRM/Core/DAO/Component.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Component.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:fd26fa740989a13ac1d91618c2059d57) + * (GenCodeChecksum:a5cc4308aa533a07f2528c5cd3a31896) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_Component extends CRM_Core_DAO { /** * Component ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,13 +43,17 @@ class CRM_Core_DAO_Component extends CRM_Core_DAO { * Name of the component. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Path to components main directory in a form of a class namespace. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $namespace; diff --git a/CRM/Core/DAO/Country.php b/CRM/Core/DAO/Country.php index 6a900cf540..dff3a8146c 100644 --- a/CRM/Core/DAO/Country.php +++ b/CRM/Core/DAO/Country.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Country.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:680f4faa9e939df6f6c4ba3f1efd7853) + * (GenCodeChecksum:7798fb6aea4643dd3f7189981c641012) */ /** @@ -40,70 +40,90 @@ class CRM_Core_DAO_Country extends CRM_Core_DAO { /** * Country ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Country Name * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * ISO Code * - * @var string + * @var string|null + * (SQL type: char(2)) + * Note that values will be retrieved from the database as a string. */ public $iso_code; /** * National prefix to be used when dialing TO this country. * - * @var string + * @var string|null + * (SQL type: varchar(4)) + * Note that values will be retrieved from the database as a string. */ public $country_code; /** * Foreign key to civicrm_address_format.id. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $address_format_id; /** * International direct dialing prefix from within the country TO another country * - * @var string + * @var string|null + * (SQL type: varchar(4)) + * Note that values will be retrieved from the database as a string. */ public $idd_prefix; /** * Access prefix to call within a country to a different area * - * @var string + * @var string|null + * (SQL type: varchar(4)) + * Note that values will be retrieved from the database as a string. */ public $ndd_prefix; /** * Foreign key to civicrm_worldregion.id. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $region_id; /** * Should state/province be displayed as abbreviation for contacts from this country? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_province_abbreviated; /** * Is this Country active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Core/DAO/County.php b/CRM/Core/DAO/County.php index 0ab0d03f0f..d1f5bb8873 100644 --- a/CRM/Core/DAO/County.php +++ b/CRM/Core/DAO/County.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/County.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f54f7ff28a6ecde09252698c389db154) + * (GenCodeChecksum:5a261e24e77bb54854f782628a13dbf6) */ /** @@ -40,35 +40,45 @@ class CRM_Core_DAO_County extends CRM_Core_DAO { /** * County ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name of County * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * 2-4 Character Abbreviation of County * - * @var string + * @var string|null + * (SQL type: varchar(4)) + * Note that values will be retrieved from the database as a string. */ public $abbreviation; /** * ID of State/Province that County belongs * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $state_province_id; /** * Is this County active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Core/DAO/CustomField.php b/CRM/Core/DAO/CustomField.php index 0e2cb68355..b28303a25e 100644 --- a/CRM/Core/DAO/CustomField.php +++ b/CRM/Core/DAO/CustomField.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/CustomField.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:c093cac865bba7796c2c7deda6579f40) + * (GenCodeChecksum:6273bed0debfe48b5b7caf40b3ea78b2) */ /** @@ -53,21 +53,27 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO { /** * Unique Custom Field ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_custom_group. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $custom_group_id; /** * Variable name/programmatic handle for this field. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -75,6 +81,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO { * Text for form field label (also friendly name for administering this custom property). * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; @@ -82,6 +90,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO { * Controls location of data storage in extended_data table. * * @var string + * (SQL type: varchar(16)) + * Note that values will be retrieved from the database as a string. */ public $data_type; @@ -89,181 +99,233 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO { * HTML types plus several built-in extended types. * * @var string + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $html_type; /** * Use form_options.is_default for field_types which use options. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $default_value; /** * Is a value required for this property. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_required; /** * Is this property searchable. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_searchable; /** * Is this property range searchable. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_search_range; /** * Controls field display order within an extended property group. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Description and/or help text to display before this field. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * Description and/or help text to display after this field. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Optional format instructions for specific field types, like date types. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $mask; /** * Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $attributes; /** * Optional scripting attributes for field. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $javascript; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this property set by PHP Code? A code field is viewable but not editable * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_view; /** * number of options per line for checkbox and radio * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $options_per_line; /** * field length if alphanumeric * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $text_length; /** * Date may be up to start_date_years years prior to the current date. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $start_date_years; /** * Date may be up to end_date_years years after the current date. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $end_date_years; /** * date format for custom date * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $date_format; /** * time format for custom date * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $time_format; /** * Number of columns in Note Field * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $note_columns; /** * Number of rows in Note Field * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $note_rows; /** * Name of the column that holds the values for this field. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $column_name; /** * For elements with options, the option group id that is used * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $option_group_id; /** * Serialization method - a non-zero value indicates a multi-valued field. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $serialize; /** * Stores Contact Get API params contact reference custom fields. May be used for other filters in the future. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $filter; /** * Should the multi-record custom field values be displayed in tab table listing * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $in_selector; diff --git a/CRM/Core/DAO/CustomGroup.php b/CRM/Core/DAO/CustomGroup.php index a57c659aae..e15adbf24a 100644 --- a/CRM/Core/DAO/CustomGroup.php +++ b/CRM/Core/DAO/CustomGroup.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/CustomGroup.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:57ebfb396e58116709f9d883a46edfa7) + * (GenCodeChecksum:e2730dbbc3151ef18d9aeba73577fa96) */ /** @@ -52,14 +52,18 @@ class CRM_Core_DAO_CustomGroup extends CRM_Core_DAO { /** * Unique Custom Group ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Variable name/programmatic handle for this group. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -67,139 +71,179 @@ class CRM_Core_DAO_CustomGroup extends CRM_Core_DAO { * Friendly Name. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Type of object this group extends (can add other options later e.g. contact_address, etc.). * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $extends; /** * FK to civicrm_option_value.id (for option group custom_data_type.) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $extends_entity_column_id; /** * linking custom group for dynamic object * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $extends_entity_column_value; /** * Visual relationship between this form and its parent. * - * @var string + * @var string|null + * (SQL type: varchar(15)) + * Note that values will be retrieved from the database as a string. */ public $style; /** * Will this group be in collapsed or expanded mode on initial display ? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $collapse_display; /** * Description and/or help text to display before fields in form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * Description and/or help text to display after fields in form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Controls display order when multiple extended property groups are setup for the same class. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Name of the table that holds the values for this group. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $table_name; /** * Does this group hold multiple values? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_multiple; /** * minimum number of multiple records (typically 0?) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $min_multiple; /** * maximum number of multiple records, if 0 - no max * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $max_multiple; /** * Will this group be in collapsed or expanded mode on advanced search display ? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $collapse_adv_display; /** * FK to civicrm_contact, who created this custom group * - * @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 this custom group 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; /** * Is this a reserved Custom Group? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this property public? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_public; /** * crm-i icon class * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $icon; diff --git a/CRM/Core/DAO/Dashboard.php b/CRM/Core/DAO/Dashboard.php index 4283041796..6121094d5e 100644 --- a/CRM/Core/DAO/Dashboard.php +++ b/CRM/Core/DAO/Dashboard.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Dashboard.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9603ee2a3a27196ef1ec671bf758a783) + * (GenCodeChecksum:c93931e695d897a5f4ad92e388748424) */ /** @@ -31,84 +31,108 @@ class CRM_Core_DAO_Dashboard extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Domain for dashboard * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Internal name of dashlet. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * dashlet title * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * url in case of external dashlet * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url; /** * Permission for the dashlet * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $permission; /** * Permission Operator * - * @var string + * @var string|null + * (SQL type: varchar(3)) + * Note that values will be retrieved from the database as a string. */ public $permission_operator; /** * fullscreen url for dashlet * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $fullscreen_url; /** * Is this dashlet active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this dashlet reserved? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Number of minutes to cache dashlet content in browser localStorage. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $cache_minutes; /** * Element name of angular directive to invoke (lowercase hyphenated format) * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $directive; diff --git a/CRM/Core/DAO/Discount.php b/CRM/Core/DAO/Discount.php index a1d65e4876..67d1321b41 100644 --- a/CRM/Core/DAO/Discount.php +++ b/CRM/Core/DAO/Discount.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Discount.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:681876b76553a2f0db5a0c0f9d18eda0) + * (GenCodeChecksum:bb48d26bc26ec7473c0d22b93275828c) */ /** @@ -33,42 +33,54 @@ class CRM_Core_DAO_Discount extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * physical tablename for entity being joined to discount, e.g. civicrm_event * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * FK to civicrm_price_set * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $price_set_id; /** * Date when discount starts. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * Date when discount ends. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; diff --git a/CRM/Core/DAO/Domain.php b/CRM/Core/DAO/Domain.php index 743582be7d..a25ef21408 100644 --- a/CRM/Core/DAO/Domain.php +++ b/CRM/Core/DAO/Domain.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Domain.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:e10798e1d9921d637856a2dfcf7738dc) + * (GenCodeChecksum:941a0821b88a9225d9672cc25daa16f7) */ /** @@ -33,49 +33,63 @@ class CRM_Core_DAO_Domain extends CRM_Core_DAO { /** * Domain ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name of Domain / Organization * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Description of Domain. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * The civicrm version this instance is running * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $version; /** * FK to Contact ID. This is specifically not an FK to avoid circular constraints * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * list of locales supported by the current db state (NULL for single-lang install) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $locales; /** * Locale specific string overrides * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $locale_custom_strings; diff --git a/CRM/Core/DAO/Email.php b/CRM/Core/DAO/Email.php index 81f8f4259a..739ea4b164 100644 --- a/CRM/Core/DAO/Email.php +++ b/CRM/Core/DAO/Email.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Email.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:7e30aa415b50a25add79b9553b5d7657) + * (GenCodeChecksum:2a48ebd09a4f1de290856c1e7315ce69) */ /** @@ -47,84 +47,108 @@ class CRM_Core_DAO_Email extends CRM_Core_DAO { /** * Unique Email ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Which Location does this email belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * Email address * - * @var string + * @var string|null + * (SQL type: varchar(254)) + * Note that values will be retrieved from the database as a string. */ public $email; /** * Is this the primary email address * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_primary; /** * Is this the billing? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_billing; /** * Implicit FK to civicrm_option_value where option_group = email_on_hold. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $on_hold; /** * Is this address for bulk mail ? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_bulkmail; /** * When the address went on bounce hold * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $hold_date; /** * When the address bounce status was last reset * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $reset_date; /** * Text formatted signature for the email. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $signature_text; /** * HTML formatted signature for the email. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $signature_html; diff --git a/CRM/Core/DAO/EntityFile.php b/CRM/Core/DAO/EntityFile.php index 6b86fd5d41..fd3d56f363 100644 --- a/CRM/Core/DAO/EntityFile.php +++ b/CRM/Core/DAO/EntityFile.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/EntityFile.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:db6759b7a93a170611ad4eb003cb9f54) + * (GenCodeChecksum:d55d2dfbb297a954c71f0395e31a21d3) */ /** @@ -33,28 +33,36 @@ class CRM_Core_DAO_EntityFile extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * physical tablename for entity being joined to file, e.g. civicrm_contact * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * FK to civicrm_file * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $file_id; diff --git a/CRM/Core/DAO/EntityTag.php b/CRM/Core/DAO/EntityTag.php index c5ed9f3f32..a46c13f955 100644 --- a/CRM/Core/DAO/EntityTag.php +++ b/CRM/Core/DAO/EntityTag.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/EntityTag.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:c5bfb60ebd84dbe86b8dd8b522fd11e6) + * (GenCodeChecksum:cabc3d8a72fecadc4d531226b1db4c1d) */ /** @@ -33,28 +33,36 @@ class CRM_Core_DAO_EntityTag extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * physical tablename for entity being joined to file, e.g. civicrm_contact * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * FK to civicrm_tag * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $tag_id; diff --git a/CRM/Core/DAO/Extension.php b/CRM/Core/DAO/Extension.php index 389961ba32..76ea4c5d76 100644 --- a/CRM/Core/DAO/Extension.php +++ b/CRM/Core/DAO/Extension.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Extension.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:8d9c173c0d7da38d4c28c6b712aecee0) + * (GenCodeChecksum:ff39cae78a2b4804c72ed90b8f22606b) */ /** @@ -33,12 +33,16 @@ class CRM_Core_DAO_Extension extends CRM_Core_DAO { /** * Local Extension ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * @var string + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $type; @@ -46,41 +50,53 @@ class CRM_Core_DAO_Extension extends CRM_Core_DAO { * Fully qualified extension name * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $full_name; /** * Short name * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Short, printable name * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * Primary PHP file * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $file; /** * Revision code of the database schema; the format is module-defined * - * @var string + * @var string|null + * (SQL type: varchar(63)) + * Note that values will be retrieved from the database as a string. */ public $schema_version; /** * Is this extension active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Core/DAO/File.php b/CRM/Core/DAO/File.php index 51ffc3b345..4b6060d029 100644 --- a/CRM/Core/DAO/File.php +++ b/CRM/Core/DAO/File.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/File.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6bf3c3f06e1c01d91a6c6cf5ada7a889) + * (GenCodeChecksum:432bca89c164c512fa77945f8958e60d) */ /** @@ -33,56 +33,72 @@ class CRM_Core_DAO_File extends CRM_Core_DAO { /** * Unique ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Type of file (e.g. Transcript, Income Tax Return, etc). 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 $file_type_id; /** * mime type of the document * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $mime_type; /** * uri of the file on disk * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $uri; /** * contents of the document * - * @var mediumblob + * @var string|null + * (SQL type: mediumblob) + * Note that values will be retrieved from the database as a string. */ public $document; /** * Additional descriptive text regarding this attachment (optional). * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Date and time that this attachment was uploaded or written to server. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $upload_date; /** * FK to civicrm_contact, who uploaded this file * - * @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; diff --git a/CRM/Core/DAO/IM.php b/CRM/Core/DAO/IM.php index 5faf041d31..1547662bf9 100644 --- a/CRM/Core/DAO/IM.php +++ b/CRM/Core/DAO/IM.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/IM.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:179c338e66288123b7ca45c78ad57fcc) + * (GenCodeChecksum:830e0ccbcdcfe1769330d4cfb39f3285) */ /** @@ -47,49 +47,63 @@ class CRM_Core_DAO_IM extends CRM_Core_DAO { /** * Unique IM ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Which Location does this email belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * IM screen name * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Which IM Provider does this screen name belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $provider_id; /** * Is this the primary IM for this contact and location. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_primary; /** * Is this the billing? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_billing; diff --git a/CRM/Core/DAO/Job.php b/CRM/Core/DAO/Job.php index 878a316811..65d3519805 100644 --- a/CRM/Core/DAO/Job.php +++ b/CRM/Core/DAO/Job.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Job.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:e5798e1ce73654af23730d7188a0c963) + * (GenCodeChecksum:75ec772bec625c1d315df0abadd2fca6) */ /** @@ -33,77 +33,99 @@ class CRM_Core_DAO_Job extends CRM_Core_DAO { /** * Job ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this scheduled job for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Scheduled job run frequency. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $run_frequency; /** * When was this cron entry last run * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $last_run; /** * When is this cron entry scheduled to run * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $scheduled_run_date; /** * Title of the job * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Description of the job * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Entity of the job api call * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $api_entity; /** * Action of the job api call * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $api_action; /** * List of parameters to the command. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $parameters; /** * Is this job active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Core/DAO/JobLog.php b/CRM/Core/DAO/JobLog.php index 9f73d5f82c..a1a4022db2 100644 --- a/CRM/Core/DAO/JobLog.php +++ b/CRM/Core/DAO/JobLog.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/JobLog.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6677b28207cbf86835164b7b33c38608) + * (GenCodeChecksum:10c668f93f466aa0d49d258b6bc7badd) */ /** @@ -33,56 +33,72 @@ class CRM_Core_DAO_JobLog extends CRM_Core_DAO { /** * Job log entry ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this scheduled job for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Log entry date * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $run_time; /** * Pointer to job id - not a FK though, just for logging purposes * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $job_id; /** * Title of the job * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Full path to file containing job script * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $command; /** * Title line of log entry * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Potential extended data for specific job run (e.g. tracebacks). * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $data; diff --git a/CRM/Core/DAO/LocBlock.php b/CRM/Core/DAO/LocBlock.php index 32b74aab2c..dc0adb8b54 100644 --- a/CRM/Core/DAO/LocBlock.php +++ b/CRM/Core/DAO/LocBlock.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/LocBlock.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0da5161ce83d29bc7626c1a3b74b2950) + * (GenCodeChecksum:4153042d9ec41d2841dc085180f6e16b) */ /** @@ -40,47 +40,65 @@ class CRM_Core_DAO_LocBlock extends CRM_Core_DAO { /** * Unique ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $address_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $email_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $im_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $address_2_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $email_2_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_2_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $im_2_id; diff --git a/CRM/Core/DAO/LocationType.php b/CRM/Core/DAO/LocationType.php index fe2b14131a..7251f45583 100644 --- a/CRM/Core/DAO/LocationType.php +++ b/CRM/Core/DAO/LocationType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/LocationType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f9c5e451793d7a168906f173ea492ba7) + * (GenCodeChecksum:7bf7552cfdc3988c4582bccaea302c5f) */ /** @@ -33,56 +33,72 @@ class CRM_Core_DAO_LocationType extends CRM_Core_DAO { /** * Location Type ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Location Type Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Location Type Display Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $display_name; /** * vCard Location Type Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $vcard_name; /** * Location Type Description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Is this location type a predefined system location? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this location type the default? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; diff --git a/CRM/Core/DAO/Log.php b/CRM/Core/DAO/Log.php index dcbc1e2340..da8bbdad17 100644 --- a/CRM/Core/DAO/Log.php +++ b/CRM/Core/DAO/Log.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Log.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:8fe4326f940304ec2c8ea86754d6142e) + * (GenCodeChecksum:b2552b667e074cb7bb4132eac8153df2) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_Log extends CRM_Core_DAO { /** * Log ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,34 +43,44 @@ class CRM_Core_DAO_Log extends CRM_Core_DAO { * Name of table where item being referenced is stored. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Foreign key to the referenced item. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Updates does to this object if any. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $data; /** * FK to Contact ID of person under whose credentials this data modification was made. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $modified_id; /** * When was the referenced entity created or modified or deleted. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/CRM/Core/DAO/MailSettings.php b/CRM/Core/DAO/MailSettings.php index db6854affc..206ce6c086 100644 --- a/CRM/Core/DAO/MailSettings.php +++ b/CRM/Core/DAO/MailSettings.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/MailSettings.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:116c87968f4c16758eff8825047a6ceb) + * (GenCodeChecksum:d0b9b61f890ea3ff893f8d4e03d0afcd) */ /** @@ -33,117 +33,151 @@ class CRM_Core_DAO_MailSettings extends CRM_Core_DAO { /** * primary key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this match entry for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * name of this group of settings * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * whether this is the default set of settings for this domain * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * email address domain (the part after @) * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $domain; /** * optional local part (like civimail+ for addresses like civimail+s.1.2@example.com) * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $localpart; /** * contents of the Return-Path header * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $return_path; /** * name of the protocol to use for polling (like IMAP, POP3 or Maildir) * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $protocol; /** * server to use when polling * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $server; /** * port to use when polling * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $port; /** * username to use when polling * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $username; /** * password to use when polling * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $password; /** * whether to use SSL or not * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_ssl; /** * folder to poll from when using IMAP, path to poll from when using Maildir, etc. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $source; /** * Name of status to use when creating email to activity. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $activity_status; /** * Enabling this option will have CiviCRM skip any emails that do not have the Case ID or Case Hash so that the system will only process emails that can be placed on case records. Any emails that are not processed will be moved to the ignored folder. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_non_case_email_skipped; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_contact_creation_disabled_if_no_match; diff --git a/CRM/Core/DAO/Managed.php b/CRM/Core/DAO/Managed.php index 3e0789e97d..c073117f92 100644 --- a/CRM/Core/DAO/Managed.php +++ b/CRM/Core/DAO/Managed.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Managed.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:ca11b419bcdf2bce26609d9488527023) + * (GenCodeChecksum:54b79cae396d1c5044406fc97ae60352) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO { /** * Surrogate Key * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,13 +43,17 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO { * Name of the module which declared this object * * @var string + * (SQL type: varchar(127)) + * Note that values will be retrieved from the database as a string. */ public $module; /** * Symbolic name used by the module to identify the object * - * @var string + * @var string|null + * (SQL type: varchar(127)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -55,27 +61,35 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO { * API entity type * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_type; /** * Foreign key to the referenced item. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Policy on when to cleanup entity (always, never, unused) * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $cleanup; /** * When the managed entity was changed from its original settings. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $entity_modified_date; diff --git a/CRM/Core/DAO/Mapping.php b/CRM/Core/DAO/Mapping.php index 3ace2b661c..491e451e0a 100644 --- a/CRM/Core/DAO/Mapping.php +++ b/CRM/Core/DAO/Mapping.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Mapping.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4a0976e14e588b9a81c79e72849494e0) + * (GenCodeChecksum:c69c9d834bfaaf44088ae0cd11e36b5f) */ /** @@ -33,28 +33,36 @@ class CRM_Core_DAO_Mapping extends CRM_Core_DAO { /** * Mapping ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name of Mapping * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Description of Mapping. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Mapping Type * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mapping_type_id; diff --git a/CRM/Core/DAO/MappingField.php b/CRM/Core/DAO/MappingField.php index 833fdff45f..5afe384472 100644 --- a/CRM/Core/DAO/MappingField.php +++ b/CRM/Core/DAO/MappingField.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/MappingField.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4333a20d925fb437b4764219e31ee017) + * (GenCodeChecksum:43e4b1c405dfce18840eca9d73aa70e7) */ /** @@ -33,75 +33,97 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO { /** * Mapping Field ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Mapping to which this field belongs * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mapping_id; /** * Mapping field key * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Contact Type in mapping * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $contact_type; /** * Column number for mapping set * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $column_number; /** * Location type of this mapping, if required * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * Which type of phone does this number belongs. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_type_id; /** * Which type of IM Provider does this name belong. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $im_provider_id; /** * Which type of website does this site belong * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $website_type_id; /** * Relationship type, if required * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $relationship_type_id; /** - * @var string + * @var string|null + * (SQL type: varchar(6)) + * Note that values will be retrieved from the database as a string. */ public $relationship_direction; @@ -109,21 +131,27 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO { * Used to group mapping_field records into related sets (e.g. for criteria sets in search builder * mappings). * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $grouping; /** * SQL WHERE operator for search-builder mapping fields (search criteria). * - * @var string + * @var string|null + * (SQL type: varchar(16)) + * Note that values will be retrieved from the database as a string. */ public $operator; /** * SQL WHERE value for search-builder mapping fields. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $value; diff --git a/CRM/Core/DAO/Menu.php b/CRM/Core/DAO/Menu.php index f70e8b2f91..d2fc425efc 100644 --- a/CRM/Core/DAO/Menu.php +++ b/CRM/Core/DAO/Menu.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Menu.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:43fa7e0ff85619af0065d2802de6f8f4) + * (GenCodeChecksum:a6c1c555579640a8bb83b496ee126e1a) */ /** @@ -31,152 +31,196 @@ class CRM_Core_DAO_Menu extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this menu item for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Path Name * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $path; /** * Arguments to pass to the url * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $path_arguments; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Function to call to check access permissions * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $access_callback; /** * Arguments to pass to access callback * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $access_arguments; /** * function to call for this url * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $page_callback; /** * Arguments to pass to page callback * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $page_arguments; /** * Breadcrumb for the path. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $breadcrumb; /** * Url where a page should redirected to, if next url not known. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $return_url; /** * Arguments to pass to return_url * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $return_url_args; /** * Component that this menu item belongs to * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $component_id; /** * Is this menu item active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this menu accessible to the public? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_public; /** * Is this menu exposed to the navigation system? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_exposed; /** * Should this menu be exposed via SSL if enabled? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_ssl; /** * Ordering of the menu items in various blocks. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Drupal menu type. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $type; /** * CiviCRM menu type. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $page_type; /** * skip this url being exposed to breadcrumb * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $skipBreadcrumb; /** * All other menu metadata not stored in other fields * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $module_data; diff --git a/CRM/Core/DAO/MessageTemplate.php b/CRM/Core/DAO/MessageTemplate.php index e44de41b2f..72c9001567 100644 --- a/CRM/Core/DAO/MessageTemplate.php +++ b/CRM/Core/DAO/MessageTemplate.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/MessageTemplate.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:8e8480f41073e41a72f3d600e5776d0d) + * (GenCodeChecksum:1fba7635baeb10d95b90c02ca4ea99c6) */ /** @@ -33,80 +33,104 @@ class CRM_Core_DAO_MessageTemplate extends CRM_Core_DAO { /** * Message Template ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Descriptive title of message * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $msg_title; /** * Subject for email message. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $msg_subject; /** * Text formatted message * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $msg_text; /** * HTML formatted message * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $msg_html; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * a pseudo-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 $workflow_id; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $workflow_name; /** * is this the default message template for the workflow referenced by workflow_id? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * is this the reserved message template which we ship for the workflow referenced by workflow_id? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this message template used for sms? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_sms; /** * a pseudo-FK to civicrm_option_value containing PDF Page Format. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $pdf_format_id; diff --git a/CRM/Core/DAO/Navigation.php b/CRM/Core/DAO/Navigation.php index 3b60e5d2ca..b53aad0db9 100644 --- a/CRM/Core/DAO/Navigation.php +++ b/CRM/Core/DAO/Navigation.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Navigation.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:a26cb263ead3cb0d9bb3f0fda7fbec3c) + * (GenCodeChecksum:58328e2bbd1fd9c5f9255596ef0de177) */ /** @@ -38,35 +38,45 @@ class CRM_Core_DAO_Navigation extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this navigation item for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Navigation Title * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * Internal Name * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * url in case of custom navigation link * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url; @@ -74,48 +84,62 @@ class CRM_Core_DAO_Navigation extends CRM_Core_DAO { * CSS class name for an icon * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $icon; /** * Permission(s) needed to access menu item * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $permission; /** * Operator to use if item has more than one permission * - * @var string + * @var string|null + * (SQL type: varchar(3)) + * Note that values will be retrieved from the database as a string. */ public $permission_operator; /** * Parent navigation item, used for grouping * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Is this navigation item active? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Place a separator either before or after this menu item. * - * @var int + * @var int|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $has_separator; /** * Ordering of the navigation items in various blocks. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; diff --git a/CRM/Core/DAO/Note.php b/CRM/Core/DAO/Note.php index 4370b6d075..e70f2b811a 100644 --- a/CRM/Core/DAO/Note.php +++ b/CRM/Core/DAO/Note.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Note.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:49a15912788803e8ccf5298fe93932aa) + * (GenCodeChecksum:5f542bdf0c411eeefbf3ec22514d7407) */ /** @@ -40,7 +40,9 @@ class CRM_Core_DAO_Note extends CRM_Core_DAO { /** * Note ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -48,62 +50,80 @@ class CRM_Core_DAO_Note extends CRM_Core_DAO { * Name of table where item being referenced is stored. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Foreign key to the referenced item. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Note and/or Comment. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $note; /** * FK to Contact ID creator * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Date attached to the note * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $note_date; /** * When the note was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When was this note last modified/edited * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * subject of note description * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** * Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK) * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $privacy; diff --git a/CRM/Core/DAO/OpenID.php b/CRM/Core/DAO/OpenID.php index 166758db6f..c5413e170d 100644 --- a/CRM/Core/DAO/OpenID.php +++ b/CRM/Core/DAO/OpenID.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/OpenID.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6547ff2f60e61de44f3ca5a866c1df6a) + * (GenCodeChecksum:0e8f41d1f528dfadc08d7f53610948ca) */ /** @@ -33,42 +33,54 @@ class CRM_Core_DAO_OpenID extends CRM_Core_DAO { /** * Unique OpenID ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Which Location does this email belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $openid; /** * Whether or not this user is allowed to login * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $allowed_to_login; /** * Is this the primary email for this contact and location. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_primary; diff --git a/CRM/Core/DAO/OptionGroup.php b/CRM/Core/DAO/OptionGroup.php index 59dfd5c4e0..77f9c5eed8 100644 --- a/CRM/Core/DAO/OptionGroup.php +++ b/CRM/Core/DAO/OptionGroup.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/OptionGroup.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6be4b908c7861e9026d1f2d78c42a0ac) + * (GenCodeChecksum:904ff47234843ffba9dd98b11c1d0df1) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_OptionGroup extends CRM_Core_DAO { /** * Option Group ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,48 +43,62 @@ class CRM_Core_DAO_OptionGroup extends CRM_Core_DAO { * Option group name. Used as selection key by class properties which lookup options in civicrm_option_value. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Option Group title. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Option group description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Option group description. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $data_type; /** * Is this a predefined system option group (i.e. it can not be deleted)? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this option group active? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * A lock to remove the ability to add new options via the UI. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_locked; diff --git a/CRM/Core/DAO/OptionValue.php b/CRM/Core/DAO/OptionValue.php index f1a2b41164..03429a8a30 100644 --- a/CRM/Core/DAO/OptionValue.php +++ b/CRM/Core/DAO/OptionValue.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/OptionValue.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:598cce8df447dc19cd4c846549be1141) + * (GenCodeChecksum:36f4f8d1b40d94da47ebebaf3cf77f09) */ /** @@ -43,14 +43,18 @@ class CRM_Core_DAO_OptionValue extends CRM_Core_DAO { /** * Option ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Group which this option belongs to. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $option_group_id; @@ -58,6 +62,8 @@ class CRM_Core_DAO_OptionValue extends CRM_Core_DAO { * Option string as displayed to users - e.g. the label in an HTML OPTION tag. * * @var string + * (SQL type: varchar(512)) + * Note that values will be retrieved from the database as a string. */ public $label; @@ -65,102 +71,132 @@ class CRM_Core_DAO_OptionValue extends CRM_Core_DAO { * The actual value stored (as a foreign key) in the data record. Functions which need lookup option_value.title should use civicrm_option_value.option_group_id plus civicrm_option_value.value as the key. * * @var string + * (SQL type: varchar(512)) + * Note that values will be retrieved from the database as a string. */ public $value; /** * Stores a fixed (non-translated) name for this option value. Lookup functions should use the name as the key for the option value row. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Use to sort and/or set display properties for sub-set(s) of options within an option group. EXAMPLE: Use for college_interest field, to differentiate partners from non-partners. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $grouping; /** * Bitwise logic can be used to create subsets of options within an option_group for different uses. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $filter; /** * Is this the default option for the group? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * Controls display sort order. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Optional description. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_optgroup; /** * Is this a predefined system object? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this option active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Component that this option value belongs/caters to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $component_id; /** * Which Domain is this option value for * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $visibility_id; /** * crm-i icon class * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $icon; /** * Hex color value e.g. #ffffff * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $color; diff --git a/CRM/Core/DAO/Phone.php b/CRM/Core/DAO/Phone.php index c4918cc592..3241bf3f1d 100644 --- a/CRM/Core/DAO/Phone.php +++ b/CRM/Core/DAO/Phone.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Phone.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:632e24c7c46ff01ecb1acab879bcf625) + * (GenCodeChecksum:76f82c31308292a82535fb6bcf6acc4d) */ /** @@ -47,70 +47,90 @@ class CRM_Core_DAO_Phone extends CRM_Core_DAO { /** * Unique Phone ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Which Location does this phone belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * Is this the primary phone for this contact and location. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_primary; /** * Is this the billing? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_billing; /** * Which Mobile Provider does this phone belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mobile_provider_id; /** * Complete phone number. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $phone; /** * Optional extension for a phone number. * - * @var string + * @var string|null + * (SQL type: varchar(16)) + * Note that values will be retrieved from the database as a string. */ public $phone_ext; /** * Phone number stripped of all whitespace, letters, and punctuation. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $phone_numeric; /** * Which type of phone does this number belongs. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_type_id; diff --git a/CRM/Core/DAO/PreferencesDate.php b/CRM/Core/DAO/PreferencesDate.php index f0c15bc898..00db3be8fb 100644 --- a/CRM/Core/DAO/PreferencesDate.php +++ b/CRM/Core/DAO/PreferencesDate.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/PreferencesDate.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:767dc30f83e4087a07c185f857fc8fb3) + * (GenCodeChecksum:2d2dbd5815ee810c6ca0941dcdea2b2f) */ /** @@ -31,7 +31,9 @@ class CRM_Core_DAO_PreferencesDate extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -39,41 +41,53 @@ class CRM_Core_DAO_PreferencesDate extends CRM_Core_DAO { * The meta name for this date (fixed in code) * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Description of this date type. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * The start offset relative to current year * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $start; /** * The end offset relative to current year, can be negative * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $end; /** * The date type * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $date_format; /** * time format * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $time_format; diff --git a/CRM/Core/DAO/PrevNextCache.php b/CRM/Core/DAO/PrevNextCache.php index 8bcc48e614..9ab4943daa 100644 --- a/CRM/Core/DAO/PrevNextCache.php +++ b/CRM/Core/DAO/PrevNextCache.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/PrevNextCache.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:af3cb54c291525d39547cefa9bddf11a) + * (GenCodeChecksum:34c9a3b8f37f15fa5f0d9174e5e1c981) */ /** @@ -31,47 +31,61 @@ class CRM_Core_DAO_PrevNextCache extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * physical tablename for entity being joined to discount, e.g. civicrm_event * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id1; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id2; /** * Unique path name for cache element of the searched item * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $cachekey; /** * cached snapshot of the serialized data * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $data; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_selected; diff --git a/CRM/Core/DAO/PrintLabel.php b/CRM/Core/DAO/PrintLabel.php index 9fa29c8fca..73cd71cb68 100644 --- a/CRM/Core/DAO/PrintLabel.php +++ b/CRM/Core/DAO/PrintLabel.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/PrintLabel.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:cae6bd3ef03de9c99cd64c3c232fca54) + * (GenCodeChecksum:2ff186e7860c945a080bd0d8672dee5f) */ /** @@ -31,77 +31,99 @@ class CRM_Core_DAO_PrintLabel extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * User title for this label layout * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * variable name/programmatic handle for this field. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Description of this label layout * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * This refers to name column of civicrm_option_value row in name_badge option group * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label_format_name; /** * Implicit FK to civicrm_option_value row in NEW label_type option group * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $label_type_id; /** * contains json encode configurations options * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $data; /** * Is this default? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * Is this option active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this reserved label? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * FK to civicrm_contact, who created this label layout * - * @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; diff --git a/CRM/Core/DAO/RecurringEntity.php b/CRM/Core/DAO/RecurringEntity.php index 276dad5b04..82eaa5e9d8 100644 --- a/CRM/Core/DAO/RecurringEntity.php +++ b/CRM/Core/DAO/RecurringEntity.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/RecurringEntity.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9176ce7b1312c05e06b2d744da945f83) + * (GenCodeChecksum:d8ff65b4009b67e8619f6f904c1b501d) */ /** @@ -31,21 +31,27 @@ class CRM_Core_DAO_RecurringEntity extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Recurring Entity Parent ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Recurring Entity Child ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; @@ -53,13 +59,17 @@ class CRM_Core_DAO_RecurringEntity extends CRM_Core_DAO { * Physical tablename for entity, e.g. civicrm_event * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * 1-this entity, 2-this and the following entities, 3-all the entities * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $mode; diff --git a/CRM/Core/DAO/Setting.php b/CRM/Core/DAO/Setting.php index cb03d030a9..32c4c45741 100644 --- a/CRM/Core/DAO/Setting.php +++ b/CRM/Core/DAO/Setting.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Setting.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:1cc77a956cd4dfc7dd2a7f22579ad742) + * (GenCodeChecksum:1540ee58b9ec485590f4ce8cfe94f5a4) */ /** @@ -31,63 +31,81 @@ class CRM_Core_DAO_Setting extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Unique name for setting * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * data associated with this group / name combo * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $value; /** * Which Domain is this menu item for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * FK to Contact ID if the setting is localized to a contact * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Is this setting a contact specific or site wide setting? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_domain; /** * Component that this menu item belongs to * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $component_id; /** * When was the setting created * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * FK to civicrm_contact, who created this setting * - * @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; diff --git a/CRM/Core/DAO/StateProvince.php b/CRM/Core/DAO/StateProvince.php index 66f8bfe33a..a07f290a77 100644 --- a/CRM/Core/DAO/StateProvince.php +++ b/CRM/Core/DAO/StateProvince.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/StateProvince.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:d99e943649a1c2db96c2111d7feeeec2) + * (GenCodeChecksum:fe8e2b8bd40cc99eb28b66260a48da80) */ /** @@ -40,35 +40,45 @@ class CRM_Core_DAO_StateProvince extends CRM_Core_DAO { /** * State/Province ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name of State/Province * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * 2-4 Character Abbreviation of State/Province * - * @var string + * @var string|null + * (SQL type: varchar(4)) + * Note that values will be retrieved from the database as a string. */ public $abbreviation; /** * ID of Country that State/Province belong * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $country_id; /** * Is this StateProvince active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Core/DAO/StatusPreference.php b/CRM/Core/DAO/StatusPreference.php index 4b3b3e0fc5..9331244143 100644 --- a/CRM/Core/DAO/StatusPreference.php +++ b/CRM/Core/DAO/StatusPreference.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/StatusPreference.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:97f98c6f510e57260d2a5e3647a00d4f) + * (GenCodeChecksum:73ca47fbe3712351ea43f57b993c7a92) */ /** @@ -33,14 +33,18 @@ class CRM_Core_DAO_StatusPreference extends CRM_Core_DAO { /** * Unique Status Preference ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this Status Preference for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; @@ -48,41 +52,53 @@ class CRM_Core_DAO_StatusPreference extends CRM_Core_DAO { * Name of the status check this preference references. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * expires ignore_severity. NULL never hushes. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $hush_until; /** * Hush messages up to and including this severity. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $ignore_severity; /** * These settings are per-check, and can't be compared across checks. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $prefs; /** * These values are per-check, and can't be compared across checks. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $check_info; /** * Is this status check active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Core/DAO/SystemLog.php b/CRM/Core/DAO/SystemLog.php index ea1920cf12..d11b4e0c1d 100644 --- a/CRM/Core/DAO/SystemLog.php +++ b/CRM/Core/DAO/SystemLog.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/SystemLog.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:1dd363d9554947bfdd8c75bba4ee5da9) + * (GenCodeChecksum:0859d091be6dca4edd108b6a1803ef35) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_SystemLog extends CRM_Core_DAO { /** * Primary key ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,41 +43,53 @@ class CRM_Core_DAO_SystemLog extends CRM_Core_DAO { * Standardized message * * @var string + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $message; /** * JSON encoded data * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $context; /** * error level per PSR3 * - * @var string + * @var string|null + * (SQL type: varchar(9)) + * Note that values will be retrieved from the database as a string. */ public $level; /** * Timestamp of when event occurred. * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $timestamp; /** * Optional Contact ID that created the log. Not an FK as we keep this regardless * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Optional Name of logging host * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $hostname; diff --git a/CRM/Core/DAO/Tag.php b/CRM/Core/DAO/Tag.php index fb94ad6d9d..3dcf7dbf5d 100644 --- a/CRM/Core/DAO/Tag.php +++ b/CRM/Core/DAO/Tag.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Tag.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6bf223ca710a35bc6fb4c5e3f373b214) + * (GenCodeChecksum:4e8a87bf73d5f2f09dacdd4891ee7305) */ /** @@ -47,7 +47,9 @@ class CRM_Core_DAO_Tag extends CRM_Core_DAO { /** * Tag ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -55,63 +57,83 @@ class CRM_Core_DAO_Tag extends CRM_Core_DAO { * Name of Tag. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Optional verbose description of the tag. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Optional parent id for this tag. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Is this tag selectable / displayed * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_selectable; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_tagset; /** - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $used_for; /** * FK to civicrm_contact, who created this tag * - * @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; /** * Hex color value e.g. #ffffff * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $color; /** * Date and time that tag 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; diff --git a/CRM/Core/DAO/Timezone.php b/CRM/Core/DAO/Timezone.php index 20d5781b97..52d88dd7b6 100644 --- a/CRM/Core/DAO/Timezone.php +++ b/CRM/Core/DAO/Timezone.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Timezone.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:a1960975c14d40dedac3cbf6121044db) + * (GenCodeChecksum:bb3ae6e3a2a974f5a7e121a7ba763af6) */ /** @@ -33,40 +33,52 @@ class CRM_Core_DAO_Timezone extends CRM_Core_DAO { /** * Timezone ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Timezone full name * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * ISO Code for timezone abbreviation * - * @var string + * @var string|null + * (SQL type: char(3)) + * Note that values will be retrieved from the database as a string. */ public $abbreviation; /** * GMT name of the timezone * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $gmt; /** - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $offset; /** * Country ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $country_id; diff --git a/CRM/Core/DAO/Translation.php b/CRM/Core/DAO/Translation.php index aba20f3afa..57543feb3d 100644 --- a/CRM/Core/DAO/Translation.php +++ b/CRM/Core/DAO/Translation.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Translation.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:26a0aec7a4d0e31684a513f1a3f6fa18) + * (GenCodeChecksum:f0f986e6ba50631d51e09da061eb494a) */ /** @@ -33,7 +33,9 @@ class CRM_Core_DAO_Translation extends CRM_Core_DAO { /** * Unique String ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,6 +43,8 @@ class CRM_Core_DAO_Translation extends CRM_Core_DAO { * Table where referenced item is stored * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; @@ -48,13 +52,17 @@ class CRM_Core_DAO_Translation extends CRM_Core_DAO { * Field where referenced item is stored * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_field; /** * ID of the relevant entity. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $entity_id; @@ -62,20 +70,26 @@ class CRM_Core_DAO_Translation extends CRM_Core_DAO { * Relevant language * * @var string + * (SQL type: varchar(5)) + * Note that values will be retrieved from the database as a string. */ public $language; /** * Specify whether the string is active, draft, etc * - * @var int + * @var int|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * Translated string * - * @var longtext + * @var string + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $string; diff --git a/CRM/Core/DAO/UFField.php b/CRM/Core/DAO/UFField.php index ba2cdcba54..a35a7cc368 100644 --- a/CRM/Core/DAO/UFField.php +++ b/CRM/Core/DAO/UFField.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/UFField.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:47f3fbbbd8d816a9cfb9f7fb4e7d5dc4) + * (GenCodeChecksum:dbab868218968878ca554480f974c2b4) */ /** @@ -33,14 +33,18 @@ class CRM_Core_DAO_UFField extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which form does this field belong to. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $uf_group_id; @@ -48,90 +52,116 @@ class CRM_Core_DAO_UFField extends CRM_Core_DAO { * Name for CiviCRM field which is being exposed for sharing. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $field_name; /** * Is this field currently shareable? If false, hide the field for all sharing contexts. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * the field is view only and not editable in user forms. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_view; /** * Is this field required when included in a user or registration form? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_required; /** * Controls field display order when user framework fields are displayed in registration and account editing forms. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Description and/or help text to display after this field. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Description and/or help text to display before this field. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * In what context(s) is this field visible. * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $visibility; /** * Is this field included as a column in the selector table? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $in_selector; /** * Is this field included search form of profile? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_searchable; /** * Location type of this mapping, if required * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * Phone Type ID, if required * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_type_id; /** * Website Type ID, if required * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $website_type_id; @@ -139,27 +169,35 @@ class CRM_Core_DAO_UFField extends CRM_Core_DAO { * To save label for fields. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * This field saves field type (ie individual,household.. field etc). * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $field_type; /** * Is this field reserved for use by some other CiviCRM functionality? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Include in multi-record listing? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_multi_summary; diff --git a/CRM/Core/DAO/UFGroup.php b/CRM/Core/DAO/UFGroup.php index 919b38ac9c..37f9346e36 100644 --- a/CRM/Core/DAO/UFGroup.php +++ b/CRM/Core/DAO/UFGroup.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/UFGroup.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0cb6463f64d494ca888d10708269b63c) + * (GenCodeChecksum:6d64e2deaff9b8408d4110c44d0e8152) */ /** @@ -33,21 +33,27 @@ class CRM_Core_DAO_UFGroup extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Is this form currently active? If false, hide all related fields for all sharing contexts. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Comma separated list of the type(s) of profile fields. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $group_type; @@ -55,165 +61,213 @@ class CRM_Core_DAO_UFGroup extends CRM_Core_DAO { * Form title. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Profile Form Public title * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $frontend_title; /** * Optional verbose description of the profile. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Description and/or help text to display before fields in form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * Description and/or help text to display after fields in form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Group id, foreign key from civicrm_group * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $limit_listings_group_id; /** * Redirect to URL. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $post_URL; /** * foreign key to civicrm_group_id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $add_to_group_id; /** * Should a CAPTCHA widget be included this Profile form. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $add_captcha; /** * Do we want to map results from this profile. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_map; /** * Should edit link display in profile selector * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_edit_link; /** * Should we display a link to the website profile in profile selector * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_uf_link; /** * Should we update the contact record if we find a duplicate * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_update_dupe; /** * Redirect to URL when Cancle button clik . * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $cancel_URL; /** * Should we create a cms user for this profile * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_cms_user; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $notify; /** * Is this group reserved for use by some other CiviCRM functionality? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Name of the UF group for directly addressing it in the codebase * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * FK to civicrm_contact, who created this UF group * - * @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 this UF group 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; /** * Should we include proximity search feature in this profile search form? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_proximity_search; /** * Custom Text to display on the Cancel button when used in create or edit mode * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $cancel_button_text; /** * Custom Text to display on the submit button on profile edit/create screens * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $submit_button_text; /** * Should a Cancel button be included in this Profile form. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $add_cancel_button; diff --git a/CRM/Core/DAO/UFJoin.php b/CRM/Core/DAO/UFJoin.php index e60816d109..a3460bd94f 100644 --- a/CRM/Core/DAO/UFJoin.php +++ b/CRM/Core/DAO/UFJoin.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/UFJoin.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:ad3e1eb59e96ed7553d2a3f48430c934) + * (GenCodeChecksum:1e4fa645d4bface77a08688d714ba651) */ /** @@ -33,14 +33,18 @@ class CRM_Core_DAO_UFJoin extends CRM_Core_DAO { /** * Unique table ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Is this join currently active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; @@ -48,41 +52,53 @@ class CRM_Core_DAO_UFJoin extends CRM_Core_DAO { * Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $module; /** * Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Foreign key to the referenced item. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Controls display order when multiple user framework groups are setup for concurrent display. * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Which form does this field belong to. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $uf_group_id; /** * Json serialized array of data used by the ufjoin.module * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $module_data; diff --git a/CRM/Core/DAO/UFMatch.php b/CRM/Core/DAO/UFMatch.php index f374311007..9ef7bd540a 100644 --- a/CRM/Core/DAO/UFMatch.php +++ b/CRM/Core/DAO/UFMatch.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/UFMatch.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:c192c2dfffc598c44141e666fb164342) + * (GenCodeChecksum:bb9d91c913ff3b1088ca8fa03cd23740) */ /** @@ -33,42 +33,54 @@ class CRM_Core_DAO_UFMatch extends CRM_Core_DAO { /** * System generated ID. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this match entry for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * UF ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $uf_id; /** * UF Name * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $uf_name; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * UI language preferred by the given user/contact * - * @var string + * @var string|null + * (SQL type: varchar(5)) + * Note that values will be retrieved from the database as a string. */ public $language; diff --git a/CRM/Core/DAO/Website.php b/CRM/Core/DAO/Website.php index 80d55ebb66..205fc49f06 100644 --- a/CRM/Core/DAO/Website.php +++ b/CRM/Core/DAO/Website.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Website.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:042da2fb78309555f5d4ecbe41d33cd0) + * (GenCodeChecksum:7ef66a990830d03a02dd59b7b6f0d2cb) */ /** @@ -47,28 +47,36 @@ class CRM_Core_DAO_Website extends CRM_Core_DAO { /** * Unique Website ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Website * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $url; /** * Which Website type does this website belong to. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $website_type_id; diff --git a/CRM/Core/DAO/WordReplacement.php b/CRM/Core/DAO/WordReplacement.php index 47141b827f..efb8b81e05 100644 --- a/CRM/Core/DAO/WordReplacement.php +++ b/CRM/Core/DAO/WordReplacement.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/WordReplacement.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4465ed4733f5b424c231d208ef1f61d7) + * (GenCodeChecksum:705cadb5a39522334249027149873712) */ /** @@ -33,40 +33,52 @@ class CRM_Core_DAO_WordReplacement extends CRM_Core_DAO { /** * Word replacement ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Word which need to be replaced * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $find_word; /** * Word which will replace the word in find * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $replace_word; /** * Is this entry active? * - * @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(16)) + * Note that values will be retrieved from the database as a string. */ public $match_type; /** * FK to Domain ID. This is for Domain specific word replacement * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; diff --git a/CRM/Core/DAO/Worldregion.php b/CRM/Core/DAO/Worldregion.php index cea1ffea6c..31a86e1a29 100644 --- a/CRM/Core/DAO/Worldregion.php +++ b/CRM/Core/DAO/Worldregion.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Core/Worldregion.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:897ca1a3833baf2e0c5bc09b350d26cd) + * (GenCodeChecksum:e8b2ad34381b7a644a5ea7e70cebf27e) */ /** @@ -33,14 +33,18 @@ class CRM_Core_DAO_Worldregion extends CRM_Core_DAO { /** * Country ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Region name to be associated with countries * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $name; diff --git a/CRM/Cxn/DAO/Cxn.php b/CRM/Cxn/DAO/Cxn.php index e5c70d9f7e..c347beef13 100644 --- a/CRM/Cxn/DAO/Cxn.php +++ b/CRM/Cxn/DAO/Cxn.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Cxn/Cxn.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:337dd2bb4d7df6fcf7d74813e2c45bd5) + * (GenCodeChecksum:ef4c2d6fa99ceb5d3b6cc29e78d80e42) */ /** @@ -33,77 +33,99 @@ class CRM_Cxn_DAO_Cxn extends CRM_Core_DAO { /** * Connection ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Application GUID * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $app_guid; /** * Application Metadata (JSON) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $app_meta; /** * Connection GUID * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $cxn_guid; /** * Shared secret * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $secret; /** * Permissions approved for the service (JSON) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $perm; /** * Options for the service (JSON) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $options; /** * Is connection currently enabled? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * When was the connection was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the connection was created or modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * The last time the application metadata was fetched. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $fetched_date; diff --git a/CRM/Dedupe/DAO/DedupeException.php b/CRM/Dedupe/DAO/DedupeException.php index b1a96bab87..2679f8349f 100644 --- a/CRM/Dedupe/DAO/DedupeException.php +++ b/CRM/Dedupe/DAO/DedupeException.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Dedupe/DedupeException.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:52d33f10e1ffb90a32f65a9fa73ac9b3) + * (GenCodeChecksum:b949a5127501b9db455542caf6b3ffa2) */ /** @@ -33,21 +33,27 @@ class CRM_Dedupe_DAO_DedupeException extends CRM_Core_DAO { /** * Unique dedupe exception id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id1; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id2; diff --git a/CRM/Dedupe/DAO/DedupeRule.php b/CRM/Dedupe/DAO/DedupeRule.php index b876fe3629..172f3ca1ee 100644 --- a/CRM/Dedupe/DAO/DedupeRule.php +++ b/CRM/Dedupe/DAO/DedupeRule.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Dedupe/DedupeRule.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:be34a32d6749dbd8caecac45f2086b61) + * (GenCodeChecksum:9b71195adc36b4f65fd3ec21cbe3100d) */ /** @@ -33,14 +33,18 @@ class CRM_Dedupe_DAO_DedupeRule extends CRM_Core_DAO { /** * Unique dedupe rule id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The id of the rule group this rule belongs to * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $dedupe_rule_group_id; @@ -48,6 +52,8 @@ class CRM_Dedupe_DAO_DedupeRule extends CRM_Core_DAO { * The name of the table this rule is about * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $rule_table; @@ -55,20 +61,26 @@ class CRM_Dedupe_DAO_DedupeRule extends CRM_Core_DAO { * The name of the field of the table referenced in rule_table * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $rule_field; /** * The length of the matching substring * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $rule_length; /** * The weight of the rule * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $rule_weight; diff --git a/CRM/Dedupe/DAO/DedupeRuleGroup.php b/CRM/Dedupe/DAO/DedupeRuleGroup.php index 14c9cc4d5d..434f259678 100644 --- a/CRM/Dedupe/DAO/DedupeRuleGroup.php +++ b/CRM/Dedupe/DAO/DedupeRuleGroup.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Dedupe/DedupeRuleGroup.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:2168d89d281dc113ef6403af4dc39658) + * (GenCodeChecksum:66687eeebbe44a6fca675162a59edaa0) */ /** @@ -33,21 +33,27 @@ class CRM_Dedupe_DAO_DedupeRuleGroup extends CRM_Core_DAO { /** * Unique dedupe rule group id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The type of contacts this group applies to * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $contact_type; /** * The weight threshold the sum of the rule weights has to cross to consider two contacts the same * - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $threshold; @@ -55,27 +61,35 @@ class CRM_Dedupe_DAO_DedupeRuleGroup extends CRM_Core_DAO { * Whether the rule should be used for cases where usage is Unsupervised, Supervised OR General(programatically) * * @var string + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $used; /** * Name of the rule group * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Label of the rule group * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Is this a reserved rule - a rule group that has been optimized and cannot be changed by the admin * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; diff --git a/CRM/Event/Cart/DAO/Cart.php b/CRM/Event/Cart/DAO/Cart.php index 52d4278097..e5998e7532 100644 --- a/CRM/Event/Cart/DAO/Cart.php +++ b/CRM/Event/Cart/DAO/Cart.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Event/Cart/Cart.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:889446482ab589edebb02d7abee76bc5) + * (GenCodeChecksum:58e30874811fa80b8a405f368004e697) */ /** @@ -34,19 +34,25 @@ class CRM_Event_Cart_DAO_Cart extends CRM_Core_DAO { /** * Cart ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_contact who created this cart * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $user_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $completed; diff --git a/CRM/Event/Cart/DAO/EventInCart.php b/CRM/Event/Cart/DAO/EventInCart.php index 461ae202be..3451c8dcf6 100644 --- a/CRM/Event/Cart/DAO/EventInCart.php +++ b/CRM/Event/Cart/DAO/EventInCart.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Event/Cart/EventInCart.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:872f4e67be93efbed14721bb030227db) + * (GenCodeChecksum:24a288b857e58e2193699737ac771fdc) */ /** @@ -34,21 +34,27 @@ class CRM_Event_Cart_DAO_EventInCart extends CRM_Core_DAO { /** * Event In Cart ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Event ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_id; /** * FK to Event Cart ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_cart_id; diff --git a/CRM/Event/DAO/Event.php b/CRM/Event/DAO/Event.php index fe3a66fa99..54ed4922ca 100644 --- a/CRM/Event/DAO/Event.php +++ b/CRM/Event/DAO/Event.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Event/Event.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:51b2702ee6856d74a9f38e9cf86da5bf) + * (GenCodeChecksum:894f53608aa8036de5fab1dc90a407d5) */ /** @@ -58,481 +58,619 @@ class CRM_Event_DAO_Event extends CRM_Core_DAO { /** * 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; diff --git a/CRM/Event/DAO/Participant.php b/CRM/Event/DAO/Participant.php index 67278329c8..6a4624cf81 100644 --- a/CRM/Event/DAO/Participant.php +++ b/CRM/Event/DAO/Participant.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Event/Participant.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4ca199ee96c9079ad7ce673c7a06d5f6) + * (GenCodeChecksum:62382336b5251b2ee93828d70138cd7e) */ /** @@ -41,49 +41,63 @@ class CRM_Event_DAO_Participant extends CRM_Core_DAO { /** * Participant ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * FK to Event ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_id; /** * Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $role_id; /** * When did contact register for event? * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $register_date; /** * Source of this event registration. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $source; @@ -91,80 +105,104 @@ class CRM_Event_DAO_Participant extends CRM_Core_DAO { * Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that * we store the label value and not the key * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $fee_level; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** - * @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; /** * actual processor fee if known - may be 0. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $fee_amount; /** * FK to Participant ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $registered_by_id; /** * FK to Discount ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $discount_id; /** * 3 character string, value derived from config setting. * - * @var string + * @var string|null + * (SQL type: varchar(3)) + * Note that values will be retrieved from the database as a string. */ public $fee_currency; /** * The campaign for which this participant has been registered. * - * @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; /** * Discount Amount * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $discount_amount; /** * FK to civicrm_event_carts * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $cart_id; /** * On Waiting List * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $must_wait; /** * FK to Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $transferred_to_contact_id; diff --git a/CRM/Event/DAO/ParticipantPayment.php b/CRM/Event/DAO/ParticipantPayment.php index 9fe49f0c86..a13745ca8f 100644 --- a/CRM/Event/DAO/ParticipantPayment.php +++ b/CRM/Event/DAO/ParticipantPayment.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Event/ParticipantPayment.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:faf8b6394f4e57dd2bd6702f712f7157) + * (GenCodeChecksum:e968c8fec853683ccda7863407aef635) */ /** @@ -34,21 +34,27 @@ class CRM_Event_DAO_ParticipantPayment extends CRM_Core_DAO { /** * Participant Payment ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Participant ID (FK) * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $participant_id; /** * FK to contribution table. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_id; diff --git a/CRM/Event/DAO/ParticipantStatusType.php b/CRM/Event/DAO/ParticipantStatusType.php index f4da6903bb..bdb75e0e43 100644 --- a/CRM/Event/DAO/ParticipantStatusType.php +++ b/CRM/Event/DAO/ParticipantStatusType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Event/ParticipantStatusType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0f5f8f9d2171b25bb250914d746996bc) + * (GenCodeChecksum:bb9ea5411d4ab4f767d891f2e0f20858) */ /** @@ -34,63 +34,81 @@ class CRM_Event_DAO_ParticipantStatusType extends CRM_Core_DAO { /** * unique participant status type id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * non-localized name of the status type * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * localized label for display of this status type * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * the general group of status type this one belongs to * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $class; /** * whether this is a status type required by the system * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * whether this status type is active * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * whether this status type is counted against event size limit * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_counted; /** * controls sort order * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * whether the status type is visible to the public, an implicit foreign key to option_value.value related to the `visibility` option_group * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $visibility_id; diff --git a/CRM/Financial/DAO/Currency.php b/CRM/Financial/DAO/Currency.php index cfad1c496d..4618448e1a 100644 --- a/CRM/Financial/DAO/Currency.php +++ b/CRM/Financial/DAO/Currency.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/Currency.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:710d5211ef6887a78a0d2a531b87555a) + * (GenCodeChecksum:1e445ed33ce1cd5313e578ebcb400c07) */ /** @@ -34,35 +34,45 @@ class CRM_Financial_DAO_Currency extends CRM_Core_DAO { /** * Currency ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Currency Name * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Currency Symbol * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $symbol; /** * Numeric currency code * - * @var string + * @var string|null + * (SQL type: varchar(3)) + * Note that values will be retrieved from the database as a string. */ public $numeric_code; /** * Full currency name * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $full_name; diff --git a/CRM/Financial/DAO/EntityFinancialAccount.php b/CRM/Financial/DAO/EntityFinancialAccount.php index 18c6243f5b..16d6a13e75 100644 --- a/CRM/Financial/DAO/EntityFinancialAccount.php +++ b/CRM/Financial/DAO/EntityFinancialAccount.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/EntityFinancialAccount.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:ed1b639bfb9c1c9be37ed44ed2efe98c) + * (GenCodeChecksum:ee1330d41462e8d7fb84657c4efa47f8) */ /** @@ -34,7 +34,9 @@ class CRM_Financial_DAO_EntityFinancialAccount extends CRM_Core_DAO { /** * ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,27 +44,35 @@ class CRM_Financial_DAO_EntityFinancialAccount extends CRM_Core_DAO { * Links to an entity_table like civicrm_financial_type * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Links to an id in the entity_table, such as vid in civicrm_financial_type * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * FK to a new civicrm_option_value (account_relationship) * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $account_relationship; /** * FK to the financial_account_id * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $financial_account_id; diff --git a/CRM/Financial/DAO/EntityFinancialTrxn.php b/CRM/Financial/DAO/EntityFinancialTrxn.php index 5b56512c5f..b67144a5bf 100644 --- a/CRM/Financial/DAO/EntityFinancialTrxn.php +++ b/CRM/Financial/DAO/EntityFinancialTrxn.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/EntityFinancialTrxn.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:fafa322736bff4ccf082449b5e54cd35) + * (GenCodeChecksum:04adc48b1cca1ec60c364ec136ddc148) */ /** @@ -34,7 +34,9 @@ class CRM_Financial_DAO_EntityFinancialTrxn extends CRM_Core_DAO { /** * ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,23 +44,31 @@ class CRM_Financial_DAO_EntityFinancialTrxn extends CRM_Core_DAO { * May contain civicrm_financial_item, civicrm_contribution, civicrm_financial_trxn, civicrm_grant, etc * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $financial_trxn_id; /** * allocated amount of transaction to this entity * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount; diff --git a/CRM/Financial/DAO/FinancialAccount.php b/CRM/Financial/DAO/FinancialAccount.php index 377a0521c4..0f83708dd3 100644 --- a/CRM/Financial/DAO/FinancialAccount.php +++ b/CRM/Financial/DAO/FinancialAccount.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/FinancialAccount.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:08824371a351806b30fc54c608138bd6) + * (GenCodeChecksum:ae32a35de5bc66a8e230b5595b77810f) */ /** @@ -34,7 +34,9 @@ class CRM_Financial_DAO_FinancialAccount extends CRM_Core_DAO { /** * ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,97 +44,125 @@ class CRM_Financial_DAO_FinancialAccount extends CRM_Core_DAO { * Financial Account Name. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * FK to Contact ID that is responsible for the funds in this account * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * pseudo FK into civicrm_option_value. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $financial_account_type_id; /** * Optional value for mapping monies owed and received to accounting system codes. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $accounting_code; /** * Optional value for mapping account types to accounting system account categories (QuickBooks Account Type Codes for example). * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $account_type_code; /** * Financial Type Description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Parent ID in account hierarchy * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Is this a header account which does not allow transactions to be posted against it directly, but only to its sub-accounts? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_header_account; /** * Is this account tax-deductible? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_deductible; /** * Is this account for taxes? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_tax; /** * The percentage of the total_amount that is due for this tax. * - * @var float + * @var float|string|null + * (SQL type: decimal(10,8)) + * Note that values will be retrieved from the database as a string. */ public $tax_rate; /** * Is this a predefined system object? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this account the default one (or default tax one) for its financial_account_type? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; diff --git a/CRM/Financial/DAO/FinancialItem.php b/CRM/Financial/DAO/FinancialItem.php index 106dddb041..6970a3c435 100644 --- a/CRM/Financial/DAO/FinancialItem.php +++ b/CRM/Financial/DAO/FinancialItem.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/FinancialItem.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:70be7900a331cb86c9cd6ee76544adc5) + * (GenCodeChecksum:fb47253c848979ed40aae7affbc188a3) */ /** @@ -32,77 +32,99 @@ class CRM_Financial_DAO_FinancialItem extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Date and time the item was created * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * Date and time of the source transaction * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $transaction_date; /** * FK to Contact ID of contact the item is from * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Human readable description of this item, to ease display without lookup of source item. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Total amount of this item * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount; /** * Currency for the amount * - * @var string + * @var string|null + * (SQL type: varchar(3)) + * Note that values will be retrieved from the database as a string. */ public $currency; /** * FK to civicrm_financial_account * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $financial_account_id; /** * Payment status: test, paid, part_paid, unpaid (if empty assume unpaid) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * May contain civicrm_line_item, civicrm_financial_trxn etc * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * The specific source item that is responsible for the creation of this financial_item * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; diff --git a/CRM/Financial/DAO/FinancialTrxn.php b/CRM/Financial/DAO/FinancialTrxn.php index 499098c44e..ff401a529b 100644 --- a/CRM/Financial/DAO/FinancialTrxn.php +++ b/CRM/Financial/DAO/FinancialTrxn.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/FinancialTrxn.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:330be109309bcc6fc543b287c805e606) + * (GenCodeChecksum:ab70fbb4b84fe620236a196f5a80926e) */ /** @@ -32,126 +32,162 @@ class CRM_Financial_DAO_FinancialTrxn extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to financial_account table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $from_financial_account_id; /** * FK to financial_financial_account table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $to_financial_account_id; /** * date transaction occurred * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $trxn_date; /** * amount of transaction * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $total_amount; /** * actual processor fee if known - may be 0. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $fee_amount; /** * actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $net_amount; /** * 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; /** * Is this entry either a payment or a reversal of a payment? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_payment; /** * Transaction id supplied by external processor. This may not be unique. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $trxn_id; /** * processor result code * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $trxn_result_code; /** * pseudo FK to civicrm_option_value of contribution_status_id option_group * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * Payment Processor for this financial transaction * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_processor_id; /** * FK to payment_instrument option group values * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_instrument_id; /** * FK to accept_creditcard option group values * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $card_type_id; /** * Check number * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $check_number; /** * Last 4 digits of credit card * - * @var string + * @var string|null + * (SQL type: varchar(4)) + * Note that values will be retrieved from the database as a string. */ public $pan_truncation; /** * Payment Processor external order reference * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $order_reference; diff --git a/CRM/Financial/DAO/FinancialType.php b/CRM/Financial/DAO/FinancialType.php index 3593396d76..0a76012ccf 100644 --- a/CRM/Financial/DAO/FinancialType.php +++ b/CRM/Financial/DAO/FinancialType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/FinancialType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:2e4be9c40fcfbca83940bb875d516886) + * (GenCodeChecksum:896dd0256e12220dc174740a9f66012f) */ /** @@ -41,7 +41,9 @@ class CRM_Financial_DAO_FinancialType extends CRM_Core_DAO { /** * ID of original financial_type so you can search this table by the financial_type.id and then select the relevant version based on the timestamp * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -49,34 +51,44 @@ class CRM_Financial_DAO_FinancialType extends CRM_Core_DAO { * Financial Type Name. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Financial Type Description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Is this financial type tax-deductible? If true, contributions of this type may be fully OR partially deductible - non-deductible amount is stored in the Contribution record. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_deductible; /** * Is this a predefined system object? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Is this property active? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Financial/DAO/PaymentProcessor.php b/CRM/Financial/DAO/PaymentProcessor.php index 8c86a63342..82622f2b69 100644 --- a/CRM/Financial/DAO/PaymentProcessor.php +++ b/CRM/Financial/DAO/PaymentProcessor.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/PaymentProcessor.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:a541d72f9435b6ae2706d98cc01b1598) + * (GenCodeChecksum:7d4681a9b748c272c9da9807af6e4809) */ /** @@ -34,141 +34,187 @@ class CRM_Financial_DAO_PaymentProcessor extends CRM_Core_DAO { /** * Payment Processor ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this match entry for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Payment Processor Name. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Payment Processor Descriptive Name. * - * @var string + * @var string|null + * (SQL type: varchar(127)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Payment Processor Description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_processor_type_id; /** * Is this processor active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this processor the default? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * Is this processor for a test site? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $user_name; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $password; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $signature; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_site; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_api; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_recur; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_button; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $class_name; /** * Billing Mode (deprecated) * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $billing_mode; /** * Can process recurring contributions * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_recur; /** * Payment Type: Credit or Debit (deprecated) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_type; /** * Payment Instrument ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_instrument_id; /** * array of accepted credit card types * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $accepted_credit_cards; diff --git a/CRM/Financial/DAO/PaymentProcessorType.php b/CRM/Financial/DAO/PaymentProcessorType.php index 32118ba04a..4088336a4a 100644 --- a/CRM/Financial/DAO/PaymentProcessorType.php +++ b/CRM/Financial/DAO/PaymentProcessorType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/PaymentProcessorType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f60f8f4248c8c667223720869d8c81b3) + * (GenCodeChecksum:a24e95eecd01bdb6ff555cd307a62084) */ /** @@ -34,7 +34,9 @@ class CRM_Financial_DAO_PaymentProcessorType extends CRM_Core_DAO { /** * Payment Processor Type ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,6 +44,8 @@ class CRM_Financial_DAO_PaymentProcessorType extends CRM_Core_DAO { * Payment Processor Type Name. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -49,120 +53,162 @@ class CRM_Financial_DAO_PaymentProcessorType extends CRM_Core_DAO { * Payment Processor Type Title. * * @var string + * (SQL type: varchar(127)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Payment Processor Description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Is this processor active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this processor the default? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $user_name_label; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $password_label; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $signature_label; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $subject_label; /** * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $class_name; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_site_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_api_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_recur_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_button_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_site_test_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_api_test_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_recur_test_default; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $url_button_test_default; /** * Billing Mode (deprecated) * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $billing_mode; /** * Can process recurring contributions * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_recur; /** * Payment Type: Credit or Debit (deprecated) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_type; /** * Payment Instrument ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_instrument_id; diff --git a/CRM/Financial/DAO/PaymentToken.php b/CRM/Financial/DAO/PaymentToken.php index 0c6816df4d..43a9de8706 100644 --- a/CRM/Financial/DAO/PaymentToken.php +++ b/CRM/Financial/DAO/PaymentToken.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Financial/PaymentToken.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:f1c4b32a0722841ec435f9b6c4ecfe54) + * (GenCodeChecksum:e5c6457ebb1ae691f811a3472d1a9eec) */ /** @@ -34,19 +34,25 @@ class CRM_Financial_DAO_PaymentToken extends CRM_Core_DAO { /** * Payment Token ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID for the owner of the token * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $payment_processor_id; @@ -54,69 +60,89 @@ class CRM_Financial_DAO_PaymentToken extends CRM_Core_DAO { * Externally provided token string * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $token; /** * Date created * - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * Contact ID of token creator * - * @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 this token expires * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $expiry_date; /** * Email at the time of token creation. Useful for fraud forensics * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $email; /** * Billing first name at the time of token creation. Useful for fraud forensics * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $billing_first_name; /** * Billing middle name at the time of token creation. Useful for fraud forensics * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $billing_middle_name; /** * Billing last name at the time of token creation. Useful for fraud forensics * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $billing_last_name; /** * Holds the part of the card number or account details that may be retained or displayed * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $masked_account_number; /** * IP used when creating the token. Useful for fraud forensics * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $ip_address; diff --git a/CRM/Friend/DAO/Friend.php b/CRM/Friend/DAO/Friend.php index e5a77e498d..19dac5041d 100644 --- a/CRM/Friend/DAO/Friend.php +++ b/CRM/Friend/DAO/Friend.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Friend/Friend.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:cddccd848fafb980eb26245c21f47f76) + * (GenCodeChecksum:49f46991da84d0d0067ea70ab6276f15) */ /** @@ -33,7 +33,9 @@ class CRM_Friend_DAO_Friend extends CRM_Core_DAO { /** * Friend ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -41,58 +43,76 @@ class CRM_Friend_DAO_Friend extends CRM_Core_DAO { * Name of table where item being referenced is stored. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Foreign key to the referenced item. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Introductory message to contributor or participant displayed on the Tell a Friend form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $intro; /** * Suggested message to friends, provided as default on the Tell A Friend form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $suggested_message; /** * URL for general info about the organization - included in the email sent to friends. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $general_link; /** * Text for Tell a Friend thank you page header and HTML title. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $thankyou_title; /** * Thank you message displayed on success page. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $thankyou_text; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Mailing/DAO/BouncePattern.php b/CRM/Mailing/DAO/BouncePattern.php index 091639a689..92ca3b8eb2 100644 --- a/CRM/Mailing/DAO/BouncePattern.php +++ b/CRM/Mailing/DAO/BouncePattern.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/BouncePattern.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:c69a86cc75621a05e32951247e12f06b) + * (GenCodeChecksum:15aed9731c3f63c29d9d3c0c57297619) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_DAO_BouncePattern extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Type of bounce * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $bounce_type_id; /** * A regexp to match a message to a bounce type * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $pattern; diff --git a/CRM/Mailing/DAO/BounceType.php b/CRM/Mailing/DAO/BounceType.php index 8a274e8392..c9e6acf97b 100644 --- a/CRM/Mailing/DAO/BounceType.php +++ b/CRM/Mailing/DAO/BounceType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/BounceType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:cde25653865971ad7f5692dfd0eb7c39) + * (GenCodeChecksum:ef69aba971b0a118a9ec2238a180c7c5) */ /** @@ -32,7 +32,9 @@ class CRM_Mailing_DAO_BounceType extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -40,20 +42,26 @@ class CRM_Mailing_DAO_BounceType extends CRM_Core_DAO { * Type of bounce * * @var string + * (SQL type: varchar(24)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * A description of this bounce type * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Number of bounces of this type required before the email address is put on bounce hold * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $hold_threshold; diff --git a/CRM/Mailing/DAO/Mailing.php b/CRM/Mailing/DAO/Mailing.php index 93ec4b8630..eef22e75d7 100644 --- a/CRM/Mailing/DAO/Mailing.php +++ b/CRM/Mailing/DAO/Mailing.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Mailing.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0889788ebb2ad430999bb9eda9524621) + * (GenCodeChecksum:9815b093c77eedc9aa2c97c338a0e75d) */ /** @@ -49,89 +49,115 @@ class CRM_Mailing_DAO_Mailing extends CRM_Core_DAO { ]; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which site is this mailing for * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * FK to the header component. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $header_id; /** * FK to the footer component. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $footer_id; /** * FK to the auto-responder component. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $reply_id; /** * FK to the unsubscribe component. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $unsubscribe_id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $resubscribe_id; /** * FK to the opt-out component. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $optout_id; /** * Mailing Name. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * differentiate between standalone mailings, A/B tests, and A/B final-winner * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $mailing_type; /** * From Header of mailing * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $from_name; /** * From Email of mailing * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $from_email; /** * Reply-To Email of mailing * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $replyto_email; @@ -139,207 +165,267 @@ class CRM_Mailing_DAO_Mailing extends CRM_Core_DAO { * The language/processing system used for email templates. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $template_type; /** * Advanced options used by the email templating system. (JSON encoded) * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $template_options; /** * Subject of mailing * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** * Body of the mailing in text format. * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $body_text; /** * Body of the mailing in html format. * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $body_html; /** * Should we track URL click-throughs for this mailing? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $url_tracking; /** * Should we forward replies back to the author? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $forward_replies; /** * Should we enable the auto-responder? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $auto_responder; /** * Should we track when recipients open/read this mailing? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $open_tracking; /** * Has at least one job associated with this mailing finished? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_completed; /** * FK to the message template. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $msg_template_id; /** * Overwrite the VERP address in Reply-To * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $override_verp; /** * FK to Contact ID who first created this mailing * - * @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 this mailing was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the mailing (or closely related entity) was created or modified or deleted. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * FK to Contact ID who scheduled this mailing * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $scheduled_id; /** * Date and time this mailing was scheduled. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $scheduled_date; /** * FK to Contact ID who approved this mailing * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $approver_id; /** * Date and time this mailing was approved. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $approval_date; /** * The status of this mailing. Values: none, approved, rejected * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $approval_status_id; /** * Note behind the decision. * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $approval_note; /** * Is this mailing archived? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_archived; /** * In what context(s) is the mailing contents visible (online viewing) * - * @var string + * @var string|null + * (SQL type: varchar(40)) + * Note that values will be retrieved from the database as a string. */ public $visibility; /** * The campaign for which this mailing has been initiated. * - * @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; /** * Remove duplicate emails? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $dedupe_email; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $sms_provider_id; /** * Key for validating requests related to this mailing. * - * @var string + * @var string|null + * (SQL type: varchar(16)) + * Note that values will be retrieved from the database as a string. */ public $hash; /** * With email_selection_method, determines which email address to use * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $location_type_id; /** * With location_type_id, determine how to choose the email address to use. * - * @var string + * @var string|null + * (SQL type: varchar(20)) + * Note that values will be retrieved from the database as a string. */ public $email_selection_method; /** * Language of the content of the mailing. Useful for tokens. * - * @var string + * @var string|null + * (SQL type: varchar(5)) + * Note that values will be retrieved from the database as a string. */ public $language; diff --git a/CRM/Mailing/DAO/MailingAB.php b/CRM/Mailing/DAO/MailingAB.php index 0e3e3ad5e5..f97cada046 100644 --- a/CRM/Mailing/DAO/MailingAB.php +++ b/CRM/Mailing/DAO/MailingAB.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/MailingAB.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:021242562cab688e65a6c13247c61636) + * (GenCodeChecksum:c385d0cae9e88e5a44770cd3ae6fd9d2) */ /** @@ -32,92 +32,120 @@ class CRM_Mailing_DAO_MailingAB extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name of the A/B test * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Status * - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $status; /** * The first experimental mailing ("A" condition) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id_a; /** * The second experimental mailing ("B" condition) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id_b; /** * The final, general mailing (derived from A or B) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id_c; /** * Which site is this mailing for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $testing_criteria; /** - * @var string + * @var string|null + * (SQL type: varchar(32)) + * Note that values will be retrieved from the database as a string. */ public $winner_criteria; /** * What specific url to track * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $specific_url; /** * In how much time to declare winner * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $declare_winning_time; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_percentage; /** * FK to Contact ID * - * @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; /** * When was this item created * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; diff --git a/CRM/Mailing/DAO/MailingComponent.php b/CRM/Mailing/DAO/MailingComponent.php index 281181c445..0f77ebdfb5 100644 --- a/CRM/Mailing/DAO/MailingComponent.php +++ b/CRM/Mailing/DAO/MailingComponent.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/MailingComponent.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:41af94f2313c33bb228194f142fc8e0b) + * (GenCodeChecksum:07a2027aee545a570c9fd99294f98d9a) */ /** @@ -32,54 +32,70 @@ class CRM_Mailing_DAO_MailingComponent extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The name of this component * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Type of Component. * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $component_type; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $subject; /** * Body of the component in html format. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $body_html; /** * Body of the component in text format. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $body_text; /** * Is this the default component for this component_type? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * Is this property active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Mailing/DAO/MailingGroup.php b/CRM/Mailing/DAO/MailingGroup.php index 0fd5b1f894..84118eb8e9 100644 --- a/CRM/Mailing/DAO/MailingGroup.php +++ b/CRM/Mailing/DAO/MailingGroup.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/MailingGroup.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:1e483c2e468defc82c46dd66146595bb) + * (GenCodeChecksum:454b529a2ced8428fa3ec9a080fb4887) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_DAO_MailingGroup extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The ID of a previous mailing to include/exclude recipients. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id; /** * Are the members of the group included or excluded?. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $group_type; @@ -54,27 +60,35 @@ class CRM_Mailing_DAO_MailingGroup extends CRM_Core_DAO { * Name of table where item being referenced is stored. * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Foreign key to the referenced item. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * The filtering search. custom search id or -1 for civicrm api search * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $search_id; /** * The arguments to be sent to the search function * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $search_args; diff --git a/CRM/Mailing/DAO/MailingJob.php b/CRM/Mailing/DAO/MailingJob.php index 7058a2751a..3ba252d040 100644 --- a/CRM/Mailing/DAO/MailingJob.php +++ b/CRM/Mailing/DAO/MailingJob.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/MailingJob.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:2527bca832d0e7751c69a42d33f28159) + * (GenCodeChecksum:fdca7fda2701c59049924abfdb6adf3b) */ /** @@ -32,77 +32,99 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The ID of the mailing this Job will send. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id; /** * date on which this job was scheduled. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $scheduled_date; /** * date on which this job was started. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * date on which this job ended. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * The state of this job * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $status; /** * Is this job for a test mail? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** * Type of mailling job: null | child * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $job_type; /** * Parent job id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $parent_id; /** * Offset of the child job * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $job_offset; /** * Queue size limit for each child job * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $job_limit; diff --git a/CRM/Mailing/DAO/Recipients.php b/CRM/Mailing/DAO/Recipients.php index 7bc6325be6..88d565694d 100644 --- a/CRM/Mailing/DAO/Recipients.php +++ b/CRM/Mailing/DAO/Recipients.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Recipients.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:b3c4d09f9c6afa1f96dc0d1cdbaec935) + * (GenCodeChecksum:9b1fd81feabb976bc4447e5df79fb8ad) */ /** @@ -32,35 +32,45 @@ class CRM_Mailing_DAO_Recipients extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The ID of the mailing this Job will send. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id; /** * FK to Contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * FK to Email * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $email_id; /** * FK to Phone * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_id; diff --git a/CRM/Mailing/DAO/Spool.php b/CRM/Mailing/DAO/Spool.php index b5a4afc996..891ec8b5c0 100644 --- a/CRM/Mailing/DAO/Spool.php +++ b/CRM/Mailing/DAO/Spool.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Spool.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:37cfd90aa2697070996f893259692b4b) + * (GenCodeChecksum:be1b386bf2b06844863726171878fb37) */ /** @@ -32,49 +32,63 @@ class CRM_Mailing_DAO_Spool extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The ID of the Job . * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $job_id; /** * The email of the recipients this mail is to be sent. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $recipient_email; /** * The header information of this mailing . * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $headers; /** * The body of this mailing. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $body; /** * date on which this job was added. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $added_at; /** * date on which this job was removed. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $removed_at; diff --git a/CRM/Mailing/DAO/TrackableURL.php b/CRM/Mailing/DAO/TrackableURL.php index 2c018815e7..e3fa29db83 100644 --- a/CRM/Mailing/DAO/TrackableURL.php +++ b/CRM/Mailing/DAO/TrackableURL.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/TrackableURL.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4c224c28653ab679c03fb8e98ddc3401) + * (GenCodeChecksum:2eba75ecb9fc002adcc4a66cae55650a) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_DAO_TrackableURL extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The URL to be tracked. * - * @var text + * @var string + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $url; /** * FK to the mailing * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $mailing_id; diff --git a/CRM/Mailing/Event/DAO/Bounce.php b/CRM/Mailing/Event/DAO/Bounce.php index aebb50a011..0c1d94d0aa 100644 --- a/CRM/Mailing/Event/DAO/Bounce.php +++ b/CRM/Mailing/Event/DAO/Bounce.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Bounce.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6f3c41c50e9baa89d14295479d66975c) + * (GenCodeChecksum:d4f63c10a945788a302f4c199cfc52f0) */ /** @@ -32,35 +32,45 @@ class CRM_Mailing_Event_DAO_Bounce extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * What type of bounce was it? * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $bounce_type_id; /** * The reason the email bounced. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $bounce_reason; /** * When this bounce event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Confirm.php b/CRM/Mailing/Event/DAO/Confirm.php index b8bde92ad9..04701df189 100644 --- a/CRM/Mailing/Event/DAO/Confirm.php +++ b/CRM/Mailing/Event/DAO/Confirm.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Confirm.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:666c5eb15eb75fd23bebb088db0bc004) + * (GenCodeChecksum:70037cdb7d4ba64a26993149a95135a9) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_Event_DAO_Confirm extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_mailing_event_subscribe * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_subscribe_id; /** * When this confirmation event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Delivered.php b/CRM/Mailing/Event/DAO/Delivered.php index 7713ee98bc..c3ef1eccbb 100644 --- a/CRM/Mailing/Event/DAO/Delivered.php +++ b/CRM/Mailing/Event/DAO/Delivered.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Delivered.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:01ce8759ea940b4dd34213f25b15e7d3) + * (GenCodeChecksum:0868640ae2c11be9c92be341ca74d0bc) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_Event_DAO_Delivered extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * When this delivery event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Forward.php b/CRM/Mailing/Event/DAO/Forward.php index 01cca5af26..763c5f6d63 100644 --- a/CRM/Mailing/Event/DAO/Forward.php +++ b/CRM/Mailing/Event/DAO/Forward.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Forward.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:60c155254c97ad953fc07b9244440f4e) + * (GenCodeChecksum:4fc0787d204ec05deef20a6b3f3f0de0) */ /** @@ -32,28 +32,36 @@ class CRM_Mailing_Event_DAO_Forward extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * FK to EventQueue for destination * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $dest_queue_id; /** * When this forward event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Opened.php b/CRM/Mailing/Event/DAO/Opened.php index 2b340f50d4..d0ef057592 100644 --- a/CRM/Mailing/Event/DAO/Opened.php +++ b/CRM/Mailing/Event/DAO/Opened.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Opened.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:eb80ba7a01169cc0320fb2807c873291) + * (GenCodeChecksum:a1d86a2d8080e57f206e2a7adcbbc276) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_Event_DAO_Opened extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * When this open event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Queue.php b/CRM/Mailing/Event/DAO/Queue.php index 193a3905b0..1cdc4dd5c8 100644 --- a/CRM/Mailing/Event/DAO/Queue.php +++ b/CRM/Mailing/Event/DAO/Queue.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Queue.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:445426f940c37e15089892b45866ca06) + * (GenCodeChecksum:774aa2cfd13fdd3f0e27e051453c3dc1) */ /** @@ -32,28 +32,36 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Job * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $job_id; /** * FK to Email * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $email_id; /** * FK to Contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; @@ -61,13 +69,17 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { * Security hash * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $hash; /** * FK to Phone * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $phone_id; diff --git a/CRM/Mailing/Event/DAO/Reply.php b/CRM/Mailing/Event/DAO/Reply.php index 0e3dfdd870..3b7d04b7bb 100644 --- a/CRM/Mailing/Event/DAO/Reply.php +++ b/CRM/Mailing/Event/DAO/Reply.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Reply.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:500b838b63185072b949c9e1a308f9d0) + * (GenCodeChecksum:530a4b8ec0e37cbd23bf0acf8be67181) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_Event_DAO_Reply extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * When this reply event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Subscribe.php b/CRM/Mailing/Event/DAO/Subscribe.php index 95e65c8e3c..f8e6ea7f95 100644 --- a/CRM/Mailing/Event/DAO/Subscribe.php +++ b/CRM/Mailing/Event/DAO/Subscribe.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Subscribe.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:e9d5fb2bce9ebd0adb366e76b39d3e84) + * (GenCodeChecksum:e58268ec0a5deff45a3b5ab2527bed48) */ /** @@ -32,21 +32,27 @@ class CRM_Mailing_Event_DAO_Subscribe extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Group * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $group_id; /** * FK to Contact * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; @@ -54,13 +60,17 @@ class CRM_Mailing_Event_DAO_Subscribe extends CRM_Core_DAO { * Security hash * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $hash; /** * When this subscription event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/TrackableURLOpen.php b/CRM/Mailing/Event/DAO/TrackableURLOpen.php index 1b99093812..7aeefdacac 100644 --- a/CRM/Mailing/Event/DAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/DAO/TrackableURLOpen.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/TrackableURLOpen.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:5eed5ab9c156c3f774a049f39546cbac) + * (GenCodeChecksum:a49c335dfa1bde412a6123d715c9ef34) */ /** @@ -32,28 +32,36 @@ class CRM_Mailing_Event_DAO_TrackableURLOpen extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * FK to TrackableURL * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $trackable_url_id; /** * When this trackable URL open occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Mailing/Event/DAO/Unsubscribe.php b/CRM/Mailing/Event/DAO/Unsubscribe.php index 9e0bd515af..86351e54e7 100644 --- a/CRM/Mailing/Event/DAO/Unsubscribe.php +++ b/CRM/Mailing/Event/DAO/Unsubscribe.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Mailing/Event/Unsubscribe.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:c1409a676271a172fdc33339a4414951) + * (GenCodeChecksum:3df64dd9a8d374056fcf215672b365d6) */ /** @@ -32,28 +32,36 @@ class CRM_Mailing_Event_DAO_Unsubscribe extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to EventQueue * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $event_queue_id; /** * Unsubscribe at org- or group-level * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $org_unsubscribe; /** * When this delivery event occurred. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $time_stamp; diff --git a/CRM/Member/DAO/Membership.php b/CRM/Member/DAO/Membership.php index e378b8876e..94bcb0f9b0 100644 --- a/CRM/Member/DAO/Membership.php +++ b/CRM/Member/DAO/Membership.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Member/Membership.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:fd3bcddc97a226b449f26e3280ef2ace) + * (GenCodeChecksum:0619aa3946bcadcab1919672c9ecf35a) */ /** @@ -53,106 +53,138 @@ class CRM_Member_DAO_Membership extends CRM_Core_DAO { /** * Membership ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * FK to Membership Type * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_type_id; /** * Beginning of initial membership period (member since...). * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $join_date; /** * Beginning of current uninterrupted membership period. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * Current membership period expire date. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $source; /** * FK to Membership Status * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_override; /** * Then end date of membership status override if 'Override until selected date' override type is selected. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $status_override_end_date; /** * Optional FK to Parent Membership. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $owner_membership_id; /** * Maximum number of related memberships (membership_type override). * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $max_related; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** - * @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; /** * Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_recur_id; /** * The campaign for which this membership is attached. * - * @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; diff --git a/CRM/Member/DAO/MembershipBlock.php b/CRM/Member/DAO/MembershipBlock.php index 891dc5b991..a8fdf704d6 100644 --- a/CRM/Member/DAO/MembershipBlock.php +++ b/CRM/Member/DAO/MembershipBlock.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Member/MembershipBlock.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:1f5c13fb36ae0853ed5982f6ca40d65a) + * (GenCodeChecksum:8e0e93f6f480d279cbf4ac53db86a8f3) */ /** @@ -34,91 +34,117 @@ class CRM_Member_DAO_MembershipBlock extends CRM_Core_DAO { /** * Membership ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Name for Membership Status * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to civicrm_contribution_page.id * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Membership types to be exposed by this block * - * @var string + * @var string|null + * (SQL type: varchar(1024)) + * Note that values will be retrieved from the database as a string. */ public $membership_types; /** * Optional foreign key to membership_type * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_type_default; /** * Display minimum membership fee * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $display_min_fee; /** * Should membership transactions be processed separately * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_separate_payment; /** * Title to display at top of block * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $new_title; /** * Text to display below title * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $new_text; /** * Title for renewal * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $renewal_title; /** * Text to display for member renewal * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $renewal_text; /** * Is membership sign up optional * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_required; /** * Is this membership_block enabled * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/Member/DAO/MembershipLog.php b/CRM/Member/DAO/MembershipLog.php index 2d13cc86d0..ead87623ba 100644 --- a/CRM/Member/DAO/MembershipLog.php +++ b/CRM/Member/DAO/MembershipLog.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Member/MembershipLog.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:cca53e3abe058a7b585138271658d90c) + * (GenCodeChecksum:0064664a5741cb1f9ba8fea392dcef22) */ /** @@ -32,63 +32,81 @@ class CRM_Member_DAO_MembershipLog extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Membership table * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_id; /** * New status assigned to membership by this action. FK to Membership Status * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * New membership period start date * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * New membership period expiration date. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * FK to Contact ID of person under whose credentials this data modification was made. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $modified_id; /** * Date this membership modification action was logged. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * FK to Membership Type. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_type_id; /** * Maximum number of related memberships. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $max_related; diff --git a/CRM/Member/DAO/MembershipPayment.php b/CRM/Member/DAO/MembershipPayment.php index a549158e02..e8dbf3e64e 100644 --- a/CRM/Member/DAO/MembershipPayment.php +++ b/CRM/Member/DAO/MembershipPayment.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Member/MembershipPayment.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:cb00d5477470230f8ab9b18bc56ca910) + * (GenCodeChecksum:ff33ff800a373cf9cf5e58ad1d5a3c94) */ /** @@ -32,21 +32,27 @@ class CRM_Member_DAO_MembershipPayment extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Membership table * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_id; /** * FK to contribution table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_id; diff --git a/CRM/Member/DAO/MembershipStatus.php b/CRM/Member/DAO/MembershipStatus.php index cea61d91d1..764946fbb8 100644 --- a/CRM/Member/DAO/MembershipStatus.php +++ b/CRM/Member/DAO/MembershipStatus.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Member/MembershipStatus.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:e60a982e078b6f3b7d14b16ea2139f14) + * (GenCodeChecksum:5c4442b352b42ed23368f5dbb0bc0531) */ /** @@ -41,7 +41,9 @@ class CRM_Member_DAO_MembershipStatus extends CRM_Core_DAO { /** * Membership ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -49,95 +51,123 @@ class CRM_Member_DAO_MembershipStatus extends CRM_Core_DAO { * Name for Membership Status * * @var string + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Label for Membership Status * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * Event when this status starts. * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $start_event; /** * Unit used for adjusting from start_event. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $start_event_adjust_unit; /** * Status range begins this many units from start_event. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $start_event_adjust_interval; /** * Event after which this status ends. * - * @var string + * @var string|null + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $end_event; /** * Unit used for adjusting from the ending event. * - * @var string + * @var string|null + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $end_event_adjust_unit; /** * Status range ends this many units from end_event. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $end_event_adjust_interval; /** * Does this status aggregate to current members (e.g. New, Renewed, Grace might all be TRUE... while Unrenewed, Lapsed, Inactive would be FALSE). * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_current_member; /** * Is this status for admin/manual assignment only. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_admin; /** - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Assign this status to a membership record if no other status match is found. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * Is this membership_status enabled. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this membership_status reserved. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; diff --git a/CRM/Member/DAO/MembershipType.php b/CRM/Member/DAO/MembershipType.php index 50038a30a7..40e9b671d3 100644 --- a/CRM/Member/DAO/MembershipType.php +++ b/CRM/Member/DAO/MembershipType.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Member/MembershipType.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9cb69957096aad15ee7d55a4efceb53e) + * (GenCodeChecksum:ebffd1b4dde86196cd988e43adcd6ad8) */ /** @@ -41,14 +41,18 @@ class CRM_Member_DAO_MembershipType extends CRM_Core_DAO { /** * Membership ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this match entry for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; @@ -56,34 +60,44 @@ class CRM_Member_DAO_MembershipType extends CRM_Core_DAO { * Name of Membership Type * * @var string + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Description of Membership Type * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Owner organization for this membership type. FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $member_of_contact_id; /** * If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $financial_type_id; /** * Minimum fee for this membership (0 for free/complimentary memberships). * - * @var float + * @var float|string|null + * (SQL type: decimal(18,9)) + * Note that values will be retrieved from the database as a string. */ public $minimum_fee; @@ -91,13 +105,17 @@ class CRM_Member_DAO_MembershipType extends CRM_Core_DAO { * Unit in which membership period is expressed. * * @var string + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $duration_unit; /** * Number of duration units in membership period (e.g. 1 year, 12 months). * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $duration_interval; @@ -105,77 +123,101 @@ class CRM_Member_DAO_MembershipType extends CRM_Core_DAO { * Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day. * * @var string + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $period_type; /** * For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $fixed_period_start_day; /** * For fixed period memberships, signups after this day (mmdd) rollover to next period. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $fixed_period_rollover_day; /** * FK to Relationship Type ID * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $relationship_type_id; /** - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $relationship_direction; /** * Maximum number of related memberships. * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $max_related; /** - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $visibility; /** - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Receipt Text for membership signup * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $receipt_text_signup; /** * Receipt Text for membership renewal * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $receipt_text_renewal; /** * 0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required; * - * @var int + * @var int|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $auto_renew; /** * Is this membership_type enabled * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; diff --git a/CRM/PCP/DAO/PCP.php b/CRM/PCP/DAO/PCP.php index 70d9137abe..f0996d982c 100644 --- a/CRM/PCP/DAO/PCP.php +++ b/CRM/PCP/DAO/PCP.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/PCP/PCP.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0d2fc92a3a801a3eb5eca71989b21557) + * (GenCodeChecksum:9f11f3e21038c8027ad0e97497ccc356) */ /** @@ -34,98 +34,130 @@ class CRM_PCP_DAO_PCP extends CRM_Core_DAO { /** * Personal Campaign Page ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Contact ID * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $intro_text; /** - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $page_text; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $donate_link_text; /** * The Contribution or Event Page which triggered this pcp * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $page_id; /** * The type of PCP this is: contribute or event * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $page_type; /** * The pcp block that this pcp page was created from * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $pcp_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 $is_thermometer; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $is_honor_roll; /** * Goal amount of this Personal Campaign Page. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $goal_amount; /** * 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; /** * Is Personal Campaign Page enabled/active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Notify owner via email when someone donates to page? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_notify; diff --git a/CRM/PCP/DAO/PCPBlock.php b/CRM/PCP/DAO/PCPBlock.php index 57c7fc9fa4..351bb1b483 100644 --- a/CRM/PCP/DAO/PCPBlock.php +++ b/CRM/PCP/DAO/PCPBlock.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/PCP/PCPBlock.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:4b5ca843e0a3a2e4b439d03513b20682) + * (GenCodeChecksum:5528529230e5f5dbcfa0466ada0514d1) */ /** @@ -34,19 +34,25 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO { /** * PCP 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 $id; /** - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to civicrm_contribution_page.id OR civicrm_event.id * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; @@ -54,69 +60,89 @@ class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO { * The type of entity that this pcp targets * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $target_entity_type; /** * The entity that this pcp targets * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $target_entity_id; /** * FK to civicrm_uf_group.id. Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)? * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $supporter_profile_id; /** * FK to civicrm_option_group with name = PCP owner notifications * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $owner_notify_id; /** * Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_approval_needed; /** * Does Personal Campaign Page allow using tell a friend? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_tellfriend_enabled; /** * Maximum recipient fields allowed in tell a friend * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $tellfriend_limit; /** * Link text for PCP. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $link_text; /** * Is Personal Campaign Page Block enabled/active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * If set, notification is automatically emailed to this email-address on create/update Personal Campaign Page * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $notify_email; diff --git a/CRM/Pledge/DAO/Pledge.php b/CRM/Pledge/DAO/Pledge.php index 3fc96ac9f7..330bcb9732 100644 --- a/CRM/Pledge/DAO/Pledge.php +++ b/CRM/Pledge/DAO/Pledge.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Pledge/Pledge.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:bcc7d49479de858804a09bf49c1ebda9) + * (GenCodeChecksum:cbecc4833b44f7758722ef898cb8670b) */ /** @@ -41,49 +41,63 @@ class CRM_Pledge_DAO_Pledge extends CRM_Core_DAO { /** * Pledge ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Foreign key to civicrm_contact.id . * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * FK to Financial Type * - * @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; /** * The Contribution Page which triggered this contribution * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_page_id; /** * Total pledged amount. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount; /** * Original amount for each of the installments. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $original_installment_amount; /** * 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; @@ -91,109 +105,141 @@ class CRM_Pledge_DAO_Pledge extends CRM_Core_DAO { * Time units for recurrence of pledge payments. * * @var string + * (SQL type: varchar(8)) + * Note that values will be retrieved from the database as a string. */ public $frequency_unit; /** * Number of time units for recurrence of pledge payments. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $frequency_interval; /** * Day in the period when the pledge payment is due e.g. 1st of month, 15th etc. Use this to set the scheduled dates for pledge payments. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $frequency_day; /** * Total number of payments to be made. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $installments; /** * The date the first scheduled pledge occurs. * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $start_date; /** * When this pledge record was created. * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $create_date; /** * When a pledge acknowledgement message was sent to the contributor. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $acknowledge_date; /** * Last updated date for this pledge record. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $modified_date; /** * Date this pledge was cancelled by contributor. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $cancel_date; /** * Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount). * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $end_date; /** * The maximum number of payment reminders to send for any given payment. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $max_reminders; /** * Send initial reminder this many days prior to the payment due date. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $initial_reminder_day; /** * Send additional reminder this many days after last one sent, up to maximum number of reminders. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $additional_reminder_day; /** * Implicit foreign key to civicrm_option_values in the pledge_status option group. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_test; /** * The campaign for which this pledge has been initiated. * - * @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; diff --git a/CRM/Pledge/DAO/PledgeBlock.php b/CRM/Pledge/DAO/PledgeBlock.php index 209e60a3aa..020203b280 100644 --- a/CRM/Pledge/DAO/PledgeBlock.php +++ b/CRM/Pledge/DAO/PledgeBlock.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Pledge/PledgeBlock.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:37dd1b6ee946c78093489ce7a98c55e0) + * (GenCodeChecksum:a3bd49cda507ac9872922e16ff37a645) */ /** @@ -34,77 +34,99 @@ class CRM_Pledge_DAO_PledgeBlock extends CRM_Core_DAO { /** * Pledge ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * physical tablename for entity being joined to pledge, e.g. civicrm_contact * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * FK to entity table specified in entity_table column. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * Delimited list of supported frequency units * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $pledge_frequency_unit; /** * Is frequency interval exposed on the contribution form. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_pledge_interval; /** * The maximum number of payment reminders to send for any given payment. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $max_reminders; /** * Send initial reminder this many days prior to the payment due date. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $initial_reminder_day; /** * Send additional reminder this many days after last one sent, up to maximum number of reminders. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $additional_reminder_day; /** * The date the first scheduled pledge occurs. * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $pledge_start_date; /** * If true - recurring start date is shown. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_pledge_start_date_visible; /** * If true - recurring start date is editable. * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_pledge_start_date_editable; diff --git a/CRM/Pledge/DAO/PledgePayment.php b/CRM/Pledge/DAO/PledgePayment.php index f00e378564..74b6e56dae 100644 --- a/CRM/Pledge/DAO/PledgePayment.php +++ b/CRM/Pledge/DAO/PledgePayment.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Pledge/PledgePayment.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:bfa7183802af9f28111c1d7c7dc6af5a) + * (GenCodeChecksum:8d427bd23082d6b6dbad3492e9f668ca) */ /** @@ -32,68 +32,88 @@ class CRM_Pledge_DAO_PledgePayment extends CRM_Core_DAO { public static $_log = TRUE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to Pledge table * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $pledge_id; /** * FK to contribution table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_id; /** * Pledged amount for this payment (the actual contribution amount might be different). * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $scheduled_amount; /** * Actual amount that is paid as the Pledged installment amount. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $actual_amount; /** * 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 date the pledge payment is supposed to happen. * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $scheduled_date; /** * The date that the most recent payment reminder was sent. * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $reminder_date; /** * The number of payment reminders sent. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $reminder_count; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; diff --git a/CRM/Price/DAO/LineItem.php b/CRM/Price/DAO/LineItem.php index 4255cffa27..8eaf5a0997 100644 --- a/CRM/Price/DAO/LineItem.php +++ b/CRM/Price/DAO/LineItem.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Price/LineItem.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:27940b7d9e1152223c1fde0e32a8e909) + * (GenCodeChecksum:188e934ee3cca79e58490e0125c3b51b) */ /** @@ -34,7 +34,9 @@ class CRM_Price_DAO_LineItem extends CRM_Core_DAO { /** * Line Item * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,97 +44,125 @@ class CRM_Price_DAO_LineItem extends CRM_Core_DAO { * May contain civicrm_contribution, civicrm_participant or civicrm_membership * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * entry in table * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * FK to civicrm_contribution * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contribution_id; /** * FK to civicrm_price_field * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $price_field_id; /** * descriptive label for item - from price_field_value.label * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * How many items ordered * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $qty; /** * price of each item * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $unit_price; /** * qty * unit_price * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $line_total; /** * Participant count for field * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $participant_count; /** * FK to civicrm_price_field_value * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $price_field_value_id; /** * FK to Financial Type. * - * @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; /** * Portion of total amount which is NOT tax deductible. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $non_deductible_amount; /** * tax of each item * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $tax_amount; /** * Number of terms for this membership (only supported in Order->Payment flow). If the field is NULL it means unknown and it will be assumed to be 1 during payment.create if entity_table is civicrm_membership * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_num_terms; diff --git a/CRM/Price/DAO/PriceField.php b/CRM/Price/DAO/PriceField.php index 157576b0ba..809ccf6d48 100644 --- a/CRM/Price/DAO/PriceField.php +++ b/CRM/Price/DAO/PriceField.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Price/PriceField.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:9449b207c28052d794e6d0c9d179f51c) + * (GenCodeChecksum:e8aa16285c520e7ce5288da53397f9df) */ /** @@ -34,14 +34,18 @@ class CRM_Price_DAO_PriceField extends CRM_Core_DAO { /** * Price Field * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_price_set * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $price_set_id; @@ -49,6 +53,8 @@ class CRM_Price_DAO_PriceField extends CRM_Core_DAO { * Variable name/programmatic handle for this field. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -56,95 +62,123 @@ class CRM_Price_DAO_PriceField extends CRM_Core_DAO { * Text for form field label (also friendly name for administering this field). * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * @var string + * (SQL type: varchar(12)) + * Note that values will be retrieved from the database as a string. */ public $html_type; /** * Enter a quantity for this field? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_enter_qty; /** * Description and/or help text to display before this field. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * Description and/or help text to display after this field. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Order in which the fields should appear * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * Should the price be displayed next to the label for each option? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_display_amounts; /** * number of options per line for checkbox and radio * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $options_per_line; /** * Is this price field active * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Is this price field required (value must be > 1) * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_required; /** * If non-zero, do not show this field before the date specified * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $active_on; /** * If non-zero, do not show this field after the date specified * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $expire_on; /** * Optional scripting attributes for field * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $javascript; /** * Implicit FK to civicrm_option_group with name = 'visibility' * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $visibility_id; diff --git a/CRM/Price/DAO/PriceFieldValue.php b/CRM/Price/DAO/PriceFieldValue.php index d43cc16485..0eb232139d 100644 --- a/CRM/Price/DAO/PriceFieldValue.php +++ b/CRM/Price/DAO/PriceFieldValue.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Price/PriceFieldValue.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:7da3309222cffae75ba3d149e8acb395) + * (GenCodeChecksum:3596e8942576c06b6a393c4d16226de9) */ /** @@ -34,126 +34,162 @@ class CRM_Price_DAO_PriceFieldValue extends CRM_Core_DAO { /** * Price Field Value * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * FK to civicrm_price_field * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $price_field_id; /** * Price field option name * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Price field option label * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * Price field option description. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $description; /** * Price field option pre help text. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * Price field option post field help. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Price field option amount * - * @var float + * @var float|string + * (SQL type: decimal(18,9)) + * Note that values will be retrieved from the database as a string. */ public $amount; /** * Number of participants per field option * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $count; /** * Max number of participants per field options * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $max_value; /** * Order in which the field options should appear * - * @var int + * @var int|string|null + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * FK to Membership Type * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_type_id; /** * Number of terms for this membership * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $membership_num_terms; /** * Is this default price field option * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** * Is this price field value active * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * FK to Financial Type. * - * @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; /** * Portion of total amount which is NOT tax deductible. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $non_deductible_amount; /** * Implicit FK to civicrm_option_group with name = 'visibility' * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $visibility_id; diff --git a/CRM/Price/DAO/PriceSet.php b/CRM/Price/DAO/PriceSet.php index 3204d42e92..e434d718b5 100644 --- a/CRM/Price/DAO/PriceSet.php +++ b/CRM/Price/DAO/PriceSet.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Price/PriceSet.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:5c5630b1371dd1c8894a25b58ffbb5d9) + * (GenCodeChecksum:128263766d018b5c021df384b3ab6c92) */ /** @@ -34,14 +34,18 @@ class CRM_Price_DAO_PriceSet extends CRM_Core_DAO { /** * Price Set * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this price-set for * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; @@ -49,6 +53,8 @@ class CRM_Price_DAO_PriceSet extends CRM_Core_DAO { * Variable name/programmatic handle for this set of price fields. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -56,34 +62,44 @@ class CRM_Price_DAO_PriceSet extends CRM_Core_DAO { * Displayed title for the Price Set. * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; /** * Is this price set active * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Description and/or help text to display before fields in form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_pre; /** * Description and/or help text to display after fields in form. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $help_post; /** * Optional Javascript script function(s) included on the form with this price_set. Can be used for conditional * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $javascript; @@ -91,34 +107,44 @@ class CRM_Price_DAO_PriceSet extends CRM_Core_DAO { * What components are using this price set? * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $extends; /** * FK to Financial Type(for membership price sets only). * - * @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; /** * Is set if edited on Contribution or Event Page rather than through Manage Price Sets * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_quick_config; /** * Is this a predefined system price set (i.e. it can not be deleted, edited)? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; /** * Minimum Amount required for this set. * - * @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_amount; diff --git a/CRM/Price/DAO/PriceSetEntity.php b/CRM/Price/DAO/PriceSetEntity.php index 9d13d2992c..d78bef47da 100644 --- a/CRM/Price/DAO/PriceSetEntity.php +++ b/CRM/Price/DAO/PriceSetEntity.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Price/PriceSetEntity.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0be314d066d9e72b66c86a2de6d681a9) + * (GenCodeChecksum:a582c36064eb9613d9172b4eebcbc37e) */ /** @@ -34,7 +34,9 @@ class CRM_Price_DAO_PriceSetEntity extends CRM_Core_DAO { /** * Price Set Entity * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,20 +44,26 @@ class CRM_Price_DAO_PriceSetEntity extends CRM_Core_DAO { * Table which uses this price set * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $entity_table; /** * Item in table * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $entity_id; /** * price set being used * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $price_set_id; diff --git a/CRM/Queue/DAO/Queue.php b/CRM/Queue/DAO/Queue.php index 1cae113da0..fc5ce93eff 100644 --- a/CRM/Queue/DAO/Queue.php +++ b/CRM/Queue/DAO/Queue.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Queue/Queue.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:08890bdce3ccfede0d5963b2a0a6fa98) + * (GenCodeChecksum:5a49f8a2765460d48e4266efa9d447f2) */ /** @@ -31,7 +31,9 @@ class CRM_Queue_DAO_Queue extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -39,6 +41,8 @@ class CRM_Queue_DAO_Queue extends CRM_Core_DAO { * Name of the queue * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -46,13 +50,17 @@ class CRM_Queue_DAO_Queue extends CRM_Core_DAO { * Type of the queue * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $type; /** * Should the standard background attempt to autorun tasks in this queue? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_autorun; diff --git a/CRM/Queue/DAO/QueueItem.php b/CRM/Queue/DAO/QueueItem.php index a5119ea74a..7d4979ca95 100644 --- a/CRM/Queue/DAO/QueueItem.php +++ b/CRM/Queue/DAO/QueueItem.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Queue/QueueItem.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:ac660426ff024e9157038287191624b8) + * (GenCodeChecksum:36871610524adb64bc8aa3bb24b295f4) */ /** @@ -31,7 +31,9 @@ class CRM_Queue_DAO_QueueItem extends CRM_Core_DAO { public static $_log = FALSE; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -39,32 +41,42 @@ class CRM_Queue_DAO_QueueItem extends CRM_Core_DAO { * Name of the queue which includes this item * * @var string + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $queue_name; /** - * @var int + * @var int|string + * (SQL type: int) + * Note that values will be retrieved from the database as a string. */ public $weight; /** * date on which this item was submitted to the queue * - * @var datetime + * @var string + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $submit_time; /** * date on which this job becomes available; null if ASAP * - * @var datetime + * @var string|null + * (SQL type: datetime) + * Note that values will be retrieved from the database as a string. */ public $release_time; /** * Serialized queue data * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $data; diff --git a/CRM/Report/DAO/ReportInstance.php b/CRM/Report/DAO/ReportInstance.php index 2a1de9cd45..f5ce8c7171 100644 --- a/CRM/Report/DAO/ReportInstance.php +++ b/CRM/Report/DAO/ReportInstance.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/Report/ReportInstance.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:8119de0836afac038bfa8eeed2c0fb63) + * (GenCodeChecksum:0cc1db696d0899940ac62d266cb55a0a) */ /** @@ -41,21 +41,27 @@ class CRM_Report_DAO_ReportInstance extends CRM_Core_DAO { /** * Report Instance ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Which Domain is this instance for * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; /** * Report Instance Title. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $title; @@ -63,123 +69,159 @@ class CRM_Report_DAO_ReportInstance extends CRM_Core_DAO { * FK to civicrm_option_value for the report template * * @var string + * (SQL type: varchar(512)) + * Note that values will be retrieved from the database as a string. */ public $report_id; /** * when combined with report_id/template uniquely identifies the instance * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * arguments that are passed in the url when invoking the instance * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $args; /** * Report Instance description. * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $description; /** * permission required to be able to run this instance * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $permission; /** * role required to be able to run this instance * - * @var string + * @var string|null + * (SQL type: varchar(1024)) + * Note that values will be retrieved from the database as a string. */ public $grouprole; /** * Submitted form values for this report * - * @var longtext + * @var string|null + * (SQL type: longtext) + * Note that values will be retrieved from the database as a string. */ public $form_values; /** * Is this entry active? * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * FK to contact table. * - * @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; /** * FK to contact table. * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $owner_id; /** * Subject of email * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $email_subject; /** * comma-separated list of email addresses to send the report to * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $email_to; /** * comma-separated list of email addresses to send the report to * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $email_cc; /** * comma-separated list of email addresses to send the report to * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $header; /** * comma-separated list of email addresses to send the report to * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $footer; /** * FK to navigation ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $navigation_id; /** * FK to instance ID drilldown to * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $drilldown_id; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_reserved; diff --git a/CRM/SMS/DAO/Provider.php b/CRM/SMS/DAO/Provider.php index 37ed7ffcc5..290bcf0955 100644 --- a/CRM/SMS/DAO/Provider.php +++ b/CRM/SMS/DAO/Provider.php @@ -6,7 +6,7 @@ * * Generated from xml/schema/CRM/SMS/Provider.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:0411ce23fd693f810e4b17271b84e567) + * (GenCodeChecksum:0fc3229e1bb7ff0e9203e6c5c7ba3d6a) */ /** @@ -33,67 +33,89 @@ class CRM_SMS_DAO_Provider extends CRM_Core_DAO { /** * SMS Provider ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Provider internal name points to option_value of option_group sms_provider_name * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $name; /** * Provider name visible to user * - * @var string + * @var string|null + * (SQL type: varchar(64)) + * Note that values will be retrieved from the database as a string. */ public $title; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $username; /** - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $password; /** * points to value in civicrm_option_value for group sms_api_type * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $api_type; /** - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $api_url; /** * the api params in xml, http or smtp format * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $api_params; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_default; /** - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * Which Domain is this sms provider for * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $domain_id; diff --git a/ext/afform/core/CRM/Afform/DAO/AfformSubmission.php b/ext/afform/core/CRM/Afform/DAO/AfformSubmission.php index 5ab88359cd..aed8cdb28e 100644 --- a/ext/afform/core/CRM/Afform/DAO/AfformSubmission.php +++ b/ext/afform/core/CRM/Afform/DAO/AfformSubmission.php @@ -6,7 +6,7 @@ * * Generated from org.civicrm.afform/xml/schema/CRM/Afform/AfformSubmission.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6bffbfbde72fe38c0ab2bb8f49c945b8) + * (GenCodeChecksum:b7fb038bdf54aaf91859c3d455dd8756) */ use CRM_Afform_ExtensionUtil as E; @@ -34,31 +34,41 @@ class CRM_Afform_DAO_AfformSubmission extends CRM_Core_DAO { /** * Unique Submission ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Name of submitted afform * - * @var string + * @var string|null + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $afform_name; /** * IDs of saved entities * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $data; /** - * @var timestamp + * @var string|null + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $submission_date; diff --git a/ext/civigrant/CRM/Grant/DAO/Grant.php b/ext/civigrant/CRM/Grant/DAO/Grant.php index f3e11207be..a9a90d8cbf 100644 --- a/ext/civigrant/CRM/Grant/DAO/Grant.php +++ b/ext/civigrant/CRM/Grant/DAO/Grant.php @@ -6,7 +6,7 @@ * * Generated from civigrant/xml/schema/CRM/Grant/Grant.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:167313787dd6438c7433ead152cb9893) + * (GenCodeChecksum:bd866aa053f6871792fdecfc4aa3c92a) */ use CRM_Grant_ExtensionUtil as E; @@ -53,77 +53,99 @@ class CRM_Grant_DAO_Grant extends CRM_Core_DAO { /** * Unique Grant id * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * Contact ID of contact record given grant belongs to. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Date on which grant application was received by donor. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $application_received_date; /** * Date on which grant decision was made. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $decision_date; /** * Date on which grant money transfer was made. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $money_transfer_date; /** * Date on which grant report is due. * - * @var date + * @var string|null + * (SQL type: date) + * Note that values will be retrieved from the database as a string. */ public $grant_due_date; /** * Yes/No field stating whether grant report was received by donor. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $grant_report_received; /** * Type of grant. Implicit FK to civicrm_option_value in grant_type option_group. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $grant_type_id; /** * Requested grant amount, in default currency. * - * @var float + * @var float|string + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount_total; /** * Requested grant amount, in original currency (optional). * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount_requested; /** * Granted amount, in default currency. * - * @var float + * @var float|string|null + * (SQL type: decimal(20,2)) + * Note that values will be retrieved from the database as a string. */ public $amount_granted; @@ -131,27 +153,35 @@ class CRM_Grant_DAO_Grant extends CRM_Core_DAO { * 3 character string, value from config setting or input via user. * * @var string + * (SQL type: varchar(3)) + * Note that values will be retrieved from the database as a string. */ public $currency; /** * Grant rationale. * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $rationale; /** * ID of Grant status. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $status_id; /** * FK to Financial Type. * - * @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; diff --git a/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php b/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php index 92d2f4378e..8ef1e32107 100644 --- a/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php +++ b/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php @@ -6,7 +6,7 @@ * * Generated from oauth-client/xml/schema/CRM/OAuth/OAuthClient.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:16542326ad093d2d6826a11f1576522e) + * (GenCodeChecksum:6d11e5e77e49b52267e60124c13d9fa4) */ use CRM_OAuth_ExtensionUtil as E; @@ -34,7 +34,9 @@ class CRM_OAuth_DAO_OAuthClient extends CRM_Core_DAO { /** * Internal Client ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,6 +44,8 @@ class CRM_OAuth_DAO_OAuthClient extends CRM_Core_DAO { * Provider * * @var string + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $provider; @@ -49,41 +53,53 @@ class CRM_OAuth_DAO_OAuthClient extends CRM_Core_DAO { * Client ID * * @var string + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $guid; /** * Client Secret * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $secret; /** * Extra override options for the service (JSON) * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $options; /** * Is the client currently enabled? * - * @var bool + * @var bool|string + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $is_active; /** * When the client was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the client was created or modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/ext/oauth-client/CRM/OAuth/DAO/OAuthContactToken.php b/ext/oauth-client/CRM/OAuth/DAO/OAuthContactToken.php index 691a37b578..65305eb68e 100644 --- a/ext/oauth-client/CRM/OAuth/DAO/OAuthContactToken.php +++ b/ext/oauth-client/CRM/OAuth/DAO/OAuthContactToken.php @@ -6,7 +6,7 @@ * * Generated from oauth-client/xml/schema/CRM/OAuth/OAuthContactToken.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:48364c8d563f29a459f0c3ccbe4f1c8e) + * (GenCodeChecksum:1246756a94c72807dc6cb4bc2c70bb7e) */ use CRM_OAuth_ExtensionUtil as E; @@ -34,112 +34,144 @@ class CRM_OAuth_DAO_OAuthContactToken extends CRM_Core_DAO { /** * Token ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The tag specifies how this token will be used. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $tag; /** * Client ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $client_id; /** * Contact ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $contact_id; /** * Ex: authorization_code * - * @var string + * @var string|null + * (SQL type: varchar(31)) + * Note that values will be retrieved from the database as a string. */ public $grant_type; /** * List of scopes addressed by this token * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $scopes; /** * Ex: Bearer or MAC * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $token_type; /** * Token to present when accessing resources * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $access_token; /** * Expiration time for the access_token (seconds since epoch) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $expires; /** * Token to present when refreshing the access_token * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $refresh_token; /** * Identifier for the resource owner. Structure varies by service. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $resource_owner_name; /** * Cached details describing the resource owner * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $resource_owner; /** * ?? copied from OAuthSysToken * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $error; /** * The token response data, per AccessToken::jsonSerialize * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $raw; /** * When the token was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the token was created or modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php b/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php index 6e924542e9..ee08c34ada 100644 --- a/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php +++ b/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php @@ -6,7 +6,7 @@ * * Generated from oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:75d2f40faea06bdd175a66124d1ac77d) + * (GenCodeChecksum:14387fad3c51ab994575b3cd759e6229) */ use CRM_OAuth_ExtensionUtil as E; @@ -34,105 +34,135 @@ class CRM_OAuth_DAO_OAuthSysToken extends CRM_Core_DAO { /** * Token ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; /** * The tag specifies how this token will be used. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $tag; /** * Client ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $client_id; /** * Ex: authorization_code * - * @var string + * @var string|null + * (SQL type: varchar(31)) + * Note that values will be retrieved from the database as a string. */ public $grant_type; /** * List of scopes addressed by this token * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $scopes; /** * Ex: Bearer or MAC * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $token_type; /** * Token to present when accessing resources * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $access_token; /** * Expiration time for the access_token (seconds since epoch) * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $expires; /** * Token to present when refreshing the access_token * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $refresh_token; /** * Identifier for the resource owner. Structure varies by service. * - * @var string + * @var string|null + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $resource_owner_name; /** * Cached details describing the resource owner * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $resource_owner; /** * List of scopes addressed by this token * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $error; /** * The token response data, per AccessToken::jsonSerialize * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $raw; /** * When the token was created. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $created_date; /** * When the token was created or modified. * - * @var timestamp + * @var string + * (SQL type: timestamp) + * Note that values will be retrieved from the database as a string. */ public $modified_date; diff --git a/ext/search_kit/CRM/Search/DAO/SearchDisplay.php b/ext/search_kit/CRM/Search/DAO/SearchDisplay.php index c7dfeb7b18..3ecead8308 100644 --- a/ext/search_kit/CRM/Search/DAO/SearchDisplay.php +++ b/ext/search_kit/CRM/Search/DAO/SearchDisplay.php @@ -6,7 +6,7 @@ * * Generated from org.civicrm.search_kit/xml/schema/CRM/Search/SearchDisplay.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:6d44d0c212e3f352182cac098e4d44ac) + * (GenCodeChecksum:d67945fe44bd5c7f1822580239f044ab) */ use CRM_Search_ExtensionUtil as E; @@ -34,7 +34,9 @@ class CRM_Search_DAO_SearchDisplay extends CRM_Core_DAO { /** * Unique SearchDisplay ID * - * @var int + * @var int|string|null + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $id; @@ -42,6 +44,8 @@ class CRM_Search_DAO_SearchDisplay extends CRM_Core_DAO { * Unique name for identifying search display * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $name; @@ -49,13 +53,17 @@ class CRM_Search_DAO_SearchDisplay extends CRM_Core_DAO { * Label for identifying search display to administrators * * @var string + * (SQL type: varchar(255)) + * Note that values will be retrieved from the database as a string. */ public $label; /** * FK to saved search table. * - * @var int + * @var int|string + * (SQL type: int unsigned) + * Note that values will be retrieved from the database as a string. */ public $saved_search_id; @@ -63,20 +71,26 @@ class CRM_Search_DAO_SearchDisplay extends CRM_Core_DAO { * Type of display * * @var string + * (SQL type: varchar(128)) + * Note that values will be retrieved from the database as a string. */ public $type; /** * Configuration data for the search display * - * @var text + * @var string|null + * (SQL type: text) + * Note that values will be retrieved from the database as a string. */ public $settings; /** * Skip permission checks and ACLs when running this display. * - * @var bool + * @var bool|string|null + * (SQL type: tinyint) + * Note that values will be retrieved from the database as a string. */ public $acl_bypass; @@ -213,7 +227,7 @@ class CRM_Search_DAO_SearchDisplay extends CRM_Core_DAO { 'title' => E::ts('Search Display Settings'), 'description' => E::ts('Configuration data for the search display'), 'where' => 'civicrm_search_display.settings', - 'default' => 'NULL', + 'default' => NULL, 'table_name' => 'civicrm_search_display', 'entity' => 'SearchDisplay', 'bao' => 'CRM_Search_DAO_SearchDisplay', -- 2.25.1