Declaration of Column::data does not compatible with Fluent::data

[alberto-morais-oliveira-f]

Summary of problem or feature request

Error

Declaration of Yajra\DataTables\Html\Column::data(array|string $value): static must be compatible with Illuminate\Support\Fluent::data($key = null, $default = null)

Code snippet of problem

File vendor/yajra/laravel-datatables-html/src/Html/Column.php, function data (line 305 - 310) was the reason:

public function data(array|string $value): static
{
     $this->attributes['data'] = $value;

     return $this;
}

System details

Operating System: Linux Debian 12
PHP Version: 8.3
Laravel Version: laravel/framework ^11.34
Laravel-Datatables Version: yajra/laravel-datatables ^11.0

Solution

File vendor/yajra/laravel-datatables-html/src/Html/Column.php, change function data (line 305 - 310) to:

public function data($key = null, $default = null): static
{
    $this->attributes['data'] = $key;

    return $this;
}

[vipertecpro]

@yajra Can you please quickly look into this, this looks like very recently occurred. Here

https://github.com/laravel/framework/blame/11.x/src/Illuminate/Support/Fluent.php#L116

18 hours ago

Please help us asap

[eunir]

Please help us asap

[yajra]

The issue was due to a recent update in the Fluent class via laravel/framework#53665.

We will have to wait for it to be reverted or not before we make changes.

[stevebauman]

@yajra This can be fixed by simply making the definition compatible and overriding the visibility:

class Column extends Fluent
{
    // ...

    public function data(mixed $value, mixed $default = null): static
    {
        $this->attributes['data'] = $value;

        return $this;
    }
}

[yajra]

@stevebauman Yes, it is the quickest solution as discussed in yajra/laravel-datatables#3201. But some devs might not like that idea.

[wmt-web-pruthvip]

For some releases, what if we stick with the current approach but add a deprecation warning?

/**
    * @deprecated 11.7.0 Use `setData` instead to set column data.
    *
    * Get data from the fluent instance.
    *
    * @param  array|string  $key
    * @return mixed
    */
public function data($key = null, $default = null)
{
    // Trigger a deprecation warning when this method is called
    trigger_error('The data() method is deprecated. Use setData() instead.', E_USER_DEPRECATED);

    return $this->setData($key);
}

/**
    * Set column data option value.
    *
    * @return $this
    *
    * @see https://datatables.net/reference/option/columns.data
    * @see https://datatables.net/manual/data/orthogonal-data
    */
public function setData(array|string $value): static
{
    $this->attributes['data'] = $value;

    return $this;
}

[yajra]

I designed the Column builder to match the datatables.net (https://datatables.net/reference/option/columns) option. This way, it is easier to match and just call a magic method to set the desired options when looking at the official JS docs.

So it's a NO for me to go with deprecation. Thanks!

[wmt-web-pruthvip]

You have been managing this great package for a long time, so you have a better understanding of its usability. I have one short of suggestions that, We can remove the deprecation notice and use PHP DOC to notify the user about the logic update. However, we can make a new method that the user can directly use, like setData. And current, data method, which will redirect to parent if both arguments are provided. otherwise, it will be called setData internally.