How to scope settings by user?

[csalmeida]

Hi, I am working on an application that makes use of Laravel Jetstream with teams and users and was looking for a way to scope a setting per user.

I have followed the setup instructions available in the documentation and although I am able to set and get settings, I can see the record on the table, it seems to keep track of the setting globally rather than on a per user basis.

I have added the HasSettings to the User model and I use the current user to get or set values with $request->user()->settings()->set('dark_mode', true).

Laravel is version 10.

The way I am using the package is similar to the following.

 // Set a setting for this user:
$request->user()->settings()->set('dark_mode', true);

// Get the setting value:
$request->user()->settings()->isTrue('dark_mode');

Any help would be much appreciated.

Here's some code that might be relevant:

Expand Tinker output

$u1->settings()->set('mysetting','hello');
= null

> $u2 = User::find(2);
= App\Models\User {#5225
    id: 2,
    name: "Ms. Carmella Jakubowski",
    email: "[email protected]",
    email_verified_at: "2024-02-20 18:14:11",
    #password: "$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi",
    #remember_token: "MqkIRRSYsc",
    current_team_id: null,
    profile_photo_path: null,
    created_at: "2024-02-20 18:14:11",
    updated_at: "2024-02-20 18:14:11",
    #two_factor_secret: null,
    #two_factor_recovery_codes: null,
    two_factor_confirmed_at: null,
    +profile_photo_url: "https://ui-avatars.com/api/?name=M+C+J&color=7F9CF5&background=EBF4FF",
  }

> $u2->settings()->set('mysetting','what');
= null

> $u1->settings()->get('mysetting');
= "what"

> $u2->settings()->get('mysetting');
= "what"

> $userContext = new Context(['user_id' => 1]);
r2Context = new Context(['user_id' => 2]);
   Error  Class "Context" not found.

