Query or ContextSerializer should be aware of "\"

[756D61]

Laravel Settings

3.4

Laravel Version

11

Bug description

The query should escape the slashes in the context values. I'm passing a class name as value in a Context, which works in saving, but during retrieval it returns empty because it contains slashes. The following is an example query made by this library, which doesn't work because the SQL parameter for LIKE contains slashes

select `value` from `settings` where `key` = ? and `settings`.`team_id` is null limit 1 ["settings:c:::parameterizable_type:App\Models\IpHasPort"]

For now, as workaround I wrote my ContextSerializer by replacing \ with dot. I hope there is more robust solution that handles all special SQL characters. I believe it is better to handle it at the query level by escaping .

<?php

namespace App\Serializers;

use Illuminate\Support\Str;
use Rawilk\Settings\Contracts\ContextSerializer;
use Rawilk\Settings\Support\Context;

class SettingsContextSerializer implements ContextSerializer
{
    public function serialize(?Context $context = null): string
    {
        if (is_null($context)) {
            return '';
        }

        return collect($context->toArray())
            ->map(function ($value, string $key) {
                // Use the model's morph class when possible.
                $value = match ($key) {
                    'model' => rescue(fn() => app($value)->getMorphClass(), $value),

                    // CHANGED THIS
                    default => Str::of($value)->replace("\\", ".")->toString(),


                };

                if ($value === false) {
                    $value = 0;
                }

                return "{$key}:{$value}";
            })
            ->implode('::');
    }
}

Steps to reproduce

No response

Relevant log output

[rawilk]

I personally use a morph map for all my models, so I haven't run into that issue myself. I think it's definitely worth while looking into and modifying the package code to handle this, however I'm not sure when I'll get a chance to do that.

Feel free to PR a solution if I haven't addressed it yet in the mean time.

[756D61]

Just to understand better, morph map is only for polymorphic relationship right? If I have a simple BelongsTo or a simple HasMany, the map would not work, is my understanding correct?

For the PR, I'm also tight with time, but I will make pull request if I can modify the code.

[rawilk]

You can use the morph map for all models. I personally always set up a project like this:

Relation::enforceMorphMap([
    'user' => User::class,
    // ...
]);

I mostly do this so I'm not storing model namespaces in the database, just in case my directory structure changes at some point. While this is mostly meant for polymorphic relationships, I use that same morph class for generating setting keys with.

You won't notice a difference on your normal relationships with models you map out like this in a service provider, but in places that use that morph class, like this package, it'll be available to them.