SherifElfadaly / Laravel-Api-Skeleton

src/Modules/V1/Core/Interfaces/RepositoryContainerInterface.php

Indentation +8 added lines, -8 removed lines

@@ -4,13 +4,13 @@
 {
 	/**
 	 * Construct the repository class name based on
-     * the method name called, search in the 
-     * given namespaces for the class and 
-     * return an instance.
-     * 
-     * @param  string $name the called method name
-     * @param  array  $arguments the method arguments
-     * @return object
-     */
+	 * the method name called, search in the 
+	 * given namespaces for the class and 
+	 * return an instance.
+	 * 
+	 * @param  string $name the called method name
+	 * @param  array  $arguments the method arguments
+	 * @return object
+	 */
 	public function __call($name, $arguments);
 }
\ No newline at end of file

src/Modules/V1/Core/Http/Controllers/LogsController.php

Indentation +5 added lines, -5 removed lines

@@ -8,9 +8,9 @@
 class LogsController extends BaseApiController
 {
 	/**
-     * The name of the model that is used by the base api controller 
-     * to preform actions like (add, edit ... etc).
-     * @var string
-     */
-    protected $model            = 'logs';
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model            = 'logs';
 }

src/Modules/V1/Reporting/Database/Migrations/2016_01_19_112603_sampel_report.php

Indentation +5 added lines, -5 removed lines

@@ -22,15 +22,15 @@
 			");
 		
 		DB::table('reports')->insert(
-        	[
-	        	[
+			[
+				[
 				'report_name' => 'admin_count',
 				'view_name'   => 'admin_count',
 				'created_at'  => \DB::raw('NOW()'),
 				'updated_at'  => \DB::raw('NOW()')
-	        	]
-        	]
-        );
+				]
+			]
+		);
 	}
 
 	/**

src/Modules/V1/Reporting/Database/Migrations/2016_01_19_112350_reports.php

Indentation +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
 			$table->string('view_name',100);
 			$table->softDeletes();
 			$table->timestamps();
-        });
+		});
 	}
 
 	/**

src/Modules/V1/Acl/Database/Migrations/2015_12_22_145819_groups.php

Indentation +12 added lines, -12 removed lines

@@ -13,19 +13,19 @@
 	public function up()
 	{
 		Schema::create('groups', function (Blueprint $table) {
-            $table->increments('id');
-            $table->string('name',100)->unique();
-            $table->softDeletes();
-            $table->timestamps();
-        });
+			$table->increments('id');
+			$table->string('name',100)->unique();
+			$table->softDeletes();
+			$table->timestamps();
+		});
         
-        Schema::create('users_groups', function (Blueprint $table) {
-            $table->increments('id');
-            $table->integer('user_id');
-            $table->integer('group_id');
-            $table->softDeletes();
-            $table->timestamps();
-        });
+		Schema::create('users_groups', function (Blueprint $table) {
+			$table->increments('id');
+			$table->integer('user_id');
+			$table->integer('group_id');
+			$table->softDeletes();
+			$table->timestamps();
+		});
 	}
 
 	/**

src/Modules/V1/Acl/Database/Migrations/2016_01_05_130506_permissions.php

Indentation +15 added lines, -15 removed lines

@@ -12,21 +12,21 @@
 	 */
 	public function up()
 	{
-        Schema::create('permissions', function (Blueprint $table) {
-            $table->increments('id');
-            $table->string('name',100);
-            $table->string('model',100);
-            $table->softDeletes();
-            $table->timestamps();
-            $table->unique(array('name', 'model'));
-        });
-        Schema::create('groups_permissions', function (Blueprint $table) {
-            $table->increments('id');
-            $table->integer('group_id');
-            $table->integer('permission_id');
-            $table->softDeletes();
-            $table->timestamps();
-        });
+		Schema::create('permissions', function (Blueprint $table) {
+			$table->increments('id');
+			$table->string('name',100);
+			$table->string('model',100);
+			$table->softDeletes();
+			$table->timestamps();
+			$table->unique(array('name', 'model'));
+		});
+		Schema::create('groups_permissions', function (Blueprint $table) {
+			$table->increments('id');
+			$table->integer('group_id');
+			$table->integer('permission_id');
+			$table->softDeletes();
+			$table->timestamps();
+		});
 	}
 
 	/**

src/Modules/V1/Acl/Http/Controllers/PermissionsController.php

Indentation +6 added lines, -6 removed lines

@@ -7,10 +7,10 @@
 
 class PermissionsController extends BaseApiController
 {
-    /**
-     * The name of the model that is used by the base api controller 
-     * to preform actions like (add, edit ... etc).
-     * @var string
-     */
-    protected $model = 'permissions';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model = 'permissions';
 }