> use Rawilk\Settings\Support\Context;
> $userContext = new Context(['user_id' => 1]);
= Rawilk\Settings\Support\Context {#6255}

> $user2Context = new Context(['user_id' => 2]);
= Rawilk\Settings\Support\Context {#6224}

> $u1->settings()->context($user1Context)->set('mysetting', 'user one');

   WARNING  Undefined variable $user1Context.

= null

> $u1->settings()->context($userContext)->set('mysetting', 'user one');
= null

> $u2->settings()->context($user2Context)->set('mysetting', 'user two');
= null

> $u2->settings()->get('mysetting');
= "what"

> $u2->settings()->context($user2Context)->get('mysetting');
= "user two"

> $u1->settings()->context($userContext)->get('mysetting');
= "user two"

Expand User model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Fortify\TwoFactorAuthenticatable;
use Laravel\Jetstream\HasProfilePhoto;
use Laravel\Jetstream\HasTeams;
use Laravel\Sanctum\HasApiTokens;
use Rawilk\Settings\Models\HasSettings;

class User extends Authenticatable
{
    use HasApiTokens;
    use HasFactory;
    use HasProfilePhoto;
    use HasSettings;
    use HasTeams;
    use Notifiable;
    use TwoFactorAuthenticatable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array<int, string>
     */
    protected $hidden = [
        'password',
        'remember_token',
        'two_factor_recovery_codes',
        'two_factor_secret',
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

    /**
     * The accessors to append to the model's array form.
     *
     * @var array<int, string>
     */
    protected $appends = [
        'profile_photo_url',
    ];
}

Expand settings.php

declare(strict_types=1);

return [
    /*
    |--------------------------------------------------------------------------
    | Settings Table
    |--------------------------------------------------------------------------
    |
    | Database table used to store settings in.
    |
    */
    'table' => 'settings',

    /*
    |--------------------------------------------------------------------------
    | Caching
    |--------------------------------------------------------------------------
    |
    | If enabled, all settings are cached after accessing them.
    |
    */
    'cache' => true,

    /*
    |--------------------------------------------------------------------------
    | Cache Key Prefix
    |--------------------------------------------------------------------------
    |
    | Specify a prefix to prepend to any setting key being cached.
    |
    */
    'cache_key_prefix' => 'settings.',

    /*
    |--------------------------------------------------------------------------
    | Encryption
    |--------------------------------------------------------------------------
    |
    | If enabled, all values are encrypted and decrypted.
    |
    */
    'encryption' => true,

    /*
    |--------------------------------------------------------------------------
    | Driver
    |--------------------------------------------------------------------------
    |
    | The driver to use to store and retrieve settings from. You are free
    | to add more drivers in the `drivers` configuration below.
    |
    */
    'driver' => env('SETTINGS_DRIVER', 'eloquent'),

    /*
    |--------------------------------------------------------------------------
    | Drivers
    |--------------------------------------------------------------------------
    |
    | Here you may configure the driver information for each repository that
    | is used by your application. A default configuration has been added
    | for each back-end shipped with this package. You are free to add more.
    |
    | Each driver you add must implement the \Rawilk\Settings\Contracts\Driver interface.
    |
    */
    'drivers' => [
        'database' => [
            'driver' => 'database',
            'connection' => env('DB_CONNECTION', 'mysql'),
        ],
        'eloquent' => [
            'driver' => 'eloquent',

            /*
             * You can use any model you like for the setting, but it needs to implement
             * the \Rawilk\Settings\Contracts\Setting interface.
             */
            'model' => \Rawilk\Settings\Models\Setting::class,
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Teams
    |--------------------------------------------------------------------------
    |
    | When set to true the package implements teams using the `team_foreign_key`.
    |
    | If you want the migrations to register the `team_foreign_key`, you must
    | set this to true before running the migration.
    |
    | If you already ran the migrations, then you must make a new migration to
    | add the `team_foreign_key` column to the settings table, and update the
    | unique constraint on the table. See the `add_settings_team_field` migration
    | for how to do this.
    |
    */
    'teams' => false,

    /*
    |--------------------------------------------------------------------------
    | Team Foreign Key
    |--------------------------------------------------------------------------
    |
    | When teams is set to true, our database/eloquent drivers will use this
    | column as a team foreign key to scope queries to.
    |
    | The team id will also be included in a cache key when caching is enabled.
    |
    */
    'team_foreign_key' => 'team_id',

    /*
    |--------------------------------------------------------------------------
    | Context Serializer
    |--------------------------------------------------------------------------
    |
    | The context serializer is responsible for converting a Context object
    | into a string, which gets appended to a setting key in the database.
    |
    | Any custom serializer you use must implement the
    | \Rawilk\Settings\Contracts\ContextSerializer interface.
    |
    | Supported:
    | - \Rawilk\Settings\Support\ContextSerializers\ContextSerializer (default)
    | - \Rawilk\Settings\Support\ContextSerializers\DotNotationContextSerializer
    |
    */
    'context_serializer' => \Rawilk\Settings\Support\ContextSerializers\ContextSerializer::class,

    /*
    |--------------------------------------------------------------------------
    | Key Generator
    |--------------------------------------------------------------------------
    |
    | The key generator is responsible for generating a suitable key for a
    | setting.
    |
    | Any custom key generator you use must implement the
    | \Rawilk\Settings\Contracts\KeyGenerator interface.
    |
    | Supported:
    | - \Rawilk\Settings\Support\KeyGenerators\ReadableKeyGenerator
    | - \Rawilk\Settings\Support\KeyGenerators\Md5KeyGenerator (default)
    |
    */
    'key_generator' => \Rawilk\Settings\Support\KeyGenerators\ReadableKeyGenerator::class,

    /*
    |--------------------------------------------------------------------------
    | Value Serializer
    |--------------------------------------------------------------------------
    |
    | By default, we use php's serialize() and unserialize() functions to
    | prepare the setting values for storage. You may use the `JsonValueSerializer`
    | instead if you want to store the values as json instead.
    |
    | Any custom value serializer you use must implement the
    | \Rawilk\Settings\Contracts\ValueSerializer interface.
    |
    */
    'value_serializer' => \Rawilk\Settings\Support\ValueSerializers\ValueSerializer::class,

    /*
    |--------------------------------------------------------------------------
    | Cache Default Value
    |--------------------------------------------------------------------------
    |
    | When a setting is not persisted, we will cache the passed in default value
    | if this is set to true. This may not always be desirable, so you can
    | disable it here if needed.
    |
    */
    'cache_default_value' => true,

    /*
    |--------------------------------------------------------------------------
    | Unserialize Safelist
    |--------------------------------------------------------------------------
    |
    | When using the default value serializer class from this package, we
    | will only unserialize objects that have their classes safelisted here.
    | Any other objects will be unserialized to something like:
    | __PHP_Incomplete_Class(App\Models\User) {...}
    |
    | To prevent any objects from being unserialized, simply set this to
    | an empty array.
    */
    'unserialize_safelist' => [
        \Carbon\Carbon::class,
        \Carbon\CarbonImmutable::class,
        \Illuminate\Support\Carbon::class,
    ],
];

[rawilk]

Are you sure the context is being serialized correctly in the settings table?

[csalmeida]

Thanks for getting back to me.

Not sure what you mean exactly, could you expand on that please?

If the context is set programmatically in PHP, there's one example of one of my attempts to set it in the Tinker output above.

[rawilk]

Sorry, I meant if you look in the settings table, do you see a serialized context object appended to the key of your setting?