create-entity-server 0.0.9 → 0.0.23

package/template/samples/php/ci4/Controllers/EntityController.php

@@ -0,0 +1,202 @@
+<?php
+
+namespace App\Controllers;
+
+use App\Controllers\BaseController;
+use App\Libraries\EntityServer;
+
+/**
+ * EntityServer CRUD를 CI4 컨트롤러에서 공통으로 사용하는 베이스 컨트롤러.
+ *
+ * 사용법:
+ *  class ProductController extends EntityController {
+ *      protected string $entity = 'product';
+ *  }
+ */
+abstract class EntityController extends BaseController
+{
+    protected EntityServer $es;
+
+    /** 대상 엔티티명 (하위 컨트롤러에서 지정) */
+    protected string $entity = '';
+
+    /**
+     * 푸시 트리거용 엔티티명 (기본: 시스템 엔티티 push_msg)
+     *
+     * 주의: push 인프라 필수 엔티티는 account_device / push_msg / push_log 이며,
+     * 이 값은 "어떤 엔티티 insert로 push hook를 트리거할지"를 결정합니다.
+     */
+    protected string $pushEntity = 'push_msg';
+
+    /** pushEntity에서 수신자를 가리키는 필드명 */
+    protected string $pushTargetField = 'account_seq';
+
+    public function __construct()
+    {
+        $this->es = new EntityServer();
+    }
+
+    /** GET /{entity}/list?page=1&limit=20 */
+    public function list(): string
+    {
+        $page  = (int) ($this->request->getGet('page') ?? 1);
+        $limit = (int) ($this->request->getGet('limit') ?? 20);
+
+        $result = $this->es->list($this->entity, [
+            'page'  => $page,
+            'limit' => $limit,
+        ]);
+
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** GET /{entity}/get/(:num) */
+    public function get(int $seq): string
+    {
+        $result = $this->es->get($this->entity, $seq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** POST /{entity}/query */
+    public function query(): string
+    {
+        try {
+            $body = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
+        $filter = $body['filter'] ?? [];
+        $params = [
+            'page'  => $body['page'] ?? 1,
+            'limit' => $body['limit'] ?? 20,
+        ];
+
+        $result = $this->es->query($this->entity, $filter, $params);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /**
+     * POST /{entity}/submit
+     * POST /{entity}/submit/(:num)  (seq route param을 body에 주입)
+     */
+    public function submit(?int $seq = null): string
+    {
+        try {
+            $data = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
+        if ($seq !== null) {
+            $data['seq'] = $seq;
+        }
+
+        $result = $this->es->submit($this->entity, $data);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** DELETE /{entity}/delete/(:num) */
+    public function delete(int $seq): string
+    {
+        $result = $this->es->delete($this->entity, $seq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** GET /{entity}/history/(:num) */
+    public function history(int $seq): string
+    {
+        $result = $this->es->history($this->entity, $seq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** POST /{entity}/rollback/(:num) */
+    public function rollback(int $historySeq): string
+    {
+        $result = $this->es->rollback($this->entity, $historySeq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /**
+     * POST /{entity}/push
+     *
+     * push hook가 연결된 엔티티(push_msg 등)에 submit하여 푸시를 발행합니다.
+     * 요청 예:
+     * {
+     *   "account_seq": 1,
+     *   "title": "알림 제목",
+     *   "message": "알림 본문",
+     *   "ref_entity": "order",
+     *   "ref_seq": 123,
+     *   "data": {"order_seq": "123"}
+     * }
+     */
+    public function push(): string
+    {
+        try {
+            $body = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
+        $target = (int) ($body[$this->pushTargetField] ?? 0);
+        if ($target <= 0) {
+            return $this->response->setStatusCode(400)
+                ->setJSON([
+                    'ok'      => false,
+                    'message' => sprintf('%s required', $this->pushTargetField),
+                ])
+                ->getBody();
+        }
+
+        $title = (string) ($body['title'] ?? '');
+        $message = (string) ($body['message'] ?? $body['body'] ?? '');
+
+        $payload = [
+            $this->pushTargetField => $target,
+            'title'                => $title,
+            'message'              => $message,
+        ];
+
+        if (isset($body['ref_entity'])) {
+            $payload['ref_entity'] = (string) $body['ref_entity'];
+        }
+        if (isset($body['ref_seq'])) {
+            $payload['ref_seq'] = (int) $body['ref_seq'];
+        }
+        if (isset($body['data']) && is_array($body['data'])) {
+            $payload['data'] = $body['data'];
+        }
+
+        $result = $this->es->push($this->pushEntity, $payload);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /**
+     * GET /{entity}/push-log/list?page=1&limit=20&account_seq=1
+     */
+    public function pushLogList(): string
+    {
+        $page  = (int) ($this->request->getGet('page') ?? 1);
+        $limit = (int) ($this->request->getGet('limit') ?? 20);
+
+        $params = [
+            'page'  => $page,
+            'limit' => $limit,
+        ];
+
+        $accountSeq = (int) ($this->request->getGet('account_seq') ?? 0);
+        if ($accountSeq > 0) {
+            $params['account_seq'] = $accountSeq;
+        }
+
+        $result = $this->es->pushLogList($params);
+        return $this->response->setJSON($result)->getBody();
+    }
+}

package/template/samples/php/ci4/Controllers/ProductController.php

@@ -2,81 +2,14 @@
 
 namespace App\Controllers;
 
-use App\Controllers\BaseController;
-use App\Libraries\EntityServer;
-
 /**
- * EntityServer 라이브러리를 사용하는 CI4 컨트롤러 예시
+ * Product 전용 컨트롤러 예시.
+ * 기본 CRUD는 EntityController를 상속받아 그대로 사용하고,
+ * 확장 기능(order)만 이 컨트롤러에서 구현합니다.
  */
-class ProductController extends BaseController
+class ProductController extends EntityController
 {
-    private EntityServer $es;
-
-    public function __construct()
-    {
-        $this->es = new EntityServer();
-    }
-
-    /** GET /products */
-    public function index(): string
-    {
-        $page   = (int) ($this->request->getGet('page')  ?? 1);
-        $limit  = (int) ($this->request->getGet('limit') ?? 20);
-        $result = $this->es->list('product', ['page' => $page, 'limit' => $limit]);
-
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** GET /products/(:num) */
-    public function show(int $seq): string
-    {
-        $result = $this->es->get('product', $seq);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** POST /products/search */
-    public function search(): string
-    {
-        $body   = $this->request->getJSON(true);
-        $filter = $body['filter'] ?? [];
-        $params = ['page' => $body['page'] ?? 1, 'limit' => $body['limit'] ?? 20];
-
-        // 필터 예: [['field' => 'category', 'op' => 'eq', 'value' => 'electronics']]
-        $result = $this->es->query('product', $filter, $params);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** POST /products */
-    public function create(): string
-    {
-        $data   = $this->request->getJSON(true);
-        // seq 없이 submit → 생성
-        $result = $this->es->submit('product', $data);
-        return $this->response->setStatusCode(201)->setJSON($result)->getBody();
-    }
-
-    /** PUT /products/(:num) */
-    public function update(int $seq): string
-    {
-        $data        = $this->request->getJSON(true);
-        $data['seq'] = $seq; // seq 포함 → 수정
-        $result      = $this->es->submit('product', $data);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** DELETE /products/(:num) */
-    public function delete(int $seq): string
-    {
-        $result = $this->es->delete('product', $seq);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** GET /products/(:num)/history */
-    public function history(int $seq): string
-    {
-        $result = $this->es->history('product', $seq);
-        return $this->response->setJSON($result)->getBody();
-    }
+    protected string $entity = 'product';
 
     /**
      * POST /products/order
@@ -90,7 +23,14 @@ class ProductController extends BaseController
      */
     public function order(): string
     {
-        $body        = $this->request->getJSON(true);
+        try {
+            $body = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
         $productSeq  = (int) ($body['product_seq'] ?? 0);
         $qty         = (int) ($body['qty']         ?? 1);
         $buyer       = $body['buyer'] ?? '';
@@ -101,16 +41,16 @@ class ProductController extends BaseController
                 ->getBody();
         }
 
-        $this->es->transStart(); // 서버 큐 등록, 이후 submit / delete 시 큐에씀임
+        $this->es->transStart(); // 서버 큐 등록, 이후 submit / delete 는 큐에 적재
 
         try {
             // 1) 상품 조회 후 재고 차감
-            $product = $this->es->get('product', $productSeq);
+            $product = $this->es->get($this->entity, $productSeq);
             $stock   = (int) ($product['data']['stock'] ?? 0);
             if ($stock < $qty) {
                 throw new \RuntimeException('재고 부족');
             }
-            $this->es->submit('product', [
+            $this->es->submit($this->entity, [
                 'seq'   => $productSeq,
                 'stock' => $stock - $qty,
             ]);