Create api/options endpoint

Added `userId` to table
bluzphp · Sep 26, 2017 · da1c278 · da1c278
1 parent 27226dc
commit da1c278
Show file tree

Hide file tree

Showing 8 changed files with 130 additions and 12 deletions.
diff --git a/application/models/Options/Row.php b/application/models/Options/Row.php
@@ -8,20 +8,34 @@
 
 namespace Application\Options;
 
+use Bluz\Proxy\Auth;
 use Bluz\Validator\Traits\Validator;
+use Application\Users;
 
 /**
  * Options Row
  *
+ * @package  Application\Options
+ *
  * @property string $namespace
  * @property string $key
+ * @property integer $userId
  * @property string $value
  * @property string $description
  * @property string $created
  * @property string $updated
  *
- * @category Application
- * @package  Options
+ * @SWG\Definition(definition="options", title="option", required={"namespace", "key"})
+ * @SWG\Property(property="namespace", type="string", description="Options namespace", example="default")
+ * @SWG\Property(property="key", type="string", description="Key", example="Some key")
+ * @SWG\Property(property="userId", type="integer", description="Author ID", example=2)
+ * @SWG\Property(property="value", type="string", description="Value", example="Some Value")
+ * @SWG\Property(property="description", type="string", description="Description", example="Some description for key")
+ * @SWG\Property(property="created", type="string", format="date-time", description="Created date",
+ *     example="2017-03-17 19:06:28")
+ * @SWG\Property(property="updated", type="string", format="date-time", description="Last updated date",
+ *     example="2017-03-17 19:06:28")
+
  */
 class Row extends \Bluz\Db\Row
 {
@@ -33,7 +47,7 @@ class Row extends \Bluz\Db\Row
     protected function afterRead()
     {
         if ($this->value) {
-            $this->value = unserialize($this->value);
+            $this->value = unserialize($this->value, ['allowed_classes' => false]);
         }
     }
 
@@ -65,6 +79,13 @@ function () {
                 },
                 'Key name is already exists'
             );
+
+        /* @var \Application\Users\Row $user */
+        if ($user = Auth::getIdentity()) {
+            $this->userId = $user->id;
+        } else {
+            $this->userId = Users\Table::SYSTEM_USER;
+        }
     }
 
     /**

diff --git a/application/modules/api/controllers/options.php b/application/modules/api/controllers/options.php
@@ -0,0 +1,83 @@
+<?php
+/**
+ * REST controller for Options model
+ *
+ * @author   dev
+ * @created  2017-09-25 12:24:17
+ */
+
+/**
+ * @namespace
+ */
+namespace Application;
+
+use Application\Options;
+use Bluz\Controller\Controller;
+use Bluz\Controller\Mapper\Rest;
+
+/**
+ * Manipulate with options
+ *
+ * @SWG\Get(
+ *   path="/api/options/{optionNamespace}-{optionKey}",
+ *   tags={"options"},
+ *   operationId="getOptionByKey",
+ *   summary="Find option by namespace and key",
+ *   @SWG\Parameter(ref="#/parameters/Auth-Token"),
+ *   @SWG\Parameter(
+ *     name="optionNamespace",
+ *     in="path",
+ *     type="string",
+ *     required=true,
+ *     description="Namespace of option"
+ *   ),
+ *   @SWG\Parameter(
+ *     name="optionKey",
+ *     in="path",
+ *     type="string",
+ *     required=true,
+ *     description="Key of option"
+ *   ),
+ *   @SWG\Response(@SWG\Schema(ref="#/definitions/options"), response=200, description="Given option found"),
+ *   @SWG\Response(@SWG\Schema(ref="#/definitions/error"), response=404, description="Page not found")
+ * )
+ *
+ * @SWG\Get(
+ *   path="/api/options/",
+ *   tags={"options"},
+ *   method="GET",
+ *   operationId="getOptionsCollection",
+ *   summary="Collection of items",
+ *   @SWG\Parameter(ref="#/parameters/Auth-Token"),
+ *   @SWG\Parameter(ref="#/parameters/offset"),
+ *   @SWG\Parameter(ref="#/parameters/limit"),
+ *   @SWG\Response(response=200, description="Collection present"),
+ *   @SWG\Response(response=206, description="Collection present")
+ * )
+ *
+ * @accept JSON
+ *
+ * @acl Options/Read
+ * @acl Options/Edit
+ *
+ * @return mixed
+ */
+return function () {
+    /**
+     * @var Controller $this
+     */
+    $rest = new Rest(Options\Crud::getInstance());
+
+    $rest->get('system', 'rest/get')
+        ->acl('Options/Read');
+    $rest->post('system', 'rest/post')
+        ->acl('Options/Edit');
+    $rest->put('system', 'rest/put')
+        ->acl('Options/Edit');
+    $rest->patch('system', 'rest/put')
+        ->acl('Options/Edit');
+    $rest->delete('system', 'rest/delete')
+        ->acl('Options/Edit');
+
+    return $rest->run();
+};
diff --git a/application/modules/options/controllers/crud.php b/application/modules/options/controllers/crud.php
@@ -25,8 +25,8 @@
     $crud = new Crud(Options\Crud::getInstance());
 
     $crud->get('system', 'crud/get');
