WIP: boilerplate

.gitignore

@@ -1,6 +1,127 @@
-vendor/
-build/
-phpunit*.xml
+#-------------------------
+# Operating Specific Junk Files
+#-------------------------
+
+# OS X
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# OS X Thumbnails
+._*
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# Linux
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+#-------------------------
+# Environment Files
+#-------------------------
+# These should never be under version control,
+# as it poses a security risk.
+.env
+.vagrant
+Vagrantfile
+
+#-------------------------
+# Temporary Files
+#-------------------------
+writable/cache/*
+!writable/cache/index.html
+
+writable/logs/*
+!writable/logs/index.html
+
+writable/session/*
+!writable/session/index.html
+
+writable/uploads/*
+!writable/uploads/index.html
+
+writable/debugbar/*
+
+php_errors.log
+
+#-------------------------
+# User Guide Temp Files
+#-------------------------
+user_guide_src/build/*
+user_guide_src/cilexer/build/*
+user_guide_src/cilexer/dist/*
+user_guide_src/cilexer/pycilexer.egg-info/*
+
+#-------------------------
+# Test Files
+#-------------------------
+tests/coverage*
+
+# Don't save phpunit under version control.
 phpunit
+
+#-------------------------
+# Composer
+#-------------------------
+vendor/
 composer.lock
-.DS_Store
+
+#-------------------------
+# IDE / Development Files
+#-------------------------
+
+# Modules Testing
+_modules/*
+
+# phpenv local config
+.php-version
+
+# Jetbrains editors (PHPStorm, etc)
+.idea/
+*.iml
+
+# Netbeans
+nbproject/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+nb-configuration.xml
+.nb-gradle/
+
+# Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+*.sublime-workspace
+*.sublime-project
+.phpintel
+/api/
+
+# Visual Studio Code
+.vscode/
+
+/results/
+/phpunit*.xml
+/.phpunit.*.cache

src/Commands/InstallCommand.php

@@ -4,9 +4,12 @@
 
 use CodeIgniter\CLI\BaseCommand;
 
+/**
+ * Class InstallCommand
+ * @package agungsugiarto\boilerplate\Commands
+ */
 class InstallCommand extends BaseCommand
 {
-    // helper('filesystem');
     /**
      * The group the command is lumped under
      * when listing commands.

src/Commands/PublishCommand.php

@@ -6,9 +6,12 @@
 use CodeIgniter\CLI\CLI;
 use Config\Autoload;
 
+/**
+ * Class PublishCommand
+ * @package agungsugiarto\boilerplate\Commands
+ */
 class PublishCommand extends BaseCommand
 {
-    // helper('filesystem');
     /**
      * The group the command is lumped under
      * when listing commands.

src/Config/Boilerplate.php

@@ -4,6 +4,10 @@
 
 use CodeIgniter\Config\BaseConfig;
 
+/**
+ * Class Boilerplate
+ * @package agungsugiarto\boilerplate\Config
+ */
 class Boilerplate extends BaseConfig
 {
     //--------------------------------------------------------------------------

src/Controllers/BaseController.php

@@ -9,6 +9,10 @@
 use Config\Database;
 use Psr\Log\LoggerInterface;
 
+/**
+ * Class BaseController
+ * @package agungsugiarto\boilerplate\Controllers
+ */
 class BaseController extends Controller
 {
     /**

src/Controllers/DashboardController.php

@@ -2,6 +2,10 @@
 
 namespace agungsugiarto\boilerplate\Controllers;
 
+/**
+ * Class DashboardController
+ * @package agungsugiarto\boilerplate\Controllers
+ */
 class DashboardController extends BaseController
 {
     public function index()

src/Controllers/Users/MenuController.php

@@ -8,6 +8,10 @@
 use agungsugiarto\boilerplate\Models\MenuModel;
 use CodeIgniter\API\ResponseTrait;
 
+/**
+ * Class MenuController
+ * @package agungsugiarto\boilerplate\Controllers\Users
+ */
 class MenuController extends BaseController
 {
     use ResponseTrait;
@@ -28,7 +32,6 @@ public function __construct()
      */
     public function index()
     {
-        // return $this->response->setJSON($this->menu->selectMax('sequence')->get()->getRow()->sequence);
         $data = [
             'title' => 'Menu',
             'roles' => $this->authorize->groups(),

src/Controllers/Users/PermissionController.php

@@ -4,15 +4,20 @@
 
 use agungsugiarto\boilerplate\Controllers\BaseController;
 use CodeIgniter\API\ResponseTrait;
+use CodeIgniter\View\View;
 
+/**
+ * Class PermissionController
+ * @package agungsugiarto\boilerplate\Controllers\Users
+ */
 class PermissionController extends BaseController
 {
     use ResponseTrait;
 
     /**
      * Return an array of resource objects, themselves in array format.
      *
-     * @return \CodeIgniter\View\View | \CodeIgniter\API\ResponseTrait
+     * @return View | \CodeIgniter\API\ResponseTrait
      */
     public function index()
     {

src/Controllers/Users/RoleController.php

@@ -6,6 +6,10 @@
 use agungsugiarto\boilerplate\Models\Group;
 use CodeIgniter\API\ResponseTrait;
 
+/**
+ * Class RoleController
+ * @package agungsugiarto\boilerplate\Controllers\Users
+ */
 class RoleController extends BaseController
 {
     use ResponseTrait;

src/Controllers/Users/UserController.php

@@ -8,6 +8,10 @@
 use Myth\Auth\Entities\User;
 use Myth\Auth\Models\UserModel;
 
+/**
+ * Class UserController
+ * @package agungsugiarto\boilerplate\Controllers\Users
+ */
 class UserController extends BaseController
 {
     use ResponseTrait;

src/Database/Migrations/2020-02-03-081118_create_menu_table.php

@@ -4,6 +4,10 @@
 
 use CodeIgniter\Database\Migration;
 
+/**
+ * Class CreateMenuTable
+ * @package agungsugiarto\boilerplate\Database\Migrations
+ */
 class CreateMenuTable extends Migration
 {
     public function up()

src/Database/Seeds/BoilerplateSeeder.php

@@ -7,6 +7,10 @@
 use Myth\Auth\Entities\User;
 use Myth\Auth\Models\UserModel;
 
+/**
+ * Class BoilerplateSeeder
+ * @package agungsugiarto\boilerplate\Database\Seeds
+ */
 class BoilerplateSeeder extends Seeder
 {
     /**

src/Entities/MenuEntity.php

@@ -5,6 +5,10 @@
 use agungsugiarto\boilerplate\Models\MenuModel;
 use CodeIgniter\Entity;
 
+/**
+ * Class MenuEntity
+ * @package agungsugiarto\boilerplate\Entities
+ */
 class MenuEntity extends Entity
 {
     /**

src/Filters/PermissionFilter.php

@@ -8,6 +8,10 @@
 use CodeIgniter\HTTP\ResponseInterface;
 use Config\Services;
 
+/**
+ * Class PermissionFilter
+ * @package agungsugiarto\boilerplate\Filters
+ */
 class PermissionFilter implements FilterInterface
 {
     /**

src/Filters/RoleFilter.php

@@ -8,6 +8,10 @@
 use CodeIgniter\HTTP\ResponseInterface;
 use Config\Services;
 
+/**
+ * Class RoleFilter
+ * @package agungsugiarto\boilerplate\Filters
+ */
 class RoleFilter implements FilterInterface
 {
     /**

src/Models/Group.php

@@ -4,6 +4,10 @@
 
 use Myth\Auth\Authorization\GroupModel;
 
+/**
+ * Class Group
+ * @package agungsugiarto\boilerplate\Models
+ */
 class Group extends GroupModel
 {
     /**

src/Models/GroupMenuModel.php

@@ -4,6 +4,10 @@
 
 use CodeIgniter\Model;
 
+/**
+ * Class GroupMenuModel
+ * @package agungsugiarto\boilerplate\Models
+ */
 class GroupMenuModel extends Model
 {
     protected $table = 'groups_menu';

src/Models/MenuModel.php

@@ -5,6 +5,10 @@
 use agungsugiarto\boilerplate\Entities\MenuEntity;
 use CodeIgniter\Model;
 
+/**
+ * Class MenuModel
+ * @package agungsugiarto\boilerplate\Models
+ */
 class MenuModel extends Model
 {
     protected $table = 'menu';
@@ -33,7 +37,7 @@ class MenuModel extends Model
     /**
      * Find menu. By default we need to detect driver,
      * because different function group_concat
-     * between MySQLi and Postgre.
+     * between MySQLi and Postgres.
      *
      * @param int id
      *
@@ -47,7 +51,7 @@ public function getMenuById($id)
                 return $this->getMenuDriverMySQLi($id);
                 break;
             case 'Postgre':
-                // do postgre
+                // do postgres
                 return $this->getMenuDRiverPostgre($id);
                 break;
         }

src/Views/Authentication/register.php

@@ -35,7 +35,7 @@ class="form-control <?php if (session('errors.email')) { ?>is-invalid<?php } ?>"
       <div class="input-group mb-3">
         <input type="password" name="password"
           class="form-control <?php if (session('errors.password')) { ?>is-invalid<?php } ?>"
-          placeholder="<?=lang('Auth.password')?>" value="<?= old('password') ?> autocomplete="off">
+          placeholder="<?=lang('Auth.password')?>" autocomplete="off">
         <div class="input-group-append">
           <div class="input-group-text">
             <span class="fas fa-lock"></span>