(NFC) FieldSpec - Docblock for $type
authorTim Otten <totten@civicrm.org>
Fri, 16 Jul 2021 06:36:13 +0000 (23:36 -0700)
committerTim Otten <totten@civicrm.org>
Fri, 16 Jul 2021 06:38:24 +0000 (23:38 -0700)
Civi/Api4/Service/Spec/FieldSpec.php

index f971b16de81221b397337ffbaa1256678079ad0b..f8f54248869f4df068cc1f84a32a7efc73aa2d72 100644 (file)
@@ -45,6 +45,11 @@ class FieldSpec {
   public $defaultValue;
 
   /**
+   * Meta-type indicating how this field was defined/implemented.
+   *
+   * Ex: 'Field' (normal/standard DB field), 'Custom' (auxiliary DB field),
+   * 'Filter' (read-oriented filter option), 'Extra' (special/programmatic field).
+   *
    * @var string
    */
   public $type = 'Extra';