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

Namespaces

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

Classes

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

Class GET

GET related methods

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

Direct known subclasses

Phramework\JSONAPI\Controller\POST

Indirect known subclasses

Phramework\JSONAPI\Controller, Phramework\JSONAPI\Controller\DELETE, Phramework\JSONAPI\Controller\PATCH

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

Methods summary

protected static boolean
# handleGET( object $parameters, string $modelClass, array $primaryDataParameters = [], array $relationshipParameters = [] , boolean $filterable,…, boolean $filterableJSON,…, boolean $sortable,… )

handles GET requests

handles GET requests

Parameters

$parameters
Request parameters
$modelClass

Resource's primary model class name 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

$filterable,…

[Optional] Default is true, if true allows filter URI parameters to be parsed for filtering

$filterableJSON,…

[Optional] Default is false, if true allows filter URI parameters to be parsed for filtering for JSON encoded fields

$sortable,…

[Optional] Default is true, if true allows sorting

Returns

boolean

Throws

Exception
Phramework\Exceptions\RequestException

Uses

$modelClass::get method to fetch resource collection

Todo

Force parsing of relationship data when included

Methods inherited from Phramework\JSONAPI\Controller\GETById

handleGETByid()

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