-    $crud->post('options', 'crud/post');
-    $crud->put('system', 'crud/put');
+    $crud->post('options', 'crud/post')->fields(['namespace', 'key', 'value', 'description']);
+    $crud->put('system', 'crud/put')->fields(['value', 'description']);
     $crud->delete('system', 'crud/delete');
 
     return $crud->run();

diff --git a/application/modules/options/controllers/crud/post.php b/application/modules/options/controllers/crud/post.php
@@ -28,7 +28,7 @@
     try {
         $crud->createOne($data);
 
-        Messages::addSuccess('Record was created');
+        Messages::addSuccess('The record was successfully created');
 
         return [
             'row'    => $data,

diff --git a/application/modules/options/controllers/grid.php b/application/modules/options/controllers/grid.php
@@ -27,6 +27,7 @@
         ]
     );
     $grid = new Options\Grid();
+    $grid->processSource();
 
     $this->assign('grid', $grid);
 };
diff --git a/application/modules/options/views/crud.phtml b/application/modules/options/views/crud.phtml
@@ -11,24 +11,32 @@
         <h4 class="modal-title"><?=__('Options')?></h4>
     </div>
     <div class="modal-body">
+        <?php if ($method === 'PUT') :?>
+        <div class="form-group">
+            <label class="control-label col-lg-2" for="author"><?=__('Author')?></label>
+            <div class="col-lg-10">
+                <input type="text" class="form-control" id="author" name="author" value="<?=\Application\Users\Table::findRow($row->userId)->login;?>" disabled />
+            </div>
+        </div>
+        <?php endif; ?>
         <div class="form-group">
             <label class="control-label col-lg-2" for="namespace"><?=__('Namespace')?></label>
             <div class="col-lg-10">
-                <input type="text" class="form-control" id="namespace" name="namespace" value="<?=esc($row->namespace)?:'default'?>" <?=($method != 'POST')?'disabled':''?> required />
+                <input type="text" class="form-control" id="namespace" name="namespace" value="<?=esc($row->namespace)?:'default'?>" <?=($method !== 'POST')?'disabled':''?> required />
             </div>
         </div>
         <div class="form-group">
             <label class="control-label col-lg-2" for="key"><?=__('Key name')?></label>
             <div class="col-lg-10">
-                <input type="text" class="form-control" id="key" name="key" value="<?=esc($row->key)?>" <?=($method!='POST')?'disabled':''?> />
+                <input type="text" class="form-control" id="key" name="key" value="<?=esc($row->key)?>" <?=($method !== 'POST')?'disabled':''?> />
             </div>
         </div>
         <div class="form-group">
             <label class="control-label col-lg-2" for="value"><?=__('Key value')?></label>
             <div class="col-lg-10">
                 <?php $value = $row->value; ?>
                 <?php if (is_array($value)) : ?>
-                <input type="text" class="form-control" id="value" name="value" disabled value="<?=__('Array (length=%d)', sizeof($value));?>"/>
+                <input type="text" class="form-control" id="value" name="value" disabled value="<?=__('Array (length=%d)', count($value));?>"/>
                 <?php elseif (is_object($value)): ?>
                 <input type="text" class="form-control" id="value" name="value" disabled value="<?=__('Object of `%s` class', get_class($value));?>"/>
                 <?php else: ?>

diff --git a/application/modules/options/views/grid.phtml b/application/modules/options/views/grid.phtml
@@ -37,12 +37,12 @@ if (!$grid) return;
             <?php foreach($grid->getData() as $row) : ?>
             <tr>
                 <td><span class="label label-info"><?=$row['namespace']?></span></td>
-                <td><a href="#" class="bluz-tooltip" data-toggle="tooltip" title="<?=esc($row['description'])?>"><?=esc($row['key'])?></a></td>
+                <td><span class="bluz-tooltip" data-toggle="tooltip" title="<?=esc($row['description'])?>"><?=esc($row['key'])?></span></td>
                 <td>
                     <?php
-                    $value = unserialize($row['value']);
+                    $value = unserialize($row['value'], ['allow_classes' => false]);
                     if (is_array($value)) {
-                        echo __('Array (length=%d)', sizeof($value));
+                        echo __('Array (length=%d)', count($value));
                     } elseif (is_object($value)) {
                         echo __('Object of `%s` class', get_class($value));
                     } else {

diff --git a/data/migrations/20170317111112_module_options.php b/data/migrations/20170317111112_module_options.php
@@ -29,11 +29,16 @@ public function change()
     {
         $table = $this->table('options', ['id' => false, 'primary_key' => ['namespace', 'key']]);
         $table
+            ->addColumn('userId', 'integer')
             ->addColumn('namespace', 'string', ['length' => 255, 'default' => 'default'])
             ->addColumn('key', 'string', ['length' => 255])
             ->addColumn('value', 'text')
             ->addColumn('description', 'text', ['null' => true])
             ->addTimestamps('created', 'updated')
+            ->addForeignKey('userId', 'users', 'id', [
+                'delete' => 'CASCADE',
+                'update' => 'CASCADE'
+            ])
             ->create();
 
         $data = [