Load nested relationships

[arthurkirkosa]

In order to be able to have nested relationships when getting data through the api, follow the below steps.

In our example we need to load CraftCodes with related BillingRates and for each BillingRate we need the BillingRateType

Setup

1. Eager load the type in the BillingRate model (Eloquent)

// BillingRate.php
    ...

    protected $with = [
        'billingRateType',
    ];

   ...

    public function billingRateType()
    {
        return $this->belongsTo(BillingRateType::class);
    }

   ...

2. Add the correct relations to BillingRateRepository (Restify)

// BillingRateRepository.php
    ...

    public static function related(): array
    {
        return [
            'billingRateType' => BelongsTo::make('billingRateType', BillingRateTypeRepository::class),
        ];
    }

   ...

3. Add the correct relations to CraftCodeRepository (Restify)

// CraftCodeRepository.php
    ....

    public static function related(): array
    {
        return [
            'billingRates' => MorphMany::make('billingRates', BillingRateRepository::class),
            'billingRatesType' => BelongsTo::make('billingRates.billingRatesType', BillingRateTypeRepository::class),
        ];
    }

    ...

Gab all craft codes with billing rates and rate types

GET 'api/restify/craft-codes?related=billingRates,billingRateType'

Output

{#9203
  +"meta": {#9045
    +"current_page": 1
    +"from": 1
    +"last_page": 1
    +"path": "https://abc.test/api/restify/craft-codes"
    +"per_page": 15
    +"to": 1
    +"total": 1
  }
  +"links": {#8871
    +"first": "https://abc.test/api/restify/craft-codes?page=1"
    +"last": "https://abc.test/api/restify/craft-codes?page=1"
    +"prev": null
    +"next": null
    +"filters": "/api/restify/craft-codes/filters"
  }
  +"data": array:1 [
    0 => {#9204
      +"id": "1"
      +"type": "craft_codes"
      +"attributes": {#9046
        +"id": 1
        +"updated_at": "2021-09-08T10:24:01.000000Z"
        +"code": "KR4T6K"
        +"description": "Nam voluptatibus eius autem facilis exercitationem."
        +"level": "f"
        +"billing_description": null
        +"trade": null
        +"classification": null
      }
      +"relationships": {#9386
        +"billingRates": array:1 [
          0 => {#8869
            +"id": "1"
            +"type": "billing_rates"
            +"attributes": {#8322
              +"id": 1
              +"updated_at": "2021-09-08T10:24:01.000000Z"
              +"billing_rate_type_id": 1
              +"source_id": 1
              +"source_type": "craft-code"
              +"type": "regular"
              +"rate": 312.569086
            }
            +"relationships": {#9049
              +"billingRateType": {#9047
                +"id": 1
                +"organization_id": 1
                +"company_id": 1
                +"title": "soluta"
                +"created_at": "2021-09-08T10:24:01.000000Z"
                +"updated_at": "2021-09-08T10:24:01.000000Z"
              }
            }
            +"meta": {#8876
              +"authorizedToShow": true
              +"authorizedToStore": true
              +"authorizedToUpdate": true
              +"authorizedToDelete": true
            }
          }
        ]
      }
      +"meta": {#3258
        +"authorizedToShow": true
        +"authorizedToStore": true
        +"authorizedToUpdate": true
        +"authorizedToDelete": true
      }
    }
  ]
}

[binaryk]

Great idea @arthurkirkosa !

Is the output here what you get now, or how you'd prefer to get it?

[arthurkirkosa]

What is currently returned by Restify.

[arthurkirkosa]

7.x+ implemented the feature