phramework/jsonapi doc
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • Phramework
    • JSONAPI
      • Controller
        • POST
      • Model
      • Viewers

Classes

  • Base
  • DELETE
  • GET
  • GETById
  • PATCH
  • POST
  • Relationships

Class GETById

GETById related methods

Phramework\JSONAPI\Controller\Base
Extended by Phramework\JSONAPI\Controller\Relationships
Extended by Phramework\JSONAPI\Controller\GETById

Direct known subclasses

Phramework\JSONAPI\Controller\GET

Indirect known subclasses

Phramework\JSONAPI\Controller, Phramework\JSONAPI\Controller\DELETE, 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/GETById.php

Methods summary

protected static boolean
# handleGETByid( object $parameters, integer|string $id, string $modelClass, array $primaryDataParameters = [], array $relationshipParameters = [] )

handles GETById requests

handles GETById requests

Parameters

$parameters
Request parameters
$id
Requested resource's id
$modelClass

Resource's primary model to be used

$primaryDataParameters

[Optional] Array with any additional arguments that the primary data is requiring

$relationshipParameters

[Optional] Array with any additional argument primary data's relationships are requiring

Returns

boolean

Uses

model's getById method to fetch resource

Todo

Force parsing of relationship data when included

Methods inherited from Phramework\JSONAPI\Controller\Relationships

handleByIdRelationships()

Methods inherited from Phramework\JSONAPI\Controller\Base

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

phramework/jsonapi doc API documentation generated by ApiGen