Scope relationship options

[emptynick]

This allows to use a local scope on the related model in a relationship.

Usage:
Create a scope, for example

public function scopeActive($query)
{
    return $query->where('active', 1);
}

and add to the relationship options:

{
    "scope": "active"
}

Supersedes #4760

[codecov]

Codecov Report

Merging #4851 into 1.4 will decrease coverage by 0.03%.
The diff coverage is 0.00%.

@@             Coverage Diff              @@
##                1.4    #4851      +/-   ##
============================================
- Coverage     60.37%   60.34%   -0.04%     
- Complexity     1370     1373       +3     
============================================
  Files           194      194              
  Lines          3990     3992       +2     
============================================
  Hits           2409     2409              
- Misses         1581     1583       +2     

Impacted Files	Coverage Δ	Complexity Δ
src/Http/Controllers/VoyagerBaseController.php	58.22% <0.00%> (-0.30%)	139.00 <0.00> (+3.00)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cfee641...8e049d1. Read the comment docs.

[pcorrick]

I'm getting the following error in laravel.log, when I click any dropdown BREAD field related to a relationship (Add or Edit). The field says "the results could not be loaded".

[2020-04-03 15:17:01] production.ERROR: Undefined property: stdClass::$scope {"userId":1,"exception":"[object] (ErrorException(code: 0): Undefined property: stdClass::$scope at [APPNAME]/vendor/tcg/voyager/src/Http/Controllers/VoyagerBaseController.php:860)

[emptynick]

Is $options an object in your case? Or just an empty string?

[pcorrick]

I'm pretty new to php/laravel, I think $options is a json formatted string, which in my case doesn't have a scope property (yet).

I commented out lines 860-862 in VoyagerBaseControler.php and I can see the dropdown contents again.

Then I uncommented those lines and put in a scope property (empty string) into the relationship properties, and I can see the dropdown contents for that relationship (but not any others).

Relationship details is now:
{
"display": {
"width": "4"
},
"scope": ""
}

[MrCrayon]

!empty($options)

should cover all cases without throwing an error, 0 is not used anyway.

[emptynick]

I think property_exists($options, 'scope') should work better.

[MrCrayon]

If we are sure $options is always an object

[MrCrayon]

https://github.com/emptynick/voyager/blob/8e049d196669e62002ae74391fb6b79624d44a67/src/Models/DataRow.php#L71

[emptynick]

Yes, there's an accessor in the datarow model decoding it.

[mjomble]

I also encountered this error just now.

A fix that worked for me was editing line 860 in VoyagerBaseController and changing

if ($options->scope && ...

to

if (isset($options->scope) && ...

[emptynick]

Fixed