|Maintainer Contact:||email@example.com (Freek Van der Herten)|
|Package Create Date:||2017-05-21|
|Package Last Update:||2020-06-26|
|Last Refreshed:||2020-08-02 03:06:12|
|Total Open Issues:||0|
The functionality of this package is built into Laravel 5.5 and above, only install this in older Laravel versions
When using Artisan's Tinker command it can be quite bothersome having to type the fully qualified classname to do something simple.
This package contains a class that, when fully installed let's you use the short class names:
First install the package via Composer:
composer require spatie/laravel-tinker-tools
Next, create a file named
.psysh.php in the root of your Laravel app with this content:
Finally, dump the optimized version of the autoloader so
autoload_classmap.php gets created:
composer dump-autoload -o
Open up a Tinker session with:
php artisan tinker
Inside that Tinker session you can now use short class names:
When you use a class that hasn't been loaded in yet, PHP will call the registered autoloader functions. Such autoloader functions are responsible for loading up the requested class. In a typical project Composer will register an autoloader function that can
include the file where the class is stored in.
Composer has a few ways to locate the right files. In most cases it will convert the fully qualified class name to a path. For example, when using a class
App\Models\NewsItem Composer will load the file in
app/Models/NewsItem.php. It's a bit more complicated behind the scenes but that's the gist of it. To make the process of finding a class fast, Composer caches all the fully qualified classnames and their paths in the generated
autoload_classmap.php, which can be found in
Now, to make this package work,
\Spatie\TinkerTools\ShortClassNames will read Composer's
autoload_classmap.php and convert the fully qualified class names to short class names. The result is a collection that's being kept in the
Our class will also register an autoloader. When you use
NewsItem in your code. PHP will first call Composer's autoloader. But of course that autoloader can't find the class. So the autoloader from this package comes next. Our autoloader will use the aforementioned
$classes collection to find to fully qualified class name. It will then use
class_alias to alias
Now you might wonder what'll happen it there are more classes with the same name in different namespaces? E.g.
autoload_classmap.php is sorted alphabetically on the fully qualified namespace. So
App\Models\NewsItem will be used and not
App starts with an "A" there's a high chance that, in case of a collision, a class inside your application will get picked. Currently there are no ways to alter this. I'd accept PRs that make this behaviour customizable.
There are a lot of other options that can be set in
tinker.config.php. Learn all the options by reading the official psysh configuration documentation.
Please see CHANGELOG for more information what has changed recently.
$ composer test
Please see CONTRIBUTING for details.
If you discover any security related issues, please email firstname.lastname@example.org instead of using the issue tracker.
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
The MIT License (MIT). Please see License File for more information.