[Crud] Adds ability to pass table options through CRUD (#114)

Author: cnizzardini

plugins/crud/README.md

@@ -51,13 +51,13 @@ Once enabled, the following services may be injected into your controller action
 use MixerApi\Crud\Interfaces\{CreateInterface, ReadInterface, UpdateInterface, DeleteInterface, SearchInterface};
 ```
 
-| Interface | Injected Service | Use-cases |
-| ------------- | ------------- |  ------------- |
-| CreateInterface | MixerApi\Crud\Service\Create | `add()` actions |
-| ReadInterface | MixerApi\Crud\Service\Read | `view()` actions |
-| UpdateInterface | MixerApi\Crud\Service\Update | `edit()` actions |
+| Interface       | Injected Service             | Use-cases          |
+|-----------------|------------------------------|--------------------|
+| CreateInterface | MixerApi\Crud\Service\Create | `add()` actions    |
+| ReadInterface   | MixerApi\Crud\Service\Read   | `view()` actions   |
+| UpdateInterface | MixerApi\Crud\Service\Update | `edit()` actions   |
 | DeleteInterface | MixerApi\Crud\Service\Delete | `delete()` actions |
-| SearchInterface | MixerApi\Crud\Service\Search | `index()` actions |
+| SearchInterface | MixerApi\Crud\Service\Search | `index()` actions  |
 
 All Crud services infer the table name from the controller, you can change the table name by calling the
 `setTableName($name)` method.
@@ -76,6 +76,16 @@ public function add(CreateInterface $create)
 }
 ```
 
+Note, `save()` with `$options` is supported.
+
+```php
+return $create->save($this, [
+    'accessibleFields' => [
+        'password' => true,
+    ]
+]);
+```
+
 ### Read
 
 ```php
@@ -85,13 +95,18 @@ public function view(ReadInteface $read)
 }
 ```
 
+Note, `read()` with `$options` is supported.
+
+```php
+return $read->save($this, ['contains' => ['OtherTable']]);
+```
+
 Return a CakePHP `Query` object instead:
 
 ```php
 $query = $read->query($this)
 ```
 
-
 ### Update
 
 ```php
@@ -101,6 +116,16 @@ public function edit(UpdateInterface $update)
 }
 ```
 
+Note, `update()` with `$options` is supported.
+
+```php
+return $update->save($this, [
+    'accessibleFields' => [
+        'password' => true,
+    ]
+]);
+```
+
 ### Delete
 
 ```php
@@ -110,6 +135,12 @@ public function delete(DeleteInterface $delete)
 }
 ```
 
+Note, `delete()` with `$options` is supported.
+
+```php
+return $delete->delete($this, ['atomic' => false]);
+```
+
 ### Search
 
 The Search service works with [Pagination](https://book.cakephp.org/4/en/controllers/components/pagination.html) and
@@ -153,13 +184,13 @@ operations and will not run for non-crud operations. See [Options](#plugin-optio
 Allowed methods is handled by a `Controller.initialize` listener. See [Plugin Options](#plugin-options) for disabling or
 modifying the defaults.
 
-| Action | HTTP method(s) |
-| ------------- | ------------- |
-| index() | GET |
-| view() | GET |
-| add() | POST |
-| edit() | POST, PUT, and PATCH |
-| delete() | DELETE |
+| Action   | HTTP method(s)       |
+|----------|----------------------|
+| index()  | GET                  |
+| view()   | GET                  |
+| add()    | POST                 |
+| edit()   | POST, PUT, and PATCH |
+| delete() | DELETE               |
 
 You may also call `setAllowMethods($methods)` on any service to overwrite the default behavior. This accepts a string
 or any array as an argument just like the native `$request->allowedMethods()`.

plugins/crud/src/Interfaces/CreateInterface.php

@@ -15,9 +15,10 @@ interface CreateInterface
      * Creates the resource
      *
      * @param \Cake\Controller\Controller $controller the cakephp controller instance
+     * @param \Cake\ORM\SaveOptionsBuilder|\ArrayAccess|array $options The options to use when saving.
      * @return \Cake\Datasource\EntityInterface
      */
-    public function save(Controller $controller): EntityInterface;
+    public function save(Controller $controller, $options = []): EntityInterface;
 
     /**
      * @param string $table the table name

plugins/crud/src/Interfaces/DeleteInterface.php

@@ -15,9 +15,10 @@ interface DeleteInterface
      *
      * @param \Cake\Controller\Controller $controller the cakephp controller instance
      * @param mixed $id an optional identifier, if null the id parameter is used from the request
+     * @param \ArrayAccess|array $options The options for the delete.
      * @return $this
      */
-    public function delete(Controller $controller, mixed $id = null);
+    public function delete(Controller $controller, mixed $id, $options);
 
     /**
      * @param string $table the table

plugins/crud/src/Interfaces/ReadInterface.php

@@ -17,9 +17,10 @@ interface ReadInterface
      *
      * @param \Cake\Controller\Controller $controller the cakephp controller instance
      * @param mixed $id an optional identifier, if null the id parameter is used from the request
+     * @param array<string, mixed> $options options accepted by `Table::find()`
      * @return \Cake\Datasource\EntityInterface
      */
-    public function read(Controller $controller, mixed $id = null): EntityInterface;
+    public function read(Controller $controller, mixed $id = null, $options = []): EntityInterface;
 
     /**
      * @param string $table the table

plugins/crud/src/Interfaces/UpdateInterface.php

@@ -16,9 +16,10 @@ interface UpdateInterface
      *
      * @param \Cake\Controller\Controller $controller the cakephp controller instance
      * @param mixed $id an optional identifier, if null the id parameter is used from the request
+     * @param \Cake\ORM\SaveOptionsBuilder|\ArrayAccess|array $options The options to use when saving.
      * @return \Cake\Datasource\EntityInterface
      */
-    public function save(Controller $controller, mixed $id = null): EntityInterface;
+    public function save(Controller $controller, mixed $id = null, $options = []): EntityInterface;
 
     /**
      * @param string $table the table

plugins/crud/src/Services/Create.php

@@ -32,7 +32,7 @@ public function __construct(
     /**
      * @inheritDoc
      */
-    public function save(Controller $controller): EntityInterface
+    public function save(Controller $controller, $options = []): EntityInterface
     {
         $this->allowMethods($controller);
         $table = $controller->getTableLocator()->get($this->whichTable($controller));
@@ -42,7 +42,7 @@ public function save(Controller $controller): EntityInterface
             $this->deserializer->deserialize($controller->getRequest())
         );
 
-        $entity = $table->save($entity);
+        $entity = $table->save($entity, $options);
 
         if (!$entity) {
             throw new ResourceWriteException(null, "Unable to save $this->tableName resource.");

plugins/crud/src/Services/Delete.php

@@ -30,14 +30,14 @@ public function __construct(
     /**
      * @inheritDoc
      */
-    public function delete(Controller $controller, mixed $id = null)
+    public function delete(Controller $controller, mixed $id = null, $options = [])
     {
         $this->allowMethods($controller);
         $id = $this->whichId($controller, $id);
         $entity = $this->read->read($controller, $id);
 
         $table = $controller->getTableLocator()->get($this->whichTable($controller));
-        if (!$table->delete($entity)) {
+        if (!$table->delete($entity, $options)) {
             throw new ResourceWriteException($entity, "Unable to delete {$table->getAlias()} resource.");
         }
 

plugins/crud/src/Services/Read.php

@@ -20,15 +20,13 @@ class Read implements ReadInterface
     /**
      * @inheritDoc
      */
-    public function read(Controller $controller, mixed $id = null): EntityInterface
+    public function read(Controller $controller, mixed $id = null, $options = []): EntityInterface
     {
         $this->allowMethods($controller);
         $id = $this->whichId($controller, $id);
         $table = $controller->getTableLocator()->get($this->whichTable($controller));
 
-        return $table->get($id, [
-            'contain' => [],
-        ]);
+        return $table->get($id, $options);
     }
 
     /**

plugins/crud/src/Services/Update.php

@@ -35,7 +35,7 @@ public function __construct(
     /**
      * @inheritDoc
      */
-    public function save(Controller $controller, mixed $id = null): EntityInterface
+    public function save(Controller $controller, mixed $id = null, $options = []): EntityInterface
     {
         $this->allowMethods($controller);
 
@@ -48,7 +48,7 @@ public function save(Controller $controller, mixed $id = null): EntityInterface
             $this->deserializer->deserialize($controller->getRequest())
         );
 
-        $entity = $table->save($entity);
+        $entity = $table->save($entity, $options);
 
         if (!$entity) {
             throw new ResourceWriteException(null, "Unable to save $this->tableName resource.");