From: Tim Otten <totten@civicrm.org>
Date: Fri, 16 Jul 2021 06:36:13 +0000 (-0700)
Subject: (NFC) FieldSpec - Docblock for $type
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=32178ba7ab9b870fb898ac72da89f05dac961842;p=civicrm-core.git

(NFC) FieldSpec - Docblock for $type
---

diff --git a/Civi/Api4/Service/Spec/FieldSpec.php b/Civi/Api4/Service/Spec/FieldSpec.php
index f971b16de8..f8f5424886 100644
--- a/Civi/Api4/Service/Spec/FieldSpec.php
+++ b/Civi/Api4/Service/Spec/FieldSpec.php
@@ -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';