Merge pull request #23901 from totten/nfc-install-docblock
[civicrm-core.git] / Civi / Api4 / CustomField.php
index d92f51c97ca7442e86dda898ea0ec56e153e734d..413d268d40cfb1c1699ef9c8f54b309ee5e2d94d 100644 (file)
@@ -15,10 +15,40 @@ namespace Civi\Api4;
  *
  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/creating-custom-fields/
  * @searchable secondary
+ * @orderBy weight
+ * @groupWeightsBy custom_group_id
  * @since 5.19
  * @package Civi\Api4
  */
 class CustomField extends Generic\DAOEntity {
   use Generic\Traits\ManagedEntity;
+  use Generic\Traits\SortableEntity;
+
+  /**
+   * @param bool $checkPermissions
+   * @return Action\CustomField\Create
+   */
+  public static function create($checkPermissions = TRUE) {
+    return (new Action\CustomField\Create(__CLASS__, __FUNCTION__))
+      ->setCheckPermissions($checkPermissions);
+  }
+
+  /**
+   * @param bool $checkPermissions
+   * @return Action\CustomField\Save
+   */
+  public static function save($checkPermissions = TRUE) {
+    return (new Action\CustomField\Save(__CLASS__, __FUNCTION__))
+      ->setCheckPermissions($checkPermissions);
+  }
+
+  /**
+   * @param bool $checkPermissions
+   * @return Action\CustomField\Update
+   */
+  public static function update($checkPermissions = TRUE) {
+    return (new Action\CustomField\Update(__CLASS__, __FUNCTION__))
+      ->setCheckPermissions($checkPermissions);
+  }
 
 }