Implement Snake Case Mapping for ViewModel Properties and Methods

[gjinali]

Hello Spatie team,

I use this package to serve data to InertiaJs pages, and it helps me structure and organize my page queries. However, I'd like to keep the component properties in snake case on the front end. Currently, this package does not support it.

I've implemented a solution that works and has test coverage. The solution is inspired by how laravel-data package maps class properties to snake case. Since this package still supports PHP 7, I couldn't use PHP Attributes, instead, a simpler solution is implemented.

Example:

class PageViewModel extends ViewModel
{
    protected $snakeCase = true;
    
    public $dummyProperty = 'abc';
    
    public function publishedPost(): stdClass
    {
        return (object) [
            'title' => 'title',
            'body' => 'body',
        ];
    }
}

the result for the array or response will be like this:

[
  "dummy_property" => "abc",
  "published_post" => [
       "title": "title",
       "body": "body"
  ]
]  

I hope you'll consider merging this feature. Thanks!

[freekmurze]

Thanks!