Interface JsonApiSerializable

Interface for serializing JSON API objects.

Direct known implementers

BEdita\Core\Model\Entity\Annotation, BEdita\Core\Model\Entity\Application, BEdita\Core\Model\Entity\Role, BEdita\Core\Model\Entity\Tag, BEdita\Core\Model\Entity\Translation, BEdita\Core\Model\Entity\AsyncJob, BEdita\Core\Model\Entity\Category, BEdita\Core\Model\Entity\History, BEdita\Core\Model\Entity\ObjectCategory, BEdita\Core\Model\Entity\ObjectEntity, BEdita\Core\Model\Entity\Property, BEdita\Core\Model\Entity\PropertyType, BEdita\Core\Model\Entity\Relation

Indirect known implementers

BEdita\Core\Model\Entity\Link, BEdita\Core\Model\Entity\Location, BEdita\Core\Model\Entity\Profile, BEdita\Core\Model\Entity\Publication

Namespace: BEdita\Core\Utility
Since: 4.0.0
Located at Core/src/Utility/JsonApiSerializable.php

Methods summary

`public array`	# `jsonApiSerialize( integer $options = 0, array $fields = [] )` JSON API serializer. JSON API serializer. This method MUST return a resource object as per JSON API specifications. Parameters `$options` Options for serializing. Can be any combination of `JSONAPIOPT_*` constants. `$fields` Selected fields to view in `attributes` and `meta`, default empty => all fields are serialized Returns array
`public string`	# `routeNamePrefix( )` Get prefix used for `_name` in routing urls creation. Get prefix used for `_name` in routing urls creation. Returns string

Constants summary

`integer`	`JSONAPIOPT_EXCLUDE_ATTRIBUTES` Tell JSON API serializer to exclude `attributes` from resource. Tell JSON API serializer to exclude `attributes` from resource.	# `1`
`integer`	`JSONAPIOPT_EXCLUDE_META` Tell JSON API serializer to exclude `meta` from resource. Tell JSON API serializer to exclude `meta` from resource.	# `2`
`integer`	`JSONAPIOPT_EXCLUDE_LINKS` Tell JSON API serializer to exclude `links` from resource. Tell JSON API serializer to exclude `links` from resource.	# `4`
`integer`	`JSONAPIOPT_EXCLUDE_RELATIONSHIPS` Tell JSON API serializer to exclude `relationships` from resource. Tell JSON API serializer to exclude `relationships` from resource.	# `8`
`integer`	`JSONAPIOPT_BASIC` Tell JSON API serializer to exclude all (`attributes`, `meta`, `links`, `relationships`) from resource Tell JSON API serializer to exclude all (`attributes`, `meta`, `links`, `relationships`) from resource	# `15`