1 files changed, 105 insertions, 0 deletions
diff --git a/www/crm/wp-content/plugins/civicrm/civicrm/ext/api4/Civi/Api4/Generic/AbstractQueryAction.php b/www/crm/wp-content/plugins/civicrm/civicrm/ext/api4/Civi/Api4/Generic/AbstractQueryAction.php
new file mode 100644
index 00000000..993383dc
--- /dev/null
+++ b/www/crm/wp-content/plugins/civicrm/civicrm/ext/api4/Civi/Api4/Generic/AbstractQueryAction.php
@@ -0,0 +1,105 @@
+<?php
+
+namespace Civi\Api4\Generic;
+
+/**
+ * Base class for all actions that need to fetch records (Get, Update, Delete, etc)
+ *
+ * @package Civi\Api4\Generic
+ *
+ * @method $this setWhere(array $wheres)
+ * @method array getWhere()
+ * @method $this setOrderBy(array $order)
+ * @method array getOrderBy()
+ * @method $this setLimit(int $limit)
+ * @method int getLimit()
+ * @method $this setOffset(int $offset)
+ * @method int getOffset()
+ */
+abstract class AbstractQueryAction extends AbstractAction {
+
+  /**
+   * Criteria for selecting items.
+   *
+   * $example->addWhere('contact_type', 'IN', array('Individual', 'Household'))
+   *
+   * @var array
+   */
+  protected $where = [];
+
+  /**
+   * Array of field(s) to use in ordering the results
+   *
+   * Defaults to id ASC
+   *
+   * $example->addOrderBy('sort_name', 'ASC')
+   *
+   * @var array
+   */
+  protected $orderBy = [];
+
+  /**
+   * Maximum number of results to return.
+   *
+   * Defaults to unlimited.
+   *
+   * Note: the Api Explorer sets this to 25 by default to avoid timeouts.
+   * Change or remove this default for your application code.
+   *
+   * @var int
+   */
+  protected $limit = 0;
+
+  /**
+   * Zero-based index of first result to return.
+   *
+   * Defaults to "0" - first record.
+   *
+   * @var int
+   */
+  protected $offset = 0;
+
+  /**
+   * @param string $field
+   * @param string $op
+   * @param mixed $value
+   * @return $this
+   * @throws \API_Exception
+   */
+  public function addWhere($field, $op, $value = NULL) {
+    if (!in_array($op, \CRM_Core_DAO::acceptedSQLOperators())) {
+      throw new \API_Exception('Unsupported operator');
+    }
+    $this->where[] = [$field, $op, $value];
+    return $this;
+  }
+
+  /**
+   * Adds one or more AND/OR/NOT clause groups
+   *
+   * @param string $operator
+   * @param mixed $condition1 ... $conditionN
+   *   Either a nested array of arguments, or a variable number of arguments passed to this function.
+   *
+   * @return $this
+   * @throws \API_Exception
+   */
+  public function addClause($operator, $condition1) {
+    if (!is_array($condition1[0])) {
+      $condition1 = array_slice(func_get_args(), 1);
+    }
+    $this->where[] = [$operator, $condition1];
+    return $this;
+  }
+
+  /**
+   * @param string $field
+   * @param string $direction
+   * @return $this
+   */
+  public function addOrderBy($field, $direction = 'ASC') {
+    $this->orderBy[$field] = $direction;
+    return $this;
+  }
+
+}