APIv4 - Declare option `$translationMode` (for DAOGetAction)
authorTim Otten <totten@civicrm.org>
Fri, 5 Aug 2022 10:30:39 +0000 (03:30 -0700)
committerEileen McNaughton <emcnaughton@wikimedia.org>
Thu, 1 Sep 2022 06:51:02 +0000 (18:51 +1200)
Civi/Api4/Generic/DAOGetAction.php

index 0c33d2acc0bf8a34b19c33727df4a89d320b87ed..3d6c8753e8ad5fd96a1b7aea217f5957ac104eab 100644 (file)
@@ -24,6 +24,8 @@ use Civi\Api4\Utils\CoreUtil;
  *
  * @method $this setHaving(array $clauses)
  * @method array getHaving()
+ * @method $this setTranslationMode(string|null $mode)
+ * @method string|null getTranslationMode()
  */
 class DAOGetAction extends AbstractGetAction {
   use Traits\DAOActionTrait;
@@ -80,6 +82,15 @@ class DAOGetAction extends AbstractGetAction {
    */
   protected $having = [];
 
+  /**
+   * Should we automatically overload the result with translated data?
+   * How do we pick the suitable translation?
+   *
+   * @var string|null
+   * @options fuzzy,strict
+   */
+  protected $translationMode;
+
   /**
    * @throws \API_Exception
    * @throws \CRM_Core_Exception