The ultimate guide to php artisan tinker

Sebastian — Wed, 05 May 2021 09:49:05 +0000

What is tinker?

This post is dedicated to an underappreciated component of Laravel – the tinker command that you can run with php artisan tinker. The command is built into every Laravel application and you can use it to run code within the context of your application. Let's explore what this means.

Tinker is a REPL (read-eval-print loop) on top of PsySH. It takes your command line input, evaluates it and prints the output to the console. So instead of using your database management tool and writing an SQL query to get the amount of users in your database, you can simply run App\User::count() and get => 10 as the result.

How does it work?

The php artisan tinker command bootstraps your application and waits for new commands when this finishes. It keeps the application state until you close leave the tinker command with exit, Ctrl+C or close the terminal. This means that you have to initialize a new tinker session every time you change your code to get the latest version – but it allows you to define new variables that are accessible until you end the tinker session.

When do you need it?

All the time! We use tinker in development and on production for many scenarios. The most common use case is accessing the database via Laravel Eloquent Models.

Use Eloquent Models with tinker

Tinker is very convenient if you want to create test data in development – simply create two new test users with their factory.

User::factory()->count(2)->create()

This command uses the model factory for users and creates two new users. Your output of this command should look similar to this – with different usernames and emails.

=> Illuminate\Database\Eloquent\Collection {#4612
     all: [
       App\Models\User {#4616
         gender: "male",
         firstname: "Orie",
         lastname: "Rath",
         email: "jocelyn.schuster@example.org",
       },
       App\Models\User {#4620
         gender: "female",
         firstname: "Karlie",
         lastname: "Ruecker",
         email: "trycia.koelpin@example.org",
       },
     ],
   }

Let's change the last name of the second user with php artisan tinker (type and confirm every line separately)

$user = User::where('email', 'trycia.koelpin@example.org')->first();
$user->lastname = 'Smith';
$user->save();

If this works, tinker returns => true

If you don't want to run multiple commands and the model supports mass assignments, you can run this in a single line.

User::where('email', 'trycia.koelpin@example.org')->first()->update(['lastname' => 'Carlson']);

There are no limits what you can do with tinker as long as you are able to squeeze your code into one line or can execute the code line by line. If you want to push this to the next level, you can use Tinkerwell to write multiple lines of code and run them at once. This is very handy if you work with Laravel Collections or use loops – or simply like well-formatted code.

With tinker, you have access to all PHP functions and helpers that Laravel provides.

Generate UUIDs

Instead of googling for an internet service that lets your generate UUIDs, you can use tinker and generate one with the Laravel Str helper.

Str::uuid()

This instantly generates an UUID for you.

=> Ramsey\Uuid\Lazy\LazyUuidFromString {#4632
     uuid: "a1d56de1-455d-4275-8812-c3e28d45428e",
   }

Create a slug from a headline

Str::slug('The ultimate guide to php artisan tinker')

=> "the-ultimate-guide-to-php-artisan-tinker"

Get the date of the first day of the week in 3 months

now()->addMonths(3)->startOfWeek()

=> Illuminate\Support\Carbon @1627862400 {#5507
     date: 2021-08-02 00:00:00.0 UTC (+00:00),
   }

Base64 encode and decode

base64_encode('The ultimate guide to php artisan tinker')
base64_decode('VGhlIHVsdGltYXRlIGd1aWRlIHRvIHBocCBhcnRpc2FuIHRpbmtlcg==')

=> "VGhlIHVsdGltYXRlIGd1aWRlIHRvIHBocCBhcnRpc2FuIHRpbmtlcg=="
=> "The ultimate guide to php artisan tinker"

Ok, you get it.

Dispatch jobs

You can dispatch jobs with tinker and add data to this job too. This is a real time-saver when you develop a new job and there are multiple steps involved to trigger the job. Imagine that you have a job that fulfills an order in an ecommerce system. You can either place many orders to test the job or simply dispatch it via tinker. Remember to restart your tinker session if you change the code of the job.

$order = new Order(['invoice_id' => 12345, 'item' => 'Tinker Fangirl Mug']);
dispatch(new OrderPlacedJob($order));

Send Notifications

Similar to Jobs, you can also send Laravel Notifications & Mailables via tinker. You are in the context of your application and can send them with a simple call.

