Authentication With Slim 4 (And much, much more)

Documentation Sections

Installation

Dependencies

git clone https://github.com/zhorton34/authorize-slim-4.gitcd authorize-slim-4pwd

ip: 192.168.10.10memory: 2048cpus: 2provider: virtualboxauthorize: ~/.ssh/id_rsa.pubkeys:    - ~/.ssh/id_rsafolders:    -       # Replace `map: /Users/zhorton/tutorials/authorize-slim-4`       # With `map: {the_copied_output_from_pwd_in_step_2}        map: /Users/zhorton/tutorials/authorize-slim-4        ## map Update with path you cloned the repository on your machine        to: /home/vagrant/codesites:    -        map: slim.auth        to: /home/vagrant/code/publicdatabases:    - slimfeatures:    -        mariadb: false    -        ohmyzsh: false    -        webdriver: falsename: authorize-slim-4hostname: authorize-slim-4

  vagrant up --provision

### Host Database## localhost is used to configure the loopback interface# when the system is booting.  Do not change this entry.##127.0.0.1localhost255.255.255.255broadcasthost::1             localhost############################ Homestead Sites (Slim 4)###########################192.168.10.10   slim.auth

cd code && cp .env.example .env && composer install && npm install

List Slim Console Commands

sole ToolUsage:  command [options] [arguments]Options:  -h, --help            Display this help message  -q, --quiet           Do not output any message  -V, --version         Display this application version      --ansi            Force ANSI output      --no-ansi         Disable ANSI output  -n, --no-interaction  Do not ask any interactive question  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debugAvailable commands:  help              Displays help for a command  list              Lists commands  tinker             db  db:fresh          Drop all database table and re-migrate, then re-seed all tables  db:migrate        Migration migrations to database  db:seed           Run Database Seeders  db:show           Show all of your models/table records in a table for display error-logs  error-logs:clear  Remove Errors Logs Rendered Templates make  make:command      Generate Command Scaffold  make:controller   description text for console command  make:factory      Scaffold new factory command  make:middleware   Generate or make Scaffold for new http middleware class  make:migration    Make or scaffolded new migration for our database  make:model        Generate The Scaffold For An Eloquent Model  make:provider     Scaffold new Service Provider  make:request      Generate Form Request Validation Scaffold  make:seeder       Generate a database seeder scaffold  make:event        Generate event scaffold  make:listener     Generate listener scaffold  make:trait        Create a new trait  make:view         Generate view Scaffold migrate  migrate:rollback  Rollback Previous Database Migration view  view:clear        Remove Cache For View Templates

Migrate and Seed Database

Show database table example

Register Middleware

