• 홈
• WoohooLabs
• Yin
• JsonApi
• Request
• RequestInterface

PHP 인터페이스 WoohooLabs\Yin\JsonApi\Request\RequestInterface

파일 보기 프로젝트 열기: woohoolabs/yin 0 사용 예제들

공개 메소드들

메소드	설명
getCursorBasedPagination ( mixed $defaultCursor = null ) : CursorBasedPagination
getFiltering ( ) : array
getFilteringParam ( string $param, mixed | null $default = null ) : array | string
getFixedPageBasedPagination ( mixed $defaultPage = null ) : FixedPageBasedPagination
getIncludedFields ( string $resourceType ) : array	Returns a list of field names for the given resource type which are required to be present in the response.
getIncludedRelationships ( string $baseRelationshipPath ) : array	Returns a list of relationship paths for a given parent path.
getOffsetBasedPagination ( mixed $defaultOffset = null, mixed $defaultLimit = null ) : OffsetBasedPagination
getPageBasedPagination ( mixed $defaultPage = null, mixed $defaultSize = null ) : PageBasedPagination
getPagination ( ) : array | null
getQueryParam ( string $name, mixed $default = null ) : array | string	Returns a query parameter with a name of $name if it is present in the request, or the $default value otherwise.
getResource ( ) : array | null	Returns the "data" part of the request if it is present in the body, or null otherwise.
getResourceAttribute ( string $attribute, mixed | null $default = null ) : mixed | null
getResourceAttributes ( ) : array
getResourceId ( ) : string | null	Returns the "id" key's value in the "data" part of the request if it is present in the body, or null otherwise.
getResourceType ( ) : string | null	Returns the "type" key's value in the "data" part of the request if it is present in the body, or null otherwise.
getSorting ( ) : array
getToManyRelationship ( string $relationship ) : ToManyRelationship | null
getToOneRelationship ( string $relationship ) : ToOneRelationship | null
hasIncludedRelationships ( ) : boolean	Determines if the request needs any relationships to be included.
isIncludedField ( string $resourceType, string $field ) : boolean	Determines if a given field for a given resource type should be present in the response or not.
isIncludedRelationship ( string $baseRelationshipPath, string $relationshipName, array $defaultRelationships ) : boolean	Determines if a given relationship name that is a child of the $baseRelationshipPath is required to be included in the response.
validateAcceptHeader ( )	Validates if the current request's Accept header conforms to the JSON API schema.
validateContentTypeHeader ( )	Validates if the current request's Content-Type header conforms to the JSON API schema.
validateQueryParams ( )	Validates if the current request's query parameters conform to the JSON API schema.
withQueryParam ( string $name, mixed $value )	Returns a query parameter with a name of $name if it is present in the request, or the $default value otherwise.

메소드 상세