A Package for Onboarding Users in Laravel Apps

 Laravel Onboard is a Laravel package to help track user onboarding steps created by Spatie:

Here's a quick example taken from the project readme on using this package to create onboarding steps:

use App\User;
use Spatie\Onboard\Facades\Onboard;
 
// You can add onboarding steps in a `boot()` method within a service provider
Onboard::addStep('Complete Profile')
    ->link('/profile')
    ->cta('Complete')
    ->completeIf(function (User $user) {
        return $user->profile->isComplete();
    });
 
Onboard::addStep('Create Your First Post')
    ->link('/post/create')
    ->cta('Create Post')
    ->completeIf(function (User $user) {
        return $user->posts->count() > 0;
    });

To get a user's onboarding status—among other things—the package has a nice API for accessing things like percentage complete, in progress, finished, and details about individual steps:

/** @var \Spatie\Onboard\OnboardingManager $onboarding **/
$onboarding = Auth::user()->onboarding();
 
$onboarding->inProgress();
 
$onboarding->percentageCompleted();
 
$onboarding->finished();
 
$onboarding->steps()->each(function($step) {
    $step->title;
    $step->cta;
    $step->link;
    $step->complete();
    $step->incomplete();
});

Additionally, this package supports features such as:

• Conditionally excluding steps with custom logic
• Defining custom attributes on a step
• Use middleware to ensure a user completes onboarding before they are allowed to use certain features
• And more

You can get started with this package by checking it out on GitHub at spatie/laravel-onboard. Their blog post can also give you some examples and further details on how you can use this package.

Read More

Add Comments to Correlate User Code with SQL Queries in Laravel

Laravel SQL Commenter is a package by Spatie to add comments to SQL queries made by Laravel. It uses sqlcommenter to augment SQL statements about the code:

/* typical query */
select * from users
 
/* comments added by this package */
select * from "users"/*controller='UsersController',action='index'*/;

Once this package is installed, SQL comments get automatically included, and you can control what things are added to the comments and disable comments dynamically.

use Spatie\SqlCommenter\SqlCommenter;
 
SqlCommenter::addComment('foo', 'bar');
 
// select * from "users"/*foo='bar'*/;

This package has the concept of a "commenter" class, which add useful information to queries, such as the controller and route information. Out of the box, this package includes the following commenters:

• ControllerCommenter
• RouteCommenter,
• JobCommenter
• FileCommenter
• CurrentUserCommenter

You can also add custom commenter classes using the provided Commenter interface from this package.

You can learn about this package, get full installation instructions, and view the source code on GitHub. The author, Freek Van der Herten, wrote a post titled Add comments to SQL queries made by Laravel if you'd like to dive deeper into the background of this package.

Read More