PHP Class PhalconRest\Api

Inheritance: extends PhalconApi\Api
Show file Open project: olivierandriessen/phalcon-rest Class Usage Examples

Protected Properties

Property Type Description
$collectionsByIdentifier
$collectionsByName
$endpointsByIdentifier
$matchedRouteNameParts

Public Methods

Method Description
collection ( ApiCollection $collection ) : static
getCollection ( $name ) : ApiCollection | null
getCollections ( ) : ApiCollection[]
getMatchedCollection ( ) : ApiCollection | null
getMatchedEndpoint ( ) : ApiEndpoint | null
mount ( Phalcon\Mvc\Micro\CollectionInterface $collection )
resource ( ApiResource $resource ) : static

Protected Methods

Method Description
getMatchedRouteNamePart ( $key )

Method Details

collection() public method

public collection ( ApiCollection $collection ) : static
$collection PhalconRest\Api\ApiCollection
return static

getCollection() public method

public getCollection ( $name ) : ApiCollection | null
$name
return PhalconRest\Api\ApiCollection | null

getCollections() public method

public getCollections ( ) : ApiCollection[]
return PhalconRest\Api\ApiCollection[]

getMatchedCollection() public method

public getMatchedCollection ( ) : ApiCollection | null
return PhalconRest\Api\ApiCollection | null The matched collection

getMatchedEndpoint() public method

public getMatchedEndpoint ( ) : ApiEndpoint | null
return PhalconRest\Api\ApiEndpoint | null The matched endpoint

getMatchedRouteNamePart() protected method

protected getMatchedRouteNamePart ( $key )

mount() public method

public mount ( Phalcon\Mvc\Micro\CollectionInterface $collection )
$collection Phalcon\Mvc\Micro\CollectionInterface

resource() public method

public resource ( ApiResource $resource ) : static
$resource PhalconRest\Api\ApiResource
return static

Property Details

$collectionsByIdentifier protected property

protected $collectionsByIdentifier

$collectionsByName protected property

protected $collectionsByName

$endpointsByIdentifier protected property

protected $endpointsByIdentifier

$matchedRouteNameParts protected property

protected $matchedRouteNameParts