GSoC2018 report generator

Modules/ReportGenerator/Database/Migrations/2018_05_22_153827_create_draggable_components_table.php

@@ -0,0 +1,49 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateDraggableComponentsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     * This file creates draggable_components for the report-generator.
+     * This is close to the list_options table, but this one if for the report generator module.
+     *
+     * TODO Link this table to users table in order to keep track of user adding or editing a component.
+     *
+     * @author Tigpezeghe Rodrige K. <[email protected]> (2018)
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('draggable_components', function (Blueprint $table) {
+            $table->increments('id')->comment = "This will identify each component with a unique integer.";
+            $table->string('option_id', 255)->comment = "All draggable components have an ID.";
+            $table->boolean('is_default')->default(1)->comment = "0 -> False, 1 -> True.";
+            $table->string('user', 255)->default('default')->comment = "The user who created the component. This will be 'default' for components that come with the module.";
+            $table->string('title', 255)->comment = "This is the text on the component that end users see.";
+            $table->integer('order', 0)->comment = "The order in which components appear in the list.";
+            $table->boolean('active')->default(1)->comment = "0 -> False, 1 -> True whether the component should be active or not.";
+            $table->json('notes', 255)->comment = "This stores the fields that the component relates to in the database.";
+            $table->boolean('toggle_sort')->default(0)->comment = "0 -> False (Descending), 1 -> True (Ascending).";
+            $table->boolean('toggle_display')->default(0)->comment = "0 -> False, 1 -> True. Display field if checked (1), and no if unchecked (0).";
+
+            $table->timestamps();
+
+            // $table->foreign('userID')->references('id')->on('users')->onDelete('cascade');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('draggable_components');
+    }
+}

Modules/ReportGenerator/Database/Migrations/2018_05_25_203256_create_report_formats_table.php

@@ -0,0 +1,43 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateReportFormatsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     * This file creates draggable_components for the report-generator.
+     * This is close to the list_options table, but this one if for the report generator module.
+     *
+     * TODO Link this table to users table in order to keep track of user adding or editing a component.
+     *
+     * @author Tigpezeghe Rodrige K. <[email protected]> (2018)
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('report_formats', function (Blueprint $table) {
+            $table->increments('id')->comment = "This will identify each component with a unique integer.";
+            $table->string('user', 255)->default('default')->comment = "The user who created the report format. This will be 'default' for components that come with the module.";
+            $table->string('title', 255)->comment = "This is the report name e.g Patient List.";
+            $table->string('system_feature', 255)->comment = "The system feature under which the report belongs.";
+            $table->text('description')->comment = "This describes the report format briefly.";
+            $table->json('draggable_components_id')->comment = "This stores the id of all the components that belong to this report format";
+
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('report_formats');
+    }
+}

Modules/ReportGenerator/Entities/DraggableComponent.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Modules\ReportGenerator\Entities;
+
+use Illuminate\Database\Eloquent\Model;
+
+class DraggableComponent extends Model
+{
+    protected $fillable = ['is_default', 'user', 'title', 'order', 'active', 'notes', 'toggle_sort', 'toggle_display'];
+
+    /**
+     * Convert notes column from jsona(as specified in migration file) to array.
+     *
+     * @var string
+     */
+    protected $casts = [
+        'notes' => 'array'
+    ];
+
+    /**
+     * The connection name for the model.
+     * TODO
+     * @var string
+     */
+    //protected $connection = 'connection-name';
+}

Modules/ReportGenerator/Entities/ReportFormat.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Modules\ReportGenerator\Entities;
+
+use Illuminate\Database\Eloquent\Model;
+
+class ReportFormat extends Model
+{
+    protected $fillable = ['user', 'title', 'system_feature', 'description', 'draggable_components_id'];
+
+    /**
+     * Convert draggable_components_id column from jsona(as specified in migration file) to array.
+     *
+     * @var string
+     */
+    protected $casts = [
+        'draggable_components_id' => 'array'
+    ];
+
+    /**
+     * The connection name for the model.
+     * TODO
+     * @var string
+     */
+    //protected $connection = 'connection-name';
+}

database/migrations/2018_05_18_085927_create_list_options_table.php

@@ -0,0 +1,49 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateListOptionsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     * This will create list_options.
+     * TODO this migration file isn't complete. It lacks
+     * the necessary foreign keys.
+     *
+     * @author Tigpezeghe Rodrige K. <[email protected]> (2018)
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('list_options', function (Blueprint $table) {
+            $table->increments('id')->comment = "Primary Key. Autoincrement.";
+            $table->string('list_id', 31)->comment = "List Id.";
+            $table->string('option_id', 31)->comment = "Id for list item.";
+            $table->string('title', 255)->comment = "The title of the component.";
+            $table->integer('seq', 0)->comment = "The order in which the components appear in the list.";
+            $table->boolean('is_default')->default(0)->comment = "0 -> False, 1 -> True.";
+            $table->float('option_value', 8, 2)->default(0)->comment = "";
+            $table->string('mapping', 31)->comment = "";
+            $table->string('notes', 255)->comment = "This stores the meaning or usefulness of the component.";
+            $table->string('codes', 255)->comment = "";
+            $table->boolean('toggle_setting_1')->default(0)->comment = "0 -> False, 1 -> True.";
+            $table->boolean('toggle_setting_2')->default(0)->comment = "0 -> False, 1 -> True.";
+            $table->boolean('activity')->default(1)->comment = "0 -> False, 1 -> True whether the component should be active or not.";
+            $table->string('subtype', 31)->comment = "";
+
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('list_options');
+    }
+}