Class Relationships

Relationships related methods

Phramework\JSONAPI\Controller\Relationships

Direct known subclasses

Phramework\JSONAPI\Controller\GETById

Indirect known subclasses

Phramework\JSONAPI\Controller, Phramework\JSONAPI\Controller\DELETE, Phramework\JSONAPI\Controller\GET, Phramework\JSONAPI\Controller\PATCH, Phramework\JSONAPI\Controller\POST

Abstract
Namespace: Phramework\JSONAPI\Controller
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Since: 0.0.0
Located at Controller/Relationships.php

Methods summary

`protected static boolean`	# `handleByIdRelationships( object $parameters, string $method, array $headers, integer\|string $id, string $relationship, string $modelClass, string[] $allowedMethods, array $primaryDataParameters = [], array $relationshipParameters = [] )` Handle handleByIdRelationships requests Handle handleByIdRelationships requests Parameters `$parameters` Request parameters `$method` Request method `$headers` Request headers `$id` Resource's id `$relationship` Requested relationship key `$modelClass` Resource's primary model to be used `$allowedMethods` Allowed methods `$primaryDataParameters` [Optional] Array with any additional arguments that the primary data is requiring `$relationshipParameters` [Optional] Array with any additional arguments primary data's relationships are requiring Returns boolean Throws Phramework\Exceptions\IncorrectParametersException When request method is not allowed Uses model's `getById` method to fetch primary data resource

Methods inherited from Phramework\JSONAPI\Controller\Base

checkIfUnsupportedRequestWithId(), exists(), getRequestAttributes(), getRequestData(), getRequestInclude(), getRequestRelationships(), testUnknownError(), view(), viewData()

Namespaces

Classes

Class Relationships

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Throws

Uses

Methods inherited from Phramework\JSONAPI\Controller\Base