laravel/tinker

Laravel Tinker is a powerful REPL (Read-Eval-Print Loop) for the Laravel framework, built on top of the PsySH console. It allows developers to interact with their entire Laravel application directly from the command line. Instead of writing a new route, controller, or a dedicated script to test a small piece of code or interact with the database, Tinker provides an interactive shell where you can execute PHP code and see the results instantly.

Key Features and Uses:

1. Database Interaction: Easily create, read, update, and delete records using Eloquent models. This is incredibly useful for testing new models, debugging database queries, or performing quick data manipulations.
2. Model Manipulation: Instantiate models, call methods on them, and test their relationships without needing to spin up a web server or browser.
3. Service & Class Testing: Resolve services from the service container, call methods on any class in your application, and test custom logic or components.
4. Helper Functions: Access and test any of Laravel's global helper functions (e.g., `dd()`, `env()`, `now()`, `config()`).
5. Debugging & Prototyping: Quickly prototype new features or debug existing ones by executing code line-by-line, inspecting variable states, or dumping output.
6. Administrative Tasks: Perform quick administrative tasks like changing user passwords, creating new users, clearing cache, or dispatching jobs.
7. Route Inspection: You can even inspect and call routes, though this is less common than other interactions.

To start a Tinker session, you simply run `php artisan tinker` in your Laravel project's root directory. Tinker provides a complete environment where all your application's classes, services, and configurations are loaded, making it an indispensable tool for Laravel development.

Example Code

```php
// To start a Tinker session, navigate to your Laravel project's root directory
// and run the following command in your terminal:
// php artisan tinker

// Once inside the Tinker session, you'll see a '>>>' prompt. You can then execute PHP code:

// 1. Create a new User model instance and save it to the database:
>>> $user = new App\Models\User;
=> App\Models\User {#4088}
>>> $user->name = 'John Doe';
=> "John Doe"
>>> $user->email = 'john.doe@example.com';
=> "john.doe@example.com"
>>> $user->password = bcrypt('secret'); // Always hash passwords!
=> "$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi"
>>> $user->save();
=> true

// 2. Retrieve a user from the database:
>>> App\Models\User::find(1);
=> App\Models\User {#4100
     id: 1,
     name: "John Doe",
     email: "john.doe@example.com",
     email_verified_at: null,
     created_at: "2023-10-27T10:00:00.000000Z",
     updated_at: "2023-10-27T10:00:00.000000Z",
   }

// 3. Update an existing user:
>>> $user = App\Models\User::where('email', 'john.doe@example.com')->first();
=> App\Models\User {#4100 ...}
>>> $user->name = 'Jane Doe';
=> "Jane Doe"
>>> $user->save();
=> true

// 4. Delete a user:
>>> App\Models\User::destroy(1);
=> 1

// 5. Use a Laravel helper function:
>>> now();
=> Carbon\Carbon @1678886400 {#4102
     date: 2023-03-15 12:00:00.000000 Europe/Berlin,
   }

// 6. Access configuration values:
>>> config('app.name');
=> "Laravel"

// 7. Resolve a service from the container and call a method (assuming MyService exists):
>>> app(\App\Services\MyService::class)->doSomething();
=> "Something done!"

// 8. Dispatch a job (assuming SendWelcomeEmail job exists):
>>> App\Jobs\SendWelcomeEmail::dispatch($user);
=> App\Jobs\SendWelcomeEmail {#4105}

// To exit Tinker, type 'exit' or press Ctrl+D.
```

Example Code

Related Topics