addSelect / selectRaw override 'select *'

[scibuff]

• Laravel Version: 8.19.0
• PHP Version: 7.4.11
• Database Driver & Version: mysql 8.0.21-0ubuntu0.20.04.4 for Linux on x86_64 ((Ubuntu))

Description:

When I try to add a custom column to my queries with addSelect or selectRaw only the specified column is returned if
$builder->columns is null

Steps To Reproduce:

class Product extends Model 
{
    protected $fillable = ['name', 'cost', 'shipping'];

    protected static function boot()
    {
        parent::boot();

        static::addGlobalScope('total', function(Builder $builder)
        {            
            $builder->addSelect( DB::Raw('cost + shipping AS total') );
//            $builder->selectRaw( 'cost + shipping AS total' ); // same result as the above
        }
    }
}

...
    dump( Product::all()->toArray() );

>>>
array:1 [
  0 => array:1 [
    "total" => "10"
  ]
]

Exptected:

...
    dump( Product::all()->toArray() );

>>>
array:1 [
  0 => array:1 [
    "id" => "1" 
    "cost" => "9.5"
    "shipping" => "0.5"
    "total" => "10"
  ]
]

Looking at the Builder->addSelect I see I need to do $builder->select( $builder->from.'.*' ); in my addGlobalScope closure, but this should be either specified in the docs (currently it says to use addSelect)

If your global scope is adding columns to the select clause of the query, you should use the addSelect method instead of select. This will prevent the unintentional replacement of the query's existing select clause.

or the addSelect should do it for non 'queryable` columns as well

[veelasky]

why not using get attribute accessor ?!

EDIT: let me elaborate

class Product 
{
    public function getTotalAttribute()
    {
         return $this->cost + $this->total;
    }
}

if you want to add to every array representation:

class Product 
{
    protected $appends = [ 'total' ];

    // .... the rest
}

[scibuff]

Thank you, I am aware of the accessors and append option in the Model. However, the point of adding the select statement is the ability to then use the calculated column in a query (e.g. get the cheapet/most expensive products), which is not possible with appended model attributes.

The example I posted is a simple one but there certainly are more complicated calculations one may need to use for orderBy

[BrandonSurowiec]

@scibuff In a scope you can do this:

function scopeWithTotal($query) {

    if (is_null($query->getQuery()->columns)) {
        $query->select($this->qualifyColumn('*'));
    }

    $query->addSelect(DB::raw('cost + shipping AS total'));
}

Then:

        static::addGlobalScope('total', function(Builder $builder) {            
            $builder->withTotal();
        }

Or you can just be explicit about calling withTotal() in whatever queries need it. I do find when combining a bunch of dynamic select queries like this, sometimes the order matters, but I don't think you'll run into that here.

[scibuff]

Thank you! That is exactly what I am doing, but my point is that if I use query->addSelect I shouldnt need to add $query->select('*') as the addSelect is not supposed to overwrite the current/default select (which is to select *). The documentation specifically states this, but it is not the implemented behavior.

[BrandonSurowiec]

Agree, but it seems it is here to stay at the moment:
#29588
#24436

Maybe it is something that could get merged into 9.x as it would be a breaking change, but I don't know if Taylor has changed his stance on this.

[Edit: Especially considering this was originally an "issue", which Taylor locked and moved to a discussion.]

[vHeemstra]

I agree this is (years later) still weird behaviour. Even if it is a breaking change, it should be fixed.

The addSelect method now has very inconsistent handling:

• If you addSelect() using an associative array (so selecting using aliases), the table.* IS added before added your new select.

framework/src/Illuminate/Database/Query/Builder.php

Lines 417 to 421 in 5a7f2b4

	if (is_null($this->columns)) {
	$this->select($this->from.'.*');
	}
	$this->selectSub($column, $as);

• If you addSelect() using string or numerical array, the table.* IS NOT added (thus losing the all columns selector).

framework/src/Illuminate/Database/Query/Builder.php

Line 427 in 5a7f2b4

$this->columns[] = $column;

[RichardStyles]

Some further notes, as I was looking to add a scope which adds a column ad-hoc, that relies on a sub query.

It seems the issue is arisen from the $this->isQueryable($column) check.

framework/src/Illuminate/Database/Query/Builder.php

Line 416 in 5050195

if (is_string($as) && $this->isQueryable($column)) {

Added that DB::raw(...) is not regarded as querable.

framework/src/Illuminate/Database/Query/Builder.php

Lines 3995 to 4001 in 5050195

	protected function isQueryable($value)
	{
	return $value instanceof self ||
	$value instanceof EloquentBuilder ||
	$value instanceof Relation ||
	$value instanceof Closure;
	}

[RomainMazB]

Still a thing in 2025, here is how I personally tackled this:

public function scopeWithIsLiked(Builder $query): Builder
{
    $subQuery = /* Useless for the example */;

    // Avoid to override current query columns select
    $selects = $query->getSelect() ?? ['*'];
    array_push($selects, DB::raw("exists($subQuery) as is_liked"));

    return $query->select($selects);
}