Merge pull request #22631 from braders/calculateBaseScheduleDate-docblock
[civicrm-core.git] / CRM / Core / DAO / UFField.php
index ba2cdcba545b7c406d6c31e823684c00db50b1ea..a35a7cc36844291f4849fff2f8f8b0fff883e4f6 100644 (file)
@@ -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;