Laravel Tinker Tool
Laravel Framework Through artisan, developers can control almost everything running inside Laravel framework, and it can be a handy tool for updating user password quick and easy. First, get access to the tinker tool via artisan by issuing the command: $ php artisan tinker. 15 rows Mar 25, 2019 Laravel Tinker is open-sourced software licensed under the MIT license. If you use Ruby on Rails, you can think of Laravel tinker tool as something like `rails console` command, it allows you to interact with your. Faker is the library which helps us to generate fake data in our laravel application. It is a library which allows you to manage fake data for testing purpose. It can support various types of data like name, country, phone number etc. It is easy to use and integrate in the laravel project using the Factory feature of the laravel framework.
- Laravel Tinker Tool Box
- Laravel 5.4 Tinker
- Onyx Mac
- Laravel Tinker Tool Set
- Laravel-web-tinker
- Php Artisan Tinker Log
Laravel-permission: assignRole works in Tinker but not in application. Ask Question Asked 1 year, 8 months ago. How can I correctly implement UUIDs in Laravel with spatie/laravel-permission and webpatser/laravel-uuid? Hot Network Questions Sci-fi novel from 1980s(?) about colony on Mars. The functionality of this package is built into Laravel 5.5 and above, only install this in older Laravel versions Use short class names in an Artisan Tinker session When using Artisan's Tinker command it can be quite bothersome having to type the fully qualified classname to do something simple. Tinker is a REPL for php that comes included with Laravel. If you have ever played with the Ruby interactive tool then you know what Tinker is. Let's try it out quickly before using it with Laravel. NOTE: As of v5.4, you must install Tinker as a separate package. Fortunately, it is very simple to do: composer require laravel/tinker.
- Introduction
- Writing Commands
- Defining Input Expectations
- Command I/O
- Programmatically Executing Commands
Introduction
Artisan is the command-line interface included with Laravel. It provides a number of helpful commands that can assist you while you build your application. To view a list of all available Artisan commands, you may use the list
command:
Every command also includes a 'help' screen which displays and describes the command's available arguments and options. To view a help screen, precede the name of the command with help
:
Tinker (REPL)
Laravel Tinker is a powerful REPL for the Laravel framework, powered by the PsySH package.
Installation
All Laravel applications include Tinker by default. However, you may install it manually if needed using Composer:
Usage
Tinker allows you to interact with your entire Laravel application on the command line, including the Eloquent ORM, jobs, events, and more. To enter the Tinker environment, run the tinker
Artisan command:
You can publish Tinker's configuration file using the vendor:publish
command:
{note} The dispatch
helper function and dispatch
method on the Dispatchable
class depends on garbage collection to place the job on the queue. Therefore, when using tinker, you should use Bus::dispatch
or Queue::push
to dispatch jobs.
Command Whitelist
Tinker utilizes a white-list to determine which Artisan commands are allowed to be run within its shell. By default, you may run the clear-compiled
, down
, env
, inspire
, migrate
, optimize
, and up
commands. If you would like to white-list more commands you may add them to the commands
array in your tinker.php
configuration file:
Alias Blacklist
Typically, Tinker automatically aliases classes as you require them in Tinker. However, you may wish to never alias some classes. You may accomplish this by listing the classes in the dont_alias
array of your tinker.php
configuration file:
Writing Commands
In addition to the commands provided with Artisan, you may also build your own custom commands. Commands are typically stored in the app/Console/Commands
directory; however, you are free to choose your own storage location as long as your commands can be loaded by Composer.
Generating Commands
To create a new command, use the make:command
Artisan command. This command will create a new command class in the app/Console/Commands
directory. Don't worry if this directory does not exist in your application, since it will be created the first time you run the make:command
Artisan command. The generated command will include the default set of properties and methods that are present on all commands:
Command Structure
After generating your command, you should fill in the signature
and description
properties of the class, which will be used when displaying your command on the list
screen. The handle
method will be called when your command is executed. You may place your command logic in this method.
{tip} For greater code reuse, it is good practice to keep your console commands light and let them defer to application services to accomplish their tasks. In the example below, note that we inject a service class to do the 'heavy lifting' of sending the e-mails.
Let's take a look at an example command. Note that we are able to inject any dependencies we need into the command's handle
method. The Laravel service container will automatically inject all dependencies that are type-hinted in this method's signature:
Closure Commands
Closure based commands provide an alternative to defining console commands as classes. In the same way that route Closures are an alternative to controllers, think of command Closures as an alternative to command classes. Within the commands
method of your app/Console/Kernel.php
file, Laravel loads the routes/console.php
file:
Even though this file does not define HTTP routes, it defines console based entry points (routes) into your application. Within this file, you may define all of your Closure based routes using the Artisan::command
method. The command
method accepts two arguments: the command signature and a Closure which receives the commands arguments and options:
The Closure is bound to the underlying command instance, so you have full access to all of the helper methods you would typically be able to access on a full command class.
Type-Hinting Dependencies
In addition to receiving your command's arguments and options, command Closures may also type-hint additional dependencies that you would like resolved out of the service container:
Closure Command Descriptions
When defining a Closure based command, you may use the describe
method to add a description to the command. This description will be displayed when you run the php artisan list
or php artisan help
commands:
Defining Input Expectations
When writing console commands, it is common to gather input from the user through arguments or options. Laravel makes it very convenient to define the input you expect from the user using the signature
property on your commands. The signature
property allows you to define the name, arguments, and options for the command in a single, expressive, route-like syntax.
Arguments
All user supplied arguments and options are wrapped in curly braces. In the following example, the command defines one required argument: user
:
Laravel Tinker Tool Box
You may also make arguments optional and define default values for arguments:
Options
Options, like arguments, are another form of user input. Options are prefixed by two hyphens (--
) when they are specified on the command line. There are two types of options: those that receive a value and those that don't. Options that don't receive a value serve as a boolean 'switch'. Let's take a look at an example of this type of option:
In this example, the --queue
switch may be specified when calling the Artisan command. If the --queue
switch is passed, the value of the option will be true
. Otherwise, the value will be false
:
Options With Values
Next, let's take a look at an option that expects a value. If the user must specify a value for an option, suffix the option name with a =
sign:
In this example, the user may pass a value for the option like so:
You may assign default values to options by specifying the default value after the option name. If no option value is passed by the user, the default value will be used:
Option Shortcuts
To assign a shortcut when defining an option, you may specify it before the option name and use a delimiter to separate the shortcut from the full option name: Virtual pioneer dj software free download.
Input Arrays
If you would like to define arguments or options to expect array inputs, you may use the *
character. First, let's take a look at an example that specifies an array argument:
When calling this method, the user
arguments may be passed in order to the command line. For example, the following command will set the value of user
to ['foo', 'bar']
:
When defining an option that expects an array input, each option value passed to the command should be prefixed with the option name:
Input Descriptions
You may assign descriptions to input arguments and options by separating the parameter from the description using a colon. If you need a little extra room to define your command, feel free to spread the definition across multiple lines:
Command I/O
Retrieving Input
While your command is executing, you will obviously need to access the values for the arguments and options accepted by your command. To do so, you may use the argument
and option
methods:
If you need to retrieve all of the arguments as an array
, call the arguments
method:
Options may be retrieved just as easily as arguments using the option
method. To retrieve all of the options as an array, call the options
method:
If the argument or option does not exist, null
will be returned.
Prompting For Input
In addition to displaying output, you may also ask the user to provide input during the execution of your command. The ask
method will prompt the user with the given question, accept their input, and then return the user's input back to your command:
The secret
method is similar to ask
, but the user's input will not be visible to them as they type in the console. This method is useful when asking for sensitive information such as a password:
Asking For Confirmation
If you need to ask the user for a simple confirmation, you may use the confirm
method. By default, this method will return false
. However, if the user enters y
or yes
in response to the prompt, the method will return true
.
Auto-Completion
The anticipate
method can be used to provide auto-completion for possible choices. The user can still choose any answer, regardless of the auto-completion hints:
Alternatively, you may pass a Closure as the second argument to the anticipate
method. The Closure will be called each time the user types an input character. The Closure should accept a string parameter containing the user's input so far, and return an array of options for auto-completion:
Multiple Choice Questions
If you need to give the user a predefined set of choices, you may use the choice
method. You may set the array index of the default value to be returned if no option is chosen:
In addition, the choice
method accepts optional fourth and fifth arguments for determining the maximum number of attempts to select a valid response and whether multiple selections are permitted:
Writing Output
To send output to the console, use the line
, info
, comment
, question
and error
methods. Each of these methods will use appropriate ANSI colors for their purpose. For example, let's display some general information to the user. Typically, the info
method will display in the console as green text:
To display an error message, use the error
method. Error message text is typically displayed in red:
If you would like to display plain, uncolored console output, use the line
method:
Table Layouts
The table
method makes it easy to correctly format multiple rows / columns of data. Just pass in the headers and rows to the method. The width and height will be dynamically calculated based on the given data:
Progress Bars
For long running tasks, it could be helpful to show a progress indicator. Using the output object, we can start, advance and stop the Progress Bar. First, define the total number of steps the process will iterate through. Then, advance the Progress Bar after processing each item:
For more advanced options, check out the Symfony Progress Bar component documentation.
Registering Commands
Because of the load
method call in your console kernel's commands
method, all commands within the app/Console/Commands
directory will automatically be registered with Artisan. In fact, you are free to make additional calls to the load
method to scan other directories for Artisan commands:
You may also manually register commands by adding its class name to the $commands
property of your app/Console/Kernel.php
file. When Artisan boots, all the commands listed in this property will be resolved by the service container and registered with Artisan:
Programmatically Executing Commands
Sometimes you may wish to execute an Artisan command outside of the CLI. For example, you may wish to fire an Artisan command from a route or controller. You may use the call
method on the Artisan
facade to accomplish this. The call
method accepts either the command's name or class as the first argument, and an array of command parameters as the second argument. The exit code will be returned:
Alternatively, you may pass the entire Artisan command to the call
method as a string: Ableton live mac os x snow leopard.
Using the queue
method on the Artisan
facade, you may even queue Artisan commands so they are processed in the background by your queue workers. Before using this method, make sure you have configured your queue and are running a queue listener:
You may also specify the connection or queue the Artisan command should be dispatched to:
Passing Array Values
If your command defines an option that accepts an array, you may pass an array of values to that option:
Passing Boolean Values
If you need to specify the value of an option that does not accept string values, such as the --force
flag on the migrate:refresh
command, you should pass true
or false
:
Calling Commands From Other Commands
Sometimes you may wish to call other commands from an existing Artisan command. You may do so using the call
method. This call
method accepts the command name and an array of command parameters:
If you would like to call another console command and suppress all of its output, you may use the callSilent
method. The callSilent
method has the same signature as the call
method:
Stub Customization
Laravel 5.4 Tinker
The Artisan console's make
commands are used to create a variety of classes, such as controllers, jobs, migrations, and tests. These classes are generated using 'stub' files that are populated with values based on your input. However, you may sometimes wish to make small changes to files generated by Artisan. To accomplish this, you may use the stub:publish
command to publish the most common stubs for customization:
The published stubs will be located within a stubs
directory in the root of your application. Any changes you make to these stubs will be reflected when you generate their corresponding classes using Artisan make
commands.
Today we'll talk about how to use one of Laravel's lesser-known features to quickly read data from our Laravel applications. We can use Laravel artisan's built-in php artisan tinker
to mess around with your application and things in the database.
Laravel artisan's tinker is a repl (read-eval-print loop). A repl translates to read-eval-print-loop
, and it is an interactive language shell. It takes in a single user input, evaluates it, and returns the result to the user.
A quick and easy way to see the data in your database.
Table of Contents
Wouldn't it be nice to see the immediate output of commands like:
With php artisan tinker
, we can do the above pretty quickly. Tinker is Laravel's own repl, based on PsySH. It allows us to interact with our applications and stop dd()
ing and die()
ing all the time. A lot of us know the insanity that ensues when there are print_r()
s and dd()
s all over our code.
Before we tinker with our application, let us create a demo project. Let's call it ScotchTest. If you have the laravel installer installed on your computer, run this command.
For those without the Laravel installer on their computer, you can still use composer
to create a new Laravel project.
Database Setup: Running Migrations
After installing our demo Laravel project, we need to create a database and setup migrations. For this article we will be using the default Laravel migrations. So we configure our .env
file to point to the database you created for this test. The default migrations include creating a users
table and a password_resets
table.
From the root of the project, run
After migrating our database, we should see something similar to
Seeding our Database
Onyx Mac
By default, Laravel provides a model factory that we can use to seed our database. Now lets begin to tinker with our application.
From the root of the Laravel project, run the following command.
Laravel Tinker Tool Set
This command opens a repl
for interacting with your Laravel application. First let's migrate our database. While in the repl
, we can run our model factory and seed our database.
Laravel-web-tinker
A collection of ten new users should show up on your terminal. We can then check the database to see if the users were actually created.
To get the total number of users in our database, we can just call count
on the User
model.
After running AppUser::all()
and AppUser::count()
, mine looks like this. You should get something similar to mine only difference being the data generated.
Creating a New User
From the repl, we can create a new user. You should note that we interact with this repl
just like you would write code in your laravel application. So to create a new user, we would do
Php Artisan Tinker Log
Now we can type $user
to the repl
and get something like this.
Deleting a User
To delete a user, we can just do
Reading a Function/Class Documentation
With tinker, you can checkout a class or function documentation right from the repl
. But it depends on the class or function having DocBlocks
.
Calling doc
on dd
gives us this.
Checking Source
We can also check out a function or class source code while in the repl
using
For example, calling show
on dd
give us this.
Conclusion
Laravel Tinker is a tool that can help us easily interact with our application without having to spin up a local server. Think of a simple feature you want to test in a couple of lines you'd delete from your project, use tinker instead.
Like this article?Follow @KayandraJT on Twitter