doc; composer.lock

.gitignore

@@ -1,4 +1,3 @@
 /.idea
 /vendor
-/composer.lock
 /.env

composer.json

@@ -17,10 +17,10 @@
     "require": {
       "laravel/lumen-framework": "5.1.x-dev",
       "firebase/php-jwt": "~2.0",
-      "luticate/utils": "*"
+      "luticate/utils": "dev-develop"
     },
     "require-dev": {
-      "luticate/generator": "*"
+      "luticate/generator": "dev-develop"
     },
     "autoload": {
       "psr-4": {

src/Auth/Business/LuticateGroupsBusiness.php

@@ -76,9 +76,4 @@ class LuticateGroupsBusiness extends LuBusiness {
         LuticateGroupsDataAccess::editById($group_id, $group);
         return true;
     }
-
-    public static function del($group_id)
-    {
-        return LuticateGroupsDataAccess::deleteById($group_id);
-    }
 }

src/Auth/Controller/LuticateGroupsController.php

@@ -12,31 +12,64 @@ class LuticateGroupsController extends LuController {
         return new LuticateGroupsBusiness();
     }
 
+    /**
+     * Get a group by its id
+     * @param $group_id int The group id
+     * @return \Luticate\Utils\LuDbo
+     */
     public function getById($group_id)
     {
         return LuticateGroupsBusiness::getById($group_id);
     }
 
+    /**
+     * Add a new group
+     * @param $group_name string The group name
+     * @return int
+     */
     public function add($group_name)
     {
         return LuticateGroupsBusiness::add($group_name);
     }
 
+    /**
+     * Delete a group by its id
+     * @param $group_id int The group id
+     * @return bool
+     */
     public function del($group_id)
     {
-        return LuticateGroupsBusiness::del($group_id);
+        return LuticateGroupsBusiness::deleteById($group_id);
     }
 
+    /**
+     * Edit a group name by its id
+     * @param $group_id int The group id
+     * @param $group_name string The new group name
+     * @return bool
+     */
     public function edit($group_id, $group_name)
     {
         return LuticateGroupsBusiness::edit($group_id, $group_name);
     }
 
+    /**
+     * Add a user to a group
+     * @param $user_id int The user id
+     * @param $group_id int The group id
+     * @return bool
+     */
     public function addUser($user_id, $group_id)
     {
         return LuticateGroupsBusiness::addUser($user_id, $group_id);
     }
 
+    /**
+     * Delete a user from a group
+     * @param $user_id int The user id
+     * @param $group_id int The group id
+     * @return bool
+     */
     public static function delUser($user_id, $group_id)
     {
         return LuticateGroupsBusiness::delUser($user_id, $group_id);

src/Auth/Controller/LuticatePermissionsController.php

@@ -2,6 +2,7 @@
 
 namespace Luticate\Auth\Controller;
 
+use Luticate\Auth\DBO\LuticateUsersDbo;
 use Luticate\Utils\LuController;
 use Luticate\Auth\Business\LuticatePermissionsBusiness;
 use Luticate\Auth\DBO\LuticatePermissionsDbo;
@@ -12,31 +13,65 @@ class LuticatePermissionsController extends LuController {
         return new LuticatePermissionsBusiness();
     }
 
+    /**
+     * Get the effective permission for a user
+     * @param $user_id int The user id
+     * @param $permission_name string The permission name
+     * @return LuticatePermissionsDbo
+     */
     public function getEffectivePermission($user_id, $permission_name)
     {
         return LuticatePermissionsBusiness::getEffectivePermission($user_id, $permission_name);
     }
 
+    /**
+     * Get the effective permission for the logged user
+     * @param $_user LuticateUsersDbo Logged user
+     * @param $permission_name string The permission name
+     * @return LuticatePermissionsDbo
+     */
     public function getEffectivePermissionMe($_user, $permission_name)
     {
         return LuticatePermissionsBusiness::getEffectivePermissionMe($_user, $permission_name);
     }
 
+    /**
+     * Get a permission
+     * @param $permission_name string The permission name
+     * @return \Luticate\Utils\LuDbo
+     */
     public function get($permission_name)
     {
         return LuticatePermissionsBusiness::get($permission_name);
     }
 
+    /**
+     * Add a permission
+     * @param $permission_name string The permission name
+     * @param $permission_value bool The default permission value
+     * @return bool
+     */
     public function add($permission_name, $permission_value)
     {
         return LuticatePermissionsBusiness::add($permission_name, $permission_value);
     }
 
+    /**
+     * Remove a permission
+     * @param $permission_name string The permission name
+     * @return bool
+     */
     public function del($permission_name)
     {
         return LuticatePermissionsBusiness::del($permission_name);
     }
 
+    /**
+     * Edit the default permission value
+     * @param $permission_name string The permission name
+     * @param $permission_value bool The default permission value
+     * @return bool
+     */
     public function edit($permission_name, $permission_value)
     {
         return LuticatePermissionsBusiness::edit($permission_name, $permission_value);

src/Auth/Controller/LuticatePermissionsGroupsController.php

@@ -12,21 +12,47 @@ class LuticatePermissionsGroupsController extends LuController {
         return new LuticatePermissionsGroupsBusiness();
     }
 
+    /**
+     * Get a permission group
+     * @param $group_id int The group id
+     * @param $permission_name string The permission name
+     * @return LuticatePermissionsGroupsDbo
+     */
     public function get($group_id, $permission_name)
     {
         return LuticatePermissionsGroupsBusiness::get($group_id, $permission_name);
     }
 
+    /**
+     * Add a permission for a group
+     * @param $group_id int The group id
+     * @param $permission_name string The permission name
+     * @param $permission_value bool The permission value
+     * @return bool
+     */
     public function add($group_id, $permission_name, $permission_value)
     {
         return LuticatePermissionsGroupsBusiness::add($group_id, $permission_name, $permission_value);
     }
 
+    /**
+     * Delete a permission for a group
+     * @param $group_id int The group id
+     * @param $permission_name string The permission name
+     * @return bool
+     */
     public function del($group_id, $permission_name)
     {
         return LuticatePermissionsGroupsBusiness::del($group_id, $permission_name);
     }
 
+    /**
+     * Edit the permission value for a group
+     * @param $group_id int The group id
+     * @param $permission_name string The permission name
+     * @param $permission_value bool The permission value
+     * @return bool
+     */
     public function edit($group_id, $permission_name, $permission_value)
     {
         return LuticatePermissionsGroupsBusiness::edit($group_id, $permission_name, $permission_value);

src/Auth/Controller/LuticatePermissionsUsersController.php

@@ -12,21 +12,47 @@ class LuticatePermissionsUsersController extends LuController {
         return new LuticatePermissionsUsersBusiness();
     }
 
+    /**
+     * Get a permission for a user
+     * @param $user_id int The user id
+     * @param $permission_name string The permission name
+     * @return \Luticate\Utils\LuDbo
+     */
     public function get($user_id, $permission_name)
     {
         return LuticatePermissionsUsersBusiness::get($user_id, $permission_name);
     }
 
+    /**
+     * Add a permission for a user
+     * @param $user_id int The user id
+     * @param $permission_name string The permission name
+     * @param $permission_value bool The permission value
+     * @return bool
+     */
     public function add($user_id, $permission_name, $permission_value)
     {
         return LuticatePermissionsUsersBusiness::add($user_id, $permission_name, $permission_value);
     }
 
+    /**
+     * Delete a permission for a user
+     * @param $user_id int The user id
+     * @param $permission_name string The permission name
+     * @return bool
+     */
     public function del($user_id, $permission_name)
     {
         return LuticatePermissionsUsersBusiness::del($user_id, $permission_name);
     }
 
+    /**
+     * Edit the permission value for a user
+     * @param $user_id int The user id
+     * @param $permission_name string The permission name
+     * @param $permission_value bool The permission value
+     * @return bool
+     */
     public function edit($user_id, $permission_name, $permission_value)
     {
         return LuticatePermissionsUsersBusiness::edit($user_id, $permission_name, $permission_value);

src/Auth/Controller/LuticateUsersController.php

@@ -12,46 +12,99 @@ class LuticateUsersController extends LuController {
         return new LuticateUsersBusiness();
     }
 
+    /**
+     * Login the user
+     * @param $username string The user username
+     * @param $password string The user password
+     * @return LuticateUsersDbo
+     */
     public function login($username, $password)
     {
         return LuticateUsersBusiness::login($username, $password);
     }
 
+    /**
+     * Logout the logged user
+     * @param $_user LuticateUsersDbo The logged user
+     * @return bool
+     */
     public function logout($_user)
     {
         return LuticateUsersBusiness::logout($_user);
     }
 
+    /**
+     * Get a user by its id
+     * @param $user_id int The user id
+     * @return \Luticate\Utils\LuDbo
+     */
     public function getById($user_id)
     {
         return LuticateUsersBusiness::getById($user_id);
     }
 
+    /**
+     * Add a user
+     * @param $username string The new user username
+     * @param $email string The new user email
+     * @param $password string The new user plain text password
+     * @return int
+     */
     public function add($username, $email, $password)
     {
         return LuticateUsersBusiness::add($username, $email, $password);
     }
 
+    /**
+     * Delete a user by its id
+     * @param $user_id int The user id
+     * @return bool
+     */
     public function del($user_id)
     {
         return LuticateUsersBusiness::deleteById($user_id);
     }
 
+    /**
+     * Edit the user email for a user
+     * @param $email string The new user amil
+     * @param $user_id int The user id
+     * @return bool
+     */
     public function edit($email, $user_id)
     {
         return LuticateUsersBusiness::edit($user_id, $email);
     }
 
+    /**
+     * Edit the logged user email
+     * @param $email string The new user email
+     * @param $_user LuticateUsersDbo The logged user
+     * @return bool
+     */
     public function editMe($email, $_user)
     {
         return LuticateUsersBusiness::edit($_user->getId(), $email);
     }
 
+    /**
+     * Edit the password for a user
+     * @param $password string The new plain text password
+     * @param $user_id int The user id
+     * @return bool
+     */
     public function setPassword($password, $user_id)
     {
         return LuticateUsersBusiness::setPassword($user_id, $password);
     }
 
+    /**
+     * Edit the password for the logged user
+     * @param $password string The new plain text password
+     * @param $oldPassword string The old plain text password
+     * @param $_user LuticateUsersDbo The logged user
+     * @return bool
+     */
     public function setPasswordMe($password, $oldPassword, $_user)
     {
         return LuticateUsersBusiness::setPasswordMe($password, $oldPassword, $_user);