PHP Class ApiPlatform\Core\Documentation\Documentation

Author: Amrouche Hamza ([email protected])

Show file Open project: api-platform/core Class Usage Examples

Public Methods

Method	Description
__construct ( ResourceNameCollection $resourceNameCollection, string $title = '', string $description = '', string $version = '', array $formats = [] )
getDescription ( ) : string
getMimeTypes ( ) : array
getResourceNameCollection ( ) : ResourceNameCollection
getTitle ( ) : string
getVersion ( ) : string

Method Details

__construct() public method

public __construct ( ResourceNameCollection $resourceNameCollection, string $title = '', string $description = '', string $version = '', array $formats = [] )
$resourceNameCollection	ApiPlatform\Core\Metadata\Resource\ResourceNameCollection
$title	string
$description	string
$version	string
$formats	array

getDescription() public method

public getDescription ( ) : string
return	string

getMimeTypes() public method

public getMimeTypes ( ) : array
return	array

getResourceNameCollection() public method

public getResourceNameCollection ( ) : ResourceNameCollection
return	ApiPlatform\Core\Metadata\Resource\ResourceNameCollection

getTitle() public method

public getTitle ( ) : string
return	string

getVersion() public method

public getVersion ( ) : string
return	string