From 7c166c4757279cfdc5f85e10cc6f5aa786b82209 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Tue, 12 Jun 2018 18:40:18 -0700
Subject: [PATCH] Proof-of-concept - Afform.create

---
 ext/afform/api/v3/Afform/Create.php           | 66 +++++++++++++++++++
 .../phpunit/api/v3/Afform/CreateTest.php      | 49 ++++++++++++++
 2 files changed, 115 insertions(+)
 create mode 100644 ext/afform/api/v3/Afform/Create.php
 create mode 100644 ext/afform/tests/phpunit/api/v3/Afform/CreateTest.php

diff --git a/ext/afform/api/v3/Afform/Create.php b/ext/afform/api/v3/Afform/Create.php
new file mode 100644
index 0000000000..8381482432
--- /dev/null
+++ b/ext/afform/api/v3/Afform/Create.php
@@ -0,0 +1,66 @@
+<?php
+use CRM_Afform_ExtensionUtil as E;
+
+/**
+ * Afform.Create API specification (optional)
+ * This is used for documentation and validation.
+ *
+ * @param array $spec description of fields supported by this API call
+ * @return void
+ * @see http://wiki.civicrm.org/confluence/display/CRMDOC/API+Architecture+Standards
+ */
+function _civicrm_api3_afform_create_spec(&$spec) {
+  require_once __DIR__ . DIRECTORY_SEPARATOR . 'Get.php';
+  _civicrm_api3_afform_get_spec($spec);
+}
+
+/**
+ * Afform.Create API
+ *
+ * @param array $params
+ * @return array API result descriptor
+ * @see civicrm_api3_create_success
+ * @see civicrm_api3_create_error
+ * @throws API_Exception
+ */
+function civicrm_api3_afform_create($params) {
+  $scanner = new CRM_Afform_AfformScanner();
+  $converter = new CRM_Afform_ArrayHtml();
+
+  if (empty($params['name']) || !preg_match('/^[a-zA-Z][a-zA-Z0-9\-]*$/', $params['name'])) {
+    throw new \API_Exception("Afform.create: name is a mandatory field. It should use alphanumerics and dashes.");
+  }
+  $name = $params['name'];
+
+  // FIXME validate all field data.
+  $updates = _afform_fields_filter($params);
+
+  // Create or update layout.html.
+  if (isset($updates['layout'])) {
+    $layoutPath = $scanner->createSiteLocalPath($name, 'layout.html');
+    // printf("[%s] Update layout %s\n", $name, $layoutPath);
+    CRM_Utils_File::createDir(dirname($layoutPath));
+    file_put_contents($layoutPath, $converter->convertArrayToHtml($updates['layout']));
+    // FIXME check for writability then success. Report errors.
+  }
+
+  // Create or update meta.json.
+  $orig = civicrm_api('afform', 'get', ['name' => $name, 'sequential' => 1]);
+  if (is_array($orig['values'][0])) {
+    $meta = _afform_fields_filter(array_merge($orig['values'][0], $updates));
+  }
+  else {
+    $meta = $updates;
+  }
+  unset($meta['definition']);
+  unset($meta['name']);
+  if (!empty($meta)) {
+    $metaPath = $scanner->createSiteLocalPath($name, CRM_Afform_AfformScanner::METADATA_FILE);
+    // printf("[%s] Update meta %s: %s\n", $name, $metaPath, print_R(['updates'=>$updates, 'meta'=>$meta], 1));
+    CRM_Utils_File::createDir(dirname($metaPath));
+    file_put_contents($metaPath, json_encode($meta, JSON_PRETTY_PRINT));
+    // FIXME check for writability then success. Report errors.
+  }
+
+  return civicrm_api3_create_success($updates, $params, 'Afform', 'create');
+}
diff --git a/ext/afform/tests/phpunit/api/v3/Afform/CreateTest.php b/ext/afform/tests/phpunit/api/v3/Afform/CreateTest.php
new file mode 100644
index 0000000000..5fe2c9f8c8
--- /dev/null
+++ b/ext/afform/tests/phpunit/api/v3/Afform/CreateTest.php
@@ -0,0 +1,49 @@
+<?php
+
+use Civi\Test\HeadlessInterface;
+use Civi\Test\HookInterface;
+use Civi\Test\TransactionalInterface;
+
+/**
+ * Afform.Create API Test Case
+ * This is a generic test class implemented with PHPUnit.
+ * @group headless
+ */
+class api_v3_Afform_CreateTest extends \PHPUnit_Framework_TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
+
+  /**
+   * Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
+   * See: https://github.com/civicrm/org.civicrm.testapalooza/blob/master/civi-test.md
+   */
+  public function setUpHeadless() {
+    return \Civi\Test::headless()
+      ->installMe(__DIR__)
+      ->apply();
+  }
+
+  /**
+   * The setup() method is executed before the test is executed (optional).
+   */
+  public function setUp() {
+    parent::setUp();
+  }
+
+  /**
+   * The tearDown() method is executed after the test was executed (optional)
+   * This can be used for cleanup.
+   */
+  public function tearDown() {
+    parent::tearDown();
+  }
+
+  /**
+   * Simple example test case.
+   *
+   * Note how the function name begins with the word "test".
+   */
+  public function testApiExample() {
+    $result = civicrm_api3('Afform', 'Create', array('magicword' => 'sesame'));
+    $this->assertEquals('Twelve', $result['values'][12]['name']);
+  }
+
+}
-- 
2.25.1