This is the documentation for v2. You can switch versions in the menu on the left/at the top. Check your current version with the following command:


                                composer show spatie/laravel-model-states

State scopes

Name: Spatie
Address: Kruikstraat 22 bus 12, Antwerp, Antwerp, 2060, Belgium
Telephone: +32 3 292 56 79

Every model using the HasStates trait will have these scopes available:

whereState($column, $states) and orWhereState($column, $states)
whereNotState($column, $states) and orWhereNotState($column, $states)

$payments = Payment::whereState('state', Paid::class);
$payments = Payment::whereState('state', [Pending::class, Paid::class]);
$payments = Payment::whereState('state', Pending::class)->orWhereState('state', Paid::class);

$payments = Payment::whereNotState('state', Pending::class);
$payments = Payment::whereNotState('state', [Failed::class, Canceled::class]);
$payments = Payment::whereNotState('state', Failed::class)->orWhereNotState('state', Canceled::class);

When the state field has another column name in the query (for example due to a join), it is possible to use the full column name:

$payments = Payment::whereState('payments.state', Paid::class);

$payments = Payment::whereNotState('payments.state', Pending::class);