IncludesBuilder
in package
implements
BuilderInterface
Builder for including relationships, sub-resources, or additional data in the response.
Tags
Table of Contents
Interfaces
Properties
- $includes : array<string|int, mixed>
Methods
- __construct() : void
- Builder for including relationships, sub-resources, or additional data in the response.
- build() : string
- Builds the query string parameters from the Builder.
- include() : self
- Add an include key to the builder.
Properties
$includes
public
array<string|int, mixed>
$includes
Methods
__construct()
Builder for including relationships, sub-resources, or additional data in the response.
public
__construct() : void
build()
Builds the query string parameters from the Builder.
public
build([string $resourceName = null ]) : string
Parameters
- $resourceName : string = null
-
The type of resource to generate the query string for. Eg. AccountingResource, ProjectsResource
Return values
string —The built query string
include()
Add an include key to the builder.
public
include(string $key) : self
Parameters
- $key : string
-
The key for the resource or data to include
Return values
self —The IncludesBuilder instance