src/Modules/V1/Core/Utl/Logging.php

Indentation +13 added lines, -13 removed lines

@@ -2,17 +2,17 @@
 
 class Logging
 {
-    public function saveLog($action, $item_name, $item_type, $item_id)
-    {
-    	if (\Core::logs() && $item_name !== 'Log')
-    	{
-    		\Core::logs()->save([
-	    		'action'      => $action,
-	    		'item_name'   => $item_name,
-	    		'item_type'   => $item_type,
-	    		'item_id'     => $item_id,
-	    		'user_id'     => \JWTAuth::parseToken()->authenticate()->id,
-	    		], false, false);
-    	}
-    }
+	public function saveLog($action, $item_name, $item_type, $item_id)
+	{
+		if (\Core::logs() && $item_name !== 'Log')
+		{
+			\Core::logs()->save([
+				'action'      => $action,
+				'item_name'   => $item_name,
+				'item_type'   => $item_type,
+				'item_id'     => $item_id,
+				'user_id'     => \JWTAuth::parseToken()->authenticate()->id,
+				], false, false);
+		}
+	}
 }
\ No newline at end of file

src/Modules/V1/Core/Http/Controllers/BaseApiController.php

Braces +1 added lines, -2 removed lines

@@ -170,8 +170,7 @@
             if ($request->has('id')) 
             {
                 $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
+            } else
             {
                 $rule = str_replace(',{id}', '', $rule);
             }

Indentation +268 added lines, -268 removed lines

