PHP Class Drest\Manager\Representation

Datei anzeigen Open project: leedavis81/drest Class Usage Examples

Protected Properties

Property	Type	Description
$config	Drest\Configuration	Drest configuration object - referenced to same instance used in Manager
$emr	Drest\EntityManagerRegistry	Doctrine Entity Manager Registry
$request	DrestCommon\Request\Request	A request instance for inspection Reset on each getDeterminedRepresentation()

Public Methods

Method	Description
__construct ( Drest\Configuration &$config )
create ( Drest\Configuration &$config ) : Representation	Static call to create a representation instance
getDeterminedRepresentation ( DrestCommon\Request\Request $request, RouteMetaData &$route = null ) : DrestCommon\Representation\AbstractRepresentation	Detect an instance of a representation class using a matched route, or default representation classes
handleExposureSettingsFromHttpMethod ( DrestCommon\Request\Request $request, RouteMetaData $route, Drest\EntityManagerRegistry $emr ) : DrestCommon\Representation\AbstractRepresentation

Protected Methods

Method	Description
determineRepresentationByHttpMethod ( DrestCommon\Representation\AbstractRepresentation $representation, array $detectContentOptions = [] ) : DrestCommon\Representation\AbstractRepresentation \| null	Determine the representation by inspecting the HTTP method
getRepresentationClassName ( string $representation ) : string	Get's the representation class name.
getRepresentationClasses ( RouteMetaData &$route = null ) : array	Get representation options. Determined from route or config
handlePullExposureConfiguration ( RouteMetaData &$route )	Handle a pull requests' exposure configuration (GET)
handlePushExposureConfiguration ( RouteMetaData $route, DrestCommon\Representation\AbstractRepresentation $representation ) : DrestCommon\Representation\AbstractRepresentation	Handle a push requests' exposure configuration (POST/PUT/PATCH)
matchRepresentation ( DrestCommon\Representation\AbstractRepresentation \| string $representation, array &$representationObjects ) : DrestCommon\Representation\AbstractRepresentation \| null	Attempt to match a representation
searchAndValidateRepresentations ( array $representations ) : DrestCommon\Representation\AbstractRepresentation \| null	Iterate through an array of representations and return a match

Method Details

__construct() public method

public __construct ( Drest\Configuration &$config )
$config	Drest\Configuration

create() public static method

Static call to create a representation instance

public static create ( Drest\Configuration &$config ) : Representation
$config	Drest\Configuration
return	Representation

determineRepresentationByHttpMethod() protected method

Determine the representation by inspecting the HTTP method

protected determineRepresentationByHttpMethod ( DrestCommon\Representation\AbstractRepresentation $representation, array $detectContentOptions = [] ) : DrestCommon\Representation\AbstractRepresentation \| null
$representation	DrestCommon\Representation\AbstractRepresentation
$detectContentOptions	array	- Eg array(self::DETECT_CONTENT_HEADER => 'Accept')
return	DrestCommon\Representation\AbstractRepresentation \| null

getDeterminedRepresentation() public method

Detect an instance of a representation class using a matched route, or default representation classes

public getDeterminedRepresentation ( DrestCommon\Request\Request $request, RouteMetaData &$route = null ) : DrestCommon\Representation\AbstractRepresentation
$request	DrestCommon\Request\Request
$route	Drest\Mapping\RouteMetaData
return	DrestCommon\Representation\AbstractRepresentation	$representation

getRepresentationClassName() protected method

Removes any root NS chars Falls back to a DrestCommon Representation lookup

protected getRepresentationClassName ( string $representation ) : string
$representation	string
return	string

getRepresentationClasses() protected method

Get representation options. Determined from route or config

protected getRepresentationClasses ( RouteMetaData &$route = null ) : array
$route	Drest\Mapping\RouteMetaData
return	array

handleExposureSettingsFromHttpMethod() public method

public handleExposureSettingsFromHttpMethod ( DrestCommon\Request\Request $request, RouteMetaData $route, Drest\EntityManagerRegistry $emr ) : DrestCommon\Representation\AbstractRepresentation
$request	DrestCommon\Request\Request
$route	Drest\Mapping\RouteMetaData
$emr	Drest\EntityManagerRegistry
return	DrestCommon\Representation\AbstractRepresentation

handlePullExposureConfiguration() protected method

Handle a pull requests' exposure configuration (GET)

protected handlePullExposureConfiguration ( RouteMetaData &$route )
$route	Drest\Mapping\RouteMetaData	(referenced object)

handlePushExposureConfiguration() protected method

Handle a push requests' exposure configuration (POST/PUT/PATCH)

protected handlePushExposureConfiguration ( RouteMetaData $route, DrestCommon\Representation\AbstractRepresentation $representation ) : DrestCommon\Representation\AbstractRepresentation
$route	Drest\Mapping\RouteMetaData	- the matched route
$representation	DrestCommon\Representation\AbstractRepresentation	- the representation class to be used
return	DrestCommon\Representation\AbstractRepresentation	$representation

matchRepresentation() protected method

Attempt to match a representation

protected matchRepresentation ( DrestCommon\Representation\AbstractRepresentation \| string $representation, array &$representationObjects ) : DrestCommon\Representation\AbstractRepresentation \| null
$representation	DrestCommon\Representation\AbstractRepresentation \| string
$representationObjects	array
return	DrestCommon\Representation\AbstractRepresentation \| null

searchAndValidateRepresentations() protected method

Iterate through an array of representations and return a match

protected searchAndValidateRepresentations ( array $representations ) : DrestCommon\Representation\AbstractRepresentation \| null
$representations	array
return	DrestCommon\Representation\AbstractRepresentation \| null

Property Details

$config protected_oe property

Drest configuration object - referenced to same instance used in Manager

protected Configuration,Drest $config
return	Drest\Configuration

$emr protected_oe property

Doctrine Entity Manager Registry

protected EntityManagerRegistry,Drest $emr
return	Drest\EntityManagerRegistry

$request protected_oe property

A request instance for inspection Reset on each getDeterminedRepresentation()

protected Request,DrestCommon\Request $request
return	DrestCommon\Request\Request