PhalconRest\Api\ApiEndpoint::getPath PHP Method

getPath() public method

public getPath ( ) : string
return string Path of the endpoint, relative to the collection
    public function getPath()
    {
        return $this->path;
    }

Usage Example

 /**
  * Mounts endpoint to the collection
  *
  * @param \PhalconRest\Api\ApiEndpoint $endpoint Endpoint to mount
  *
  * @return static
  */
 public function endpoint(ApiEndpoint $endpoint)
 {
     $this->endpointsByName[$endpoint->getName()] = $endpoint;
     switch ($endpoint->getHttpMethod()) {
         case HttpMethods::GET:
             $this->get($endpoint->getPath(), $endpoint->getHandlerMethod(), $this->createRouteName($endpoint));
             break;
         case HttpMethods::POST:
             $this->post($endpoint->getPath(), $endpoint->getHandlerMethod(), $this->createRouteName($endpoint));
             break;
         case HttpMethods::PUT:
             $this->put($endpoint->getPath(), $endpoint->getHandlerMethod(), $this->createRouteName($endpoint));
             break;
         case HttpMethods::DELETE:
             $this->delete($endpoint->getPath(), $endpoint->getHandlerMethod(), $this->createRouteName($endpoint));
             break;
     }
     return $this;
 }