@@ -6,298 +6,298 @@
 
 class BaseApiController extends Controller
 {
-    /**
-     * The config implementation.
-     * 
-     * @var array
-     */
-    protected $config;
+	/**
+	 * The config implementation.
+	 * 
+	 * @var array
+	 */
+	protected $config;
 
-    /**
-     * The relations implementation.
-     * 
-     * @var array
-     */
-    protected $relations;
+	/**
+	 * The relations implementation.
+	 * 
+	 * @var array
+	 */
+	protected $relations;
 
-    /**
-     * The repo implementation.
-     * 
-     * @var array
-     */
-    protected $repo;
+	/**
+	 * The repo implementation.
+	 * 
+	 * @var array
+	 */
+	protected $repo;
 
-    public function __construct()
-    {        
-        $this->config              = \CoreConfig::getConfig();
-        $this->model               = property_exists($this, 'model') ? $this->model : false;
-        $this->validationRules     = property_exists($this, 'validationRules') ? $this->validationRules : false;
-        $this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : [];
-        $this->skipLoginCheck      = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : [];
-        $this->repo                = call_user_func_array("\Core::{$this->model}", []);
-        $route                     = explode('@',\Route::currentRouteAction())[1];
+	public function __construct()
+	{        
+		$this->config              = \CoreConfig::getConfig();
+		$this->model               = property_exists($this, 'model') ? $this->model : false;
+		$this->validationRules     = property_exists($this, 'validationRules') ? $this->validationRules : false;
+		$this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : [];
+		$this->skipLoginCheck      = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : [];
+		$this->repo                = call_user_func_array("\Core::{$this->model}", []);
+		$route                     = explode('@',\Route::currentRouteAction())[1];
 
-        $this->checkPermission($route);
-        $this->setRelations($route);
-        $this->setSessions();
-    }
+		$this->checkPermission($route);
+		$this->setRelations($route);
+		$this->setSessions();
+	}
 
-    /**
-     * Fetch all records with relations from storage.
-     * 
-     * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function index($sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->repo)
-        {
-            return \Response::json($this->repo->all($this->relations, $sortBy, $desc), 200);
-        }
-    }
+	/**
+	 * Fetch all records with relations from storage.
+	 * 
+	 * @param  string  $sortBy The name of the column to sort by.
+	 * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function index($sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->repo)
+		{
+			return \Response::json($this->repo->all($this->relations, $sortBy, $desc), 200);
+		}
+	}
 
-    /**
-     * Fetch the single object with relations from storage.
-     * 
-     * @param  integer $id Id of the requested model.
-     * @return \Illuminate\Http\Response
-     */
-    public function find($id) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->find($id, $this->relations), 200);
-        }
-    }
+	/**
+	 * Fetch the single object with relations from storage.
+	 * 
+	 * @param  integer $id Id of the requested model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function find($id) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->find($id, $this->relations), 200);
+		}
+	}
 
-    /**
-     * Paginate all records with relations from storage
-     * that matche the given query.
-     * 
-     * @param  string  $query   The search text.
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->search($query, $perPage, $this->relations, $sortBy, $desc), 200);
-        }
-    }
+	/**
+	 * Paginate all records with relations from storage
+	 * that matche the given query.
+	 * 
+	 * @param  string  $query   The search text.
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->search($query, $perPage, $this->relations, $sortBy, $desc), 200);
+		}
+	}
 
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->findBy($request->all(), $this->relations, $sortBy, $desc), 200);
-        }
-    }
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string  $sortBy The name of the column to sort by.
+	 * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->findBy($request->all(), $this->relations, $sortBy, $desc), 200);
+		}
+	}
 
-    /**
-     * Fetch the first record from the storage based on the given
-     * condition.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function first(Request $request) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->first($request->all(), $this->relations), 200);
-        }
-    }
+	/**
+	 * Fetch the first record from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function first(Request $request) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->first($request->all(), $this->relations), 200);
+		}
+	}
 
-    /**
-     * Paginate all records with relations from storage.
-     * 
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->paginate($perPage, $this->relations, $sortBy, $desc), 200);
-        }
-    }
+	/**
+	 * Paginate all records with relations from storage.
+	 * 
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->paginate($perPage, $this->relations, $sortBy, $desc), 200);
+		}
+	}
 
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->paginateBy($request->all(), $perPage, $this->relations, $sortBy, $desc), 200);
-        }
-    }
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->paginateBy($request->all(), $perPage, $this->relations, $sortBy, $desc), 200);
+		}
+	}
 
-    /**
-     * Save the given model to storage.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function save(Request $request) 
-    {
-        foreach ($this->validationRules as &$rule) 
-        {
-            if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) 
-            {
-                $rule .= ',deleted_at,NULL';
-            }
+	/**
+	 * Save the given model to storage.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function save(Request $request) 
+	{
+		foreach ($this->validationRules as &$rule) 
+		{
+			if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) 
+			{
+				$rule .= ',deleted_at,NULL';
+			}
 
-            if ($request->has('id')) 
-            {
-                $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
-            {
-                $rule = str_replace(',{id}', '', $rule);
-            }
-        }
+			if ($request->has('id')) 
+			{
+				$rule = str_replace('{id}', $request->get('id'), $rule);
+			}
+			else
+			{
+				$rule = str_replace(',{id}', '', $rule);
+			}
+		}
         
-        $this->validate($request, $this->validationRules);
+		$this->validate($request, $this->validationRules);
 
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->save($request->all()), 200);
-        }
-    }
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->save($request->all()), 200);
+		}
+	}
 
-    /**
-     * Delete by the given id from storage.
-     * 
-     * @param  integer $id Id of the deleted model.
-     * @return \Illuminate\Http\Response
-     */
-    public function delete($id) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->delete($id), 200);
-        }
-    }
+	/**
+	 * Delete by the given id from storage.
+	 * 
+	 * @param  integer $id Id of the deleted model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function delete($id) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->delete($id), 200);
+		}
+	}
 
-    /**
-     * Return the deleted models in pages based on the given conditions.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->deleted($request->all(), $perPage, $sortBy, $desc), 200);
-    }
+	/**
+	 * Return the deleted models in pages based on the given conditions.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->deleted($request->all(), $perPage, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Restore the deleted model.
-     * 
-     * @param  integer $id Id of the restored model.
-     * @return \Illuminate\Http\Response
-     */
-    public function restore($id) 
-    {
-        if ($this->repo) 
-        {
-            return \Response::json($this->repo->restore($id), 200);
-        }
-    }
+	/**
+	 * Restore the deleted model.
+	 * 
+	 * @param  integer $id Id of the restored model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function restore($id) 
+	{
+		if ($this->repo) 
+		{
+			return \Response::json($this->repo->restore($id), 200);
+		}
+	}
 
-    /**
-     * Check if the logged in user can do the given permission.
-     * 
-     * @param  string $permission
-     * @return void
-     */
-    private function checkPermission($permission)
-    {
-        $permission = $permission !== 'index' ? $permission : 'list';
-        if ( ! in_array($permission, $this->skipLoginCheck)) 
-        {
-            $user = \JWTAuth::parseToken()->authenticate();
-            if ($user->blocked)
-            {
-                \ErrorHandler::userIsBlocked();
-            }
+	/**
+	 * Check if the logged in user can do the given permission.
+	 * 
+	 * @param  string $permission
+	 * @return void
+	 */
+	private function checkPermission($permission)
+	{
+		$permission = $permission !== 'index' ? $permission : 'list';
+		if ( ! in_array($permission, $this->skipLoginCheck)) 
+		{
+			$user = \JWTAuth::parseToken()->authenticate();
+			if ($user->blocked)
+			{
+				\ErrorHandler::userIsBlocked();
+			}
             
-            if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
-            {
-                \ErrorHandler::noPermissions();
-            }
-        }
-    }
+			if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
+			{
+				\ErrorHandler::noPermissions();
+			}
+		}
+	}
 
