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

Namespaces

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

Classes

  • Controller
  • Fields
  • Filter
  • FilterAttribute
  • FilterJSONAttribute
  • Model
  • Page
  • Relationship
  • RelationshipResource
  • Resource
  • Sort
  • Util
  • ValidationModel

Class FilterAttribute

Fields helper methods

Direct known subclasses

Phramework\JSONAPI\FilterJSONAttribute

Namespace: Phramework\JSONAPI
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Since: 1.0.0
Located at FilterAttribute.php

Methods summary

public
# __construct( string $attribute, string $operator, mixed|null $operand = null )

FilterAttribute constructor.

FilterAttribute constructor.

Parameters

$attribute
$operator
$operand
public static FilterAttributes[]|Phramework\JSONAPI\FilterJSONAttribute[]
# parse( string $filterKey, string|string[] $filterValue )

Parameters

$filterKey
$filterValue

Returns

FilterAttributes[]|Phramework\JSONAPI\FilterJSONAttribute[]

Throws

Phramework\Exceptions\RequestException
public mixed
# __get( string $name )

Parameters

$name

Returns

mixed

Throws

Exception

Constants summary

string JSON_ATTRIBUTE_PROPERTY_KEY_EXPRESSION
# '/^[a-zA-Z_\-0-9]{1,32}$/'

Properties summary

protected string $attribute
#
protected string $operator
#
protected mixed|null $operand
#

Magic properties

public read-only string $attribute
public read-only string $operator
public read-only mixed|null $operand
phramework/jsonapi doc API documentation generated by ApiGen