PHP Interface Neomerx\JsonApi\Contracts\Encoder\Parameters\ParametersAnalyzerInterface

Show file Open project: neomerx/json-api Interface Usage Examples

Public Methods

Method	Description
getIncludeRelationships ( string $path, string $type ) : string[]	Get a list of relationship that should be included for $path of root type $type.
getParameters ( ) : EncodingParametersInterface	Get parameters.
hasSomeFields ( string $type ) : boolean	If field-sets allows any fields to be in output (field-set filter is not empty array).
isPathIncluded ( string $path, string $type ) : boolean	If path is included.

Method Details

getIncludeRelationships() public method

Get a list of relationship that should be included for $path of root type $type.

public getIncludeRelationships ( string $path, string $type ) : string[]
$path	string
$type	string
return	string[]

getParameters() public method

Get parameters.

public getParameters ( ) : EncodingParametersInterface
return	EncodingParametersInterface

hasSomeFields() public method

If field-sets allows any fields to be in output (field-set filter is not empty array).

public hasSomeFields ( string $type ) : boolean
$type	string
return	boolean

isPathIncluded() public method

If path is included.

public isPathIncluded ( string $path, string $type ) : boolean
$path	string
$type	string
return	boolean