class HttpKernel extends Kernel{    /**     * Global Middleware     *     * @var array     */    public array $middleware = [//        Middleware\ExampleAfterMiddleware::class,//        Middleware\ExampleBeforeMiddleware::class    ];    /**     * Route Group Middleware     */    public array $middlewareGroups = [        'api' => [],        'web' => [            Middleware\RouteContextMiddleware::class,            'csrf'        ]    ];}

Create and Register newphp slim command

class ExampleCommand extends Command{    protected $name = 'example:command';    protected $help = 'Example Command For Readme';    protected $description = 'Example Command For Readme';    public function arguments()    {        return [            'hello' => $this->required('Description for this required command argument'),            'world' => $this-optional('Description for this optional command argument', 'default')        ];    }    public function handler()    {        /** Collect Console Input **/        $all_arguments = $this->input->getArguments();        $optional_argument = $this-input->getArgument('world');        $required_argument = $this->input->getArgument('hello');        /** Write Console Output **/        $this->warning("warning output format");        $this->info("Success output format");        $this->comment("Comment output format");        $this->error("Uh oh output format");    }}

<?phpnamespace App\Console;use Boot\Foundation\ConsoleKernel as Kernel;class ConsoleKernel extends Kernel{    public array $commands = [        Commands\ExampleCommand::class, // Registered example command        Commands\ViewClearCommand::class,        Commands\MakeSeederCommand::class,        Commands\DatabaseRunSeeders::class,        Commands\DatabaseFreshCommand::class,        Commands\MakeMigrationCommand::class,        Commands\DatabaseMigrateCommand::class,        Commands\DatabaseTableDisplayCommand::class,        Commands\DatabaseRollbackMigrationCommand::class    ];}

php slim make:{command} Scaffold Stub Generators

  php slim make:command {ExampleConsoleCommand}      Generate Command Scaffold  php slim make:controller {Example} description text for console command  php slim make:factory {ExampleFactory}      Scaffold new factory command  php slim make:middleware {ExampleMiddleware} Generate or make Scaffold for new http middleware class  php slim make:migration {CreateExamplesTable   Make or scaffolded new migration for our database  php slim make:model {Example}        Generate The Scaffold For An Eloquent Model  php slim make:provider {ExampleServiceProvider}     Scaffold new Service Provider  php slim make:request {ExampleFormRequest}     Generate Form Request Validation Scaffold  php slim make:seeder {ExamplesTableSeeder}       Generate a database seeder scaffold

Global Helper Functions

old($input_name)

<form>  @csrf  <input type='text' name='first_name' value='{{ old('first_name') }}' /></form>

back()

ExampleController {   index()   {      return back();   }}

event()

event()->listen('flash.success', fn ($message) => session()->flash()->add('success', $message);event()->fire('flash.success', ['Way to go, it worked!']);

return [   'events' => [      ExampleEvent::class => [          ExampleListener::class,          ExampleListenerTwo::class,          ExampleListenerThree::class      ],      ResetUserPasswordEvent::class => [          GenerateResetPasswordKey::class,          SendUserResetPasswordEmail::class,      ]   ]];

// Fire event using dependency injectionevent()->fire(ExampleEvent::class);// Fire event overriding default depency injectionsevent()->fire(ExampleEvent::class, [   // parameterOne   // parameterTwo]);

session()

// Flash to session to only remember for the proceeding requestsession()->flash()->set('success', ['Successful Form Submission!']);session()->flash()->set('errors', ['Name field failed', 'Email field failed']);// Set directly to session to remember for several requestssession()->set('remember_in_session_for_multiple_requests', ['remember me']);

validator($input, $rules = [], $messages = [])

$input = [   'first_name' => 'John',   'last_name' => 'Joe',   'email' => 'john.joe@example.com'];$rules = [   'first_name' => 'required|string',   'last_name' => 'required|string|max:50',   'email' => 'required|email|max:50|unique:users,email'];$messages = [    'first_name.required' => 'First name is a required field',    'first_name.string' => 'First name must be a string field',    'last_name.required' => 'Last name must is a required field',    'last_name.string' => 'Last name must be a string field',    'email.email' => 'Email must be in the proper email format',    'email.unique' => 'Email already taken, no duplicate emails allowed',    'email.required' => 'Email is required',];$validation = validator($input, $rules, $messages);if ($validation->fails()) {   session()->flash()->set('errors', $validation->errors()->getMessages());      return back();}if ($validation->passes() {   session()->flash()->set('success', 'Successfully Submitted Form and Passed Validation');   return redirect('/home');}

Mailables (Send Emails)

class ExampleController{   public function send(\Boot\Foundation\Mail\Mailable $mail, $response)   {       $user = \App\User::first();              $success = $mail->view('mail.auth.reset', ['url' => 'https://google.com'])            ->to($user->email, $user->first_name)            ->from('admin@slim.auth', 'Slim Authentication Admin')            ->subject('Reset Password')            ->send();       $response->getBody()->write("Successfully sent Email: {$success}");       return $response;   }}

Events (Events & associated listeners with dependency injection)

// App\Providers\EventServiceProvider boot method()event()->listen('flash.success', fn ($message) => session()->flash()->add('success', $message);event()->fire('flash.success', [   'Way to go, it worked!']);

<?phpnamespace App\Events;use App\Support\Auth;use Boot\Foundation\Http\Session;class ExampleEvent{    public $user;    public $session;    public function __construct(Session $session)    {        $this->user = Auth::user();        $this->session = $session;        return $this;    }}

<?phpnamespace App\Listeners;use App\Events\UserLogin;class FlashWelcomeBackMessage{   public function __invoke(UserLogin $event)   {      $event->session->flash()->add('success', "Welcome Back {$event->user->first_name}!");    }}

return [   'events' => [      UserLogin::class => [          FlashWelcomeBackMessage::class,          // ExampleListenerTwo::class,          // ExampleListenerThree::class      ],      // ResetUserPasswordEvent::class => [           // GenerateResetPasswordKey::class,           // SendUserResetPasswordEmail::class,      // ]   ]];

public function login(StoreLoginRequest $input){  if ($input->failed()) return back();   if (Auth::attempt($input->email, $input->password))   {      event()->fire(\App\Events\UserLogin::class); // Fire Event      return redirect('/home');   }   return back();}

// Example Using UserLogin Event:// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~$session = app()->resolve('session');$different_user = \App\User::find(5); event()->fire(UserLogin::class, [   $session, $different_user]);// Example Using Random Event// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~event()->fire(ExampleEvent::class, [   // parameterOne   // parameterTwo]);// Dependency Injection With While Using event() to register listeners// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~event()->listen('welcome-view', fn (\Jessengers\Blade\Blade $blade) => $blade->make('welcome')->render());// Fire's event. Listeners will work using the blade instance resolved from our service containerevent()->fire('welcome-view');// inject blade instance with different template path than the one binded to our containerevent()->fire('welcome-view', [    new \Jessengers\Blade\Blade(        base_path('vendor/package/resources/views'),         storage_path('cache'),    )]);

Packages & Resources Glossary