PHP Class Drest\Manager\Representation

Afficher le fichier Open project: leedavis81/drest Class Usage Examples

Protected Properties

Свойство 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()

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode 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 méthode

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

create() public static méthode

Static call to create a representation instance
public static create ( Drest\Configuration &$config ) : Representation
$config Drest\Configuration
Résultat Representation

determineRepresentationByHttpMethod() protected méthode

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')
Résultat DrestCommon\Representation\AbstractRepresentation | null

getDeterminedRepresentation() public méthode

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
Résultat DrestCommon\Representation\AbstractRepresentation $representation

getRepresentationClassName() protected méthode

Removes any root NS chars Falls back to a DrestCommon Representation lookup
protected getRepresentationClassName ( string $representation ) : string
$representation string
Résultat string

getRepresentationClasses() protected méthode

Get representation options. Determined from route or config
protected getRepresentationClasses ( RouteMetaData &$route = null ) : array
$route Drest\Mapping\RouteMetaData
Résultat array

handleExposureSettingsFromHttpMethod() public méthode

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
Résultat DrestCommon\Representation\AbstractRepresentation

handlePullExposureConfiguration() protected méthode

Handle a pull requests' exposure configuration (GET)
protected handlePullExposureConfiguration ( RouteMetaData &$route )
$route Drest\Mapping\RouteMetaData (referenced object)

handlePushExposureConfiguration() protected méthode

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
Résultat DrestCommon\Representation\AbstractRepresentation $representation

matchRepresentation() protected méthode

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
Résultat DrestCommon\Representation\AbstractRepresentation | null

searchAndValidateRepresentations() protected méthode

Iterate through an array of representations and return a match
protected searchAndValidateRepresentations ( array $representations ) : DrestCommon\Representation\AbstractRepresentation | null
$representations array
Résultat DrestCommon\Representation\AbstractRepresentation | null

Property Details

$config protected_oe property

Drest configuration object - referenced to same instance used in Manager
protected Configuration,Drest $config
Résultat Drest\Configuration

$emr protected_oe property

Doctrine Entity Manager Registry
protected EntityManagerRegistry,Drest $emr
Résultat Drest\EntityManagerRegistry

$request protected_oe property

A request instance for inspection Reset on each getDeterminedRepresentation()
protected Request,DrestCommon\Request $request
Résultat DrestCommon\Request\Request