Overview
  • Namespace
  • Class

Namespaces

  • OneOfZero
    • Json
      • Annotations
      • ContractResolvers
      • Converters
      • Enums
      • Exceptions
      • Helpers
      • Mappers
        • AbstractArray
        • Annotation
        • Anonymous
        • Caching
        • Contract
        • File
        • Null
        • Reflection
      • Nodes
      • Visitors

Classes

  • AbstractContractResolver
  • PropertyNameContractResolver

Interfaces

  • ContractResolverInterface

Interface ContractResolverInterface

Defines the interface for a contract resolver.

A contract resolver allows you to overlay your own mapper over the pipeline for each node visited by the serializer and deserializer. While setting up your own mapper may sound complicated, there are the ContractObjectMapper and ContractMemberMapper classes that allow you to handset the mapper values without needing to write your own mappers.

For an example contract resolver see the PropertyNameContractResolver class.

Direct known implementers

OneOfZero\Json\ContractResolvers\AbstractContractResolver

Indirect known implementers

OneOfZero\Json\ContractResolvers\PropertyNameContractResolver

Namespace: OneOfZero\Json\ContractResolvers
Located at ContractResolvers/ContractResolverInterface.php

Methods summary

public OneOfZero\Json\Mappers\ObjectMapperInterface|OneOfZero\Json\Mappers\Contract\ContractObjectMapper|null
# createSerializingObjectContract( OneOfZero\Json\Nodes\AbstractObjectNode $object )

Should return a mapper for the provided object node.

Should return a mapper for the provided object node.

Parameters

$object

Returns

OneOfZero\Json\Mappers\ObjectMapperInterface|OneOfZero\Json\Mappers\Contract\ContractObjectMapper|null
public OneOfZero\Json\Mappers\ObjectMapperInterface|OneOfZero\Json\Mappers\Contract\ContractObjectMapper|null
# createDeserializingObjectContract( OneOfZero\Json\Nodes\AbstractObjectNode $object )

Should return a mapper for the provided object node.

Should return a mapper for the provided object node.

Parameters

$object

Returns

OneOfZero\Json\Mappers\ObjectMapperInterface|OneOfZero\Json\Mappers\Contract\ContractObjectMapper|null
public OneOfZero\Json\Mappers\MemberMapperInterface|OneOfZero\Json\Mappers\Contract\ContractMemberMapper|null
# createSerializingMemberContract( OneOfZero\Json\Nodes\MemberNode $member )

Should return a mapper for the provided member node.

Should return a mapper for the provided member node.

Parameters

$member

Returns

OneOfZero\Json\Mappers\MemberMapperInterface|OneOfZero\Json\Mappers\Contract\ContractMemberMapper|null
public OneOfZero\Json\Mappers\MemberMapperInterface|OneOfZero\Json\Mappers\Contract\ContractMemberMapper|null
# createDeserializingMemberContract( OneOfZero\Json\Nodes\MemberNode $member )

Should return a mapper for the provided member node.

Should return a mapper for the provided member node.

Parameters

$member

Returns

OneOfZero\Json\Mappers\MemberMapperInterface|OneOfZero\Json\Mappers\Contract\ContractMemberMapper|null
API documentation generated by ApiGen