AbstractSerializeController
abstract class AbstractSerializeController implements RequestHandlerInterface
Properties
| string | $serializer | <p>The name of the serializer class to output results with.</p> |
|
|
| array | $include | <p>The relationships that are included by default.</p> |
|
|
| array | $optionalInclude | <p>The relationships that are available to be included.</p> |
|
|
| int | $maxLimit | <p>The maximum number of records that can be requested.</p> |
|
|
| int | $limit | <p>The number of records included by default.</p> |
|
|
| array | $sortFields | <p>The fields that are available to be sorted by.</p> |
|
|
| array|null | $sort | <p>The default sort field and order to user.</p> |
|
|
| static protected Container | $container |
|
||
| static protected array | $beforeDataCallbacks |
|
||
| static protected array | $beforeSerializationCallbacks |
|
||
| static protected string[][] | $loadRelations |
|
||
| static protected array<string,callable> | $loadRelationCallables |
|
Methods
<p>Get the data to be serialized and assigned to the response document.</p>
<p>Create a PHP JSON-API Element for output in the document.</p>
<p>Returns the relations to load added by extenders.</p>
<p>Returns the relation callables to load added by extenders.</p>
<p>Eager loads the required relationships.</p>
<p>Set the serializer that will serialize data for the endpoint.</p>
No description
Details
at
line 104
ResponseInterface
handle(ServerRequestInterface $request)
<p>{@inheritdoc}</p>
at
line 149
abstract protected mixed
data(ServerRequestInterface $request, Document $document)
<p>Get the data to be serialized and assigned to the response document.</p>
at
line 158
abstract protected ElementInterface
createElement(mixed $data, SerializerInterface $serializer)
<p>Create a PHP JSON-API Element for output in the document.</p>
at
line 165
protected array
getRelationsToLoad(Collection $models)
<p>Returns the relations to load added by extenders.</p>
at
line 183
protected array
getRelationCallablesToLoad(Collection $models)
<p>Returns the relation callables to load added by extenders.</p>
at
line 199
protected void
loadRelations(Collection $models, array $relations, ServerRequestInterface $request = null)
<p>Eager loads the required relationships.</p>
at
line 259
protected array
extractInclude(ServerRequestInterface $request)
at
line 270
protected array
extractFields(ServerRequestInterface $request)
at
line 280
protected array|null
extractSort(ServerRequestInterface $request)
at
line 290
protected int
extractOffset(ServerRequestInterface $request)
at
line 299
protected int
extractLimit(ServerRequestInterface $request)
at
line 308
protected array
extractFilter(ServerRequestInterface $request)
at
line 317
protected Parameters
buildParameters(ServerRequestInterface $request)
at
line 322
protected bool
sortIsDefault(ServerRequestInterface $request)
at
line 332
setSerializer(string $serializer)
<p>Set the serializer that will serialize data for the endpoint.</p>
at
line 342
addInclude(string|array $name)
<p>Include the given relationship by default.</p>
at
line 352
removeInclude(string|array $name)
<p>Don't include the given relationship by default.</p>
at
line 362
addOptionalInclude(string|array $name)
<p>Make the given relationship available for inclusion.</p>
at
line 372
removeOptionalInclude(string|array $name)
<p>Don't allow the given relationship to be included.</p>
at
line 382
setLimit(int $limit)
<p>Set the default number of results.</p>
at
line 392
setMaxLimit(int $max)
<p>Set the maximum number of results.</p>
at
line 402
addSortField(string|array $field)
<p>Allow sorting results by the given field.</p>
at
line 412
removeSortField(string|array $field)
<p>Disallow sorting results by the given field.</p>
at
line 422
setSort(array $sort)
<p>Set the default sort order for the results.</p>