(new User)->notify(new InvoicePaid($invoice);

Check your current Laravel version

The composer.json file of your application contains the major and minor version of your Laravel application. If you want to know which Laravel version you use exactly, you can get this via app()->version().

app()->version()

=> "8.24.0"

Tinkerwell – php artisan tinker on steroids

Tinker is a powerful tool for all Laravel developers but you can push this to a next level. Tinkerwell is a code editor for macOS, Windows and Linux that is entirely dedicated to tinker. It comes with multiline support, SSH connections and allows you to tinker with multiple applications at the same time.

With Tinkerwell, there is no need to reload a tinker session, as Tinkerwell evaluates the current state of your code and does not keep the application state.

Using Collections

The multiline support makes it easy to use Laravel Collections or foreach loops in tinker. To continue with an example, you can update multiple users at the same time by using collections on the Eloquent result.

App\User::whereNull('confirmed_at')
  ->get()
  ->each(function ($user) {
    $user->update([
      'confirmed_at' => $user->created_at->addDay(),
    ]);
  });

Testing APIs

When working with APIs, the Http facade of Laravel provides a fluent interface to send GET and POST requests to an API. You can use this to access the API and see how the data of this API looks or send data to the API before you implement the API directly in your application.

$apiKey = 'Your-Forge-API-Key';

$response = Http::withHeaders([
    'accept' => 'application/json'
  ])
  ->withToken($apiKey)
  ->get('https://forge.laravel.com/api/v1/servers')
  ->json();

collect($response['servers'])->pluck('name');

=> Illuminate\Support\Collection {#1046
     all: [
       "HELO-cloud",
       "bc-dev",
       "bc-prod-01",
       "bc-prod-02",
       "bc-prod-03",
       "bc-website",
       "expose",
       "expose-eu-1",
       ...
     ],
   }

Tinkerwell is a mighty desktop application for every Laravel developer and more than 7,000 developers are already using Tinkerwell, including the Laravel team itself.

How to get the raw SQL query from the Laravel Query Builder

Sebastian — Tue, 04 May 2021 08:10:25 +0000

Sometimes, you ask yourself how you can get the Laravel query builder to output its raw SQL query as a string. Luckily, there are multiple ways how to get this raw query.

Using Laravel Eloquent methods

The first method to get the query of an Eloquent call is by using the toSql() method. This method returns the query without running it – good if you don't want to alter data and only get the query – but this method doesn't show the whole query if your query is more complex or if there are sub-queries.

Example


App\User::query()
    ->where('created_at', '<', now()->subYear())
    ->with('assignedApps', 'courses')
    ->orderBy('email', 'asc')
    ->limit(5)
    ->toSql();

Output:

select * from `users` where `created_at` < ? order by `email` asc limit 5

Using the Laravel Query Log

The second method is the Laravel query log that collects all queries within a request. You can enable this log, run your query and dump the output.

Example

DB::enableQueryLog();

App\User::query()
    ->where('created_at', '<', now()->subYear())
    ->with('assignedApps', 'courses')
    ->orderBy('email', 'asc')
    ->limit(5)
    ->get();

dd(DB::getQueryLog());

This code leads to the output:

array:3 [▼
  0 => array:3 [▼
    "query" => "select * from `users` where `created_at` < ? order by `email` asc limit 5"
    "bindings" => array:1 [▼
      0 => Illuminate\Support\Carbon @1588525477 {#1595 ▶}
    ]
    "time" => 7.97
  ]
  1 => array:3 [▼
    "query" => "select `apps`.*, `user_apps`.`user_id` as `pivot_user_id`, `user_apps`.`app_id` as `pivot_app_id`, `user_apps`.`created_at` as `pivot_created_at`, `user_apps`.` ▶"
    "bindings" => []
    "time" => 2.81
  ]
  2 => array:3 [▼
    "query" => "select `courses`.*, `user_courses`.`user_id` as `pivot_user_id`, `user_courses`.`course_id` as `pivot_course_id`, `user_courses`.`created_at` as `pivot_created_ ▶"
    "bindings" => []
    "time" => 0.54
  ]
]

This gives you detailed information about the executed query and their execution time. If the query has data bindings, the query logs lists them and makes it easy to check your data,

Digging deeper

While you can get the raw SQL query with the methods above, there are situations where you debug the runtime or memory allocation of a query and want to know why it takes longer than expected.

Using Tinkerwell

If you write your query in Tinkerwell anyway, you can highlight the Eloquent query and press Cmd+Shift+R (or Ctrl+Shift+R if you are on Windows) and Tinkerwell profiles the query directly in the editor. You see all executed queries, the time that the query run, the memory consumption and even the peak for your memory. This is super useful if you debug server crashes or want to know how much memory your application server needs.

There are multiple ways how to get the raw SQL query for an Eloquent call – we are using Tinkerwell daily and so this is our natural way to debug queries.

Forem: Sebastian

The ultimate guide to php artisan tinker

What is tinker?

How does it work?

When do you need it?

Use Eloquent Models with tinker

Generate UUIDs

Create a slug from a headline

Get the date of the first day of the week in 3 months

Base64 encode and decode

Dispatch jobs

Send Notifications

Check your current Laravel version

Tinkerwell – php artisan tinker on steroids

Using Collections

Testing APIs

How to get the raw SQL query from the Laravel Query Builder

Using Laravel Eloquent methods

Example

Using the Laravel Query Log

Example

Digging deeper

Using Tinkerwell