PHP Class ZF\Apigility\Admin\Model\RpcServiceResource

Inheritance: extends ZF\Rest\AbstractResourceListener
Mostrar archivo Open project: zfcampus/zf-apigility-admin Class Usage Examples

Protected Properties

Property Type Description
$controllerManager Zend\Mvc\Controller\ControllerManager
$documentationModel DocumentationModel
$inputFilterModel InputFilterModel
$model RpcServiceModel
$moduleName string
$rpcFactory RpcServiceModelFactory

Public Methods

Method Description
__construct ( RpcServiceModelFactory $rpcFactory, InputFilterModel $inputFilterModel, ControllerManager $controllerManager, DocumentationModel $documentationModel )
create ( array | object $data ) : RpcServiceEntity | ZF\ApiProblem\ApiProblem Create a new RPC service
delete ( string $id ) : true Delete an RPC service
fetch ( string $id ) : RpcServiceEntity | ZF\ApiProblem\ApiProblem Fetch RPC metadata
fetchAll ( array $params = [] ) : RpcServiceEntity[] Fetch metadata for all RPC services
getModel ( ) : RpcServiceModel
getModuleName ( ) : string
patch ( string $id, object | array $data ) : ZF\ApiProblem\ApiProblem | RpcServiceEntity Update an existing RPC service

Protected Methods

Method Description
injectControllerClass ( RpcServiceEntity $service ) Inject the class name of the controller, if it can be resolved.
injectDocumentation ( RpcServiceEntity $service )
injectInputFilters ( RpcServiceEntity $service ) Inject the input filters collection, if any, as an embedded collection

Method Details

__construct() public method

public __construct ( RpcServiceModelFactory $rpcFactory, InputFilterModel $inputFilterModel, ControllerManager $controllerManager, DocumentationModel $documentationModel )
$rpcFactory RpcServiceModelFactory
$inputFilterModel InputFilterModel
$controllerManager Zend\Mvc\Controller\ControllerManager
$documentationModel DocumentationModel

create() public method

Create a new RPC service
public create ( array | object $data ) : RpcServiceEntity | ZF\ApiProblem\ApiProblem
$data array | object
return RpcServiceEntity | ZF\ApiProblem\ApiProblem

delete() public method

Delete an RPC service
public delete ( string $id ) : true
$id string
return true

fetch() public method

Fetch RPC metadata
public fetch ( string $id ) : RpcServiceEntity | ZF\ApiProblem\ApiProblem
$id string
return RpcServiceEntity | ZF\ApiProblem\ApiProblem

fetchAll() public method

Fetch metadata for all RPC services
public fetchAll ( array $params = [] ) : RpcServiceEntity[]
$params array
return RpcServiceEntity[]

getModel() public method

public getModel ( ) : RpcServiceModel
return RpcServiceModel

getModuleName() public method

public getModuleName ( ) : string
return string

injectControllerClass() protected method

Inject the class name of the controller, if it can be resolved.
protected injectControllerClass ( RpcServiceEntity $service )
$service RpcServiceEntity

injectDocumentation() protected method

protected injectDocumentation ( RpcServiceEntity $service )
$service RpcServiceEntity

injectInputFilters() protected method

Inject the input filters collection, if any, as an embedded collection
protected injectInputFilters ( RpcServiceEntity $service )
$service RpcServiceEntity

patch() public method

Update an existing RPC service
public patch ( string $id, object | array $data ) : ZF\ApiProblem\ApiProblem | RpcServiceEntity
$id string
$data object | array
return ZF\ApiProblem\ApiProblem | RpcServiceEntity

Property Details

$controllerManager protected_oe property

protected ControllerManager,Zend\Mvc\Controller $controllerManager
return Zend\Mvc\Controller\ControllerManager

$documentationModel protected_oe property

protected DocumentationModel,ZF\Apigility\Admin\Model $documentationModel
return DocumentationModel

$inputFilterModel protected_oe property

protected InputFilterModel,ZF\Apigility\Admin\Model $inputFilterModel
return InputFilterModel

$model protected_oe property

protected RpcServiceModel,ZF\Apigility\Admin\Model $model
return RpcServiceModel

$moduleName protected_oe property

protected string $moduleName
return string

$rpcFactory protected_oe property

protected RpcServiceModelFactory,ZF\Apigility\Admin\Model $rpcFactory
return RpcServiceModelFactory