scriptpage/framework

Core code of the Scriptpage framework

v3.1.2 2024-10-22 19:29 UTC

MIT

• Túlio Gonçalves

• repository
• laravel
• eloquent
• jwt
• url query string

README

v3.0

Note: This repository contains the core code of the Scriptpage framework. If you want to build an application using Laravel with scriptpage, you need know Scriptpage Sail.

See a MVC Starter with VueJS using scriptpage: starter-with-vuejs

You want to know a little more about the Repository pattern? Read this great article.

Table of Contents

• Installation
  • Composer
  • Laravel
    • JWT Authorization
    • Application Version
    • Global Exception
• URL Query Filters
  • RepositoryInterface
  • Filters
• Usage
  • Create a Model
  • Use methods
  • Create a Criteria
  • Using the Filter in a Controller

Installation

Composer

Execute the following command to get the latest version of the package:

composer require scriptpage/framework

Laravel

Execute the following command to install componente on project:

php artisan vendor:publish --tag=scriptpage-install

To enable helpers.php file, add in composer.json:

    "autoload": {
        "psr-4": {
        ...
        },
        "files": [
            "app/helpers.php"
        ]

Then, execute the following command to reload componentes on project:

composer dumpautoload -o

Add in api or web route file:

Route::middleware('auth')->group(function () {

    /**
     * Home routes
     */
    addRoute('web/home');

    /**
     * Users routes
     */
    addRoute('web/users');

});

/**
 * Auth routes
 */
addRoute('api/auth');

/**
 * Users routes
 */
Route::prefix('v1')->group(function () {
        addRoute('api/users');
});

JWT Authorization

Execute the following commands to install and configure JWT package with scriptpage:

composer require tymon/jwt-auth
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
php artisan jwt:secret
php artisan vendor:publish --tag=scriptpage-jwt

Inside the config/auth.php make the following changes to the file:

'defaults' => [
    'guard' => 'api',
    'passwords' => 'users',
],

...

'guards' => [
    'api' => [
        'driver' => 'jwt',
        'provider' => 'users',
    ],
],

Add trait in Models\User class.

...

use App\Traits\traitUserJWT;

class User extends Authenticatable implements JWTSubject
{
  ...

  use traitUserJWT;

Add in App\Http\Kernel class.

protected $middlewareAliases = [
        ...

        'auth' => \Scriptpage\Middleware\EnsureUserAuth::class,
];

Role permissions

Execute the following commands to install and configure role permissions of scriptpage:

php artisan vendor:publish --tag=scriptpage-role

Add in App\Http\Kernel class.

protected $middlewareAliases = [
        ...

        'roles' => \Scriptpage\Middleware\EnsureUserHasRole::class,
];

Global Exception

Defining a global exception on your application's in App\Exceptions\Handler@register class.

use Scriptpage\Traits\traitApiRenderableResponse;

class Handler extends ExceptionHandler
{
        use traitApiRenderableResponse;

        ...

        $this->renderable(function (Exception $e, Request $request) {
                return $this->apiRenderableResponse($e, $request);
        });

Application Version

Add this lines in Config/App.php file:

'version' => env('APP_VERSION', '1.0.0'),
'project_name' => env('APP_PROJECT_NAME', 'app'),

URL Query Filters

filters

• select = $column1,$column2,...
• with = $relation1,$relation2,...
• withCount = $relation1,$relation2,...
• withSum = $relation:$column
• where = $column,[$condition = 'equal']:$value
• orWhere = $column,[$condition = 'equal']:$value
• join = $table:$field1,$field2
• leftJoin = $table:$field1,$field2
• rightJoin = $table:$field1,$field2
• take = $limit
• skip = $offset
• orderBy = $column:[$direction = 'asc']
• groupBy = $column1,$column2,...
• having = $column,[$condition = 'equal']:$value
• orHaving = $column,[$condition = 'equal']:$value
• paginate = true|false

array is separated by semicolons, example: expresion1; expression2; expresion3...

Conditions

• equal( = )

    $field:$value
  

• greater( > )

    $field,greater:$value
  

• greater_or_equal( >= )

    $field,greater_or_equal:$value
  

• less( < )

    $field,less:$value
  

• less_or_equal( <= )

    $field,less_or_equal:$value
  

• different ( <> )

    $field,different:$value
  

• null_safe ( <=> )

    $field,null_safe:$value
  

• in

    $field,in:$value1,$value2,$value3...
  

• not_in

    $field,in:$value1,$value2,$value3...
  

• like

    $field,like:$pattern
  
    $pattern, examples:
  
            _value*
            value*
            *value_*
  

• not_like

    $field,like:$pattern
  

• between

    $field,between:$value1, $value2
  

• not_between

    $field,not_between:$value1, $value2
  

Examples

Using repository by request

Model

• get api/users

With clausule

• get api/users?select=id,name,email&with=roles

Where clausule

• get api/users?where=role_id:2
• get api/users?where=role_id:2;name:ester
• get api/users?where=role_id:2&orWhere=name:ester
• get api/users?where=role_id,between:34,52
• get api/users?where=email_verified_at:2023-05-14 14.02.20

to Sql

Show sql statement result

• get api/users/sql?where=email_verified_at:2023-05-14 14.02.20

selecting fields

• get api/model/users?select=id,name,email

Database

• get api/users/db?select=name,email&where=id,greater:200

Add relationship

get api/table/users?join=contacts:users.id,contacts.user_id

get api/table/users
    ?join=contacts:users.id,contacts.user_id
    ;orders:users.id,orders.user_id
    &where=users.name:laravel
    &select=users.*,contacts.phone,orders.price

Laravel Eloquent Query: Using WHERE with OR AND OR

Make use of Logical Grouping

    Model::where(function ($query) {
    $query->where('a', '=', 1)
            ->orWhere('b', '=', 1);
    })->where(function ($query) {
    $query->where('c', '=', 1)
            ->orWhere('d', '=', 1);
    });

With parameters for a,b,c,d

$a = 1;
$b = 1;
$c = 1;
$d = 1;
Model::where(function ($query) use ($a, $b) {
    return $query->where('a', '=', $a)
        ->orWhere('b', '=', $b);
})->where(function ($query) use ($c, $d) {
    return $query->where('c', '=', $c)
        ->orWhere('d', '=', $d);
});

Footnotes

1. A framework is an abstraction that links common code across multiple software projects to provide generic functionality. A framework can achieve specific functionality, by configuration, during application programming. Unlike libraries, it is the framework that dictates the flow of control of the application, called Inversion of Control..wikipedia ↩