-    /**
-     * Set sessions based on the given headers in the request.
-     * 
-     * @return void
-     */
-    private function setSessions()
-    {
-        \Session::put('timeZoneDiff', \Request::header('time-zone-diff') ?: 0);
+	/**
+	 * Set sessions based on the given headers in the request.
+	 * 
+	 * @return void
+	 */
+	private function setSessions()
+	{
+		\Session::put('timeZoneDiff', \Request::header('time-zone-diff') ?: 0);
 
-        $locale = \Request::header('locale');
-        switch ($locale) 
-        {
-            case 'en':
-            \App::setLocale('en');
-            \Session::put('locale', 'en');
-            break;
+		$locale = \Request::header('locale');
+		switch ($locale) 
+		{
+			case 'en':
+			\App::setLocale('en');
+			\Session::put('locale', 'en');
+			break;
 
-            case 'ar':
-            \App::setLocale('ar');
-            \Session::put('locale', 'ar');
-            break;
+			case 'ar':
+			\App::setLocale('ar');
+			\Session::put('locale', 'ar');
+			break;
 
-            case 'all':
-            \App::setLocale('en');
-            \Session::put('locale', 'all');
-            break;
+			case 'all':
+			\App::setLocale('en');
+			\Session::put('locale', 'all');
+			break;
 
-            default:
-            \App::setLocale('en');
-            \Session::put('locale', 'en');
-            break;
-        }
-    }
+			default:
+			\App::setLocale('en');
+			\Session::put('locale', 'en');
+			break;
+		}
+	}
 
-    /**
-     * Set relation based on the called api.
-     * 
-     * @param  string $route
-     * @return void
-     */
-    private function setRelations($route)
-    {
-        $route           = $route !== 'index' ? $route : 'list';
-        $relations       = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false;
-        $this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
-    }
+	/**
+	 * Set relation based on the called api.
+	 * 
+	 * @param  string $route
+	 * @return void
+	 */
+	private function setRelations($route)
+	{
+		$route           = $route !== 'index' ? $route : 'list';
+		$relations       = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false;
+		$this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
+	}
 }