PHP Класс ZF\Apigility\Admin\Model\RestServiceResource

Наследование: extends ZF\Rest\AbstractResourceListener
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$documentationModel DocumentationModel
$inputFilterModel InputFilterModel
$model RestServiceModel
$moduleName string
$restFactory RestServiceModelFactory

Открытые методы

Метод Описание
__construct ( RestServiceModelFactory $restFactory, InputFilterModel $inputFilterModel, DocumentationModel $documentationModel )
create ( array | object $data ) : RestServiceEntity | ZF\ApiProblem\ApiProblem Create a new REST service
delete ( mixed $id ) : boolean Delete a service
fetch ( string $id ) : RestServiceEntity | ZF\ApiProblem\ApiProblem Fetch REST metadata
fetchAll ( array $params = [] ) : RestServiceEntity[] Fetch metadata for all REST services
getModel ( string $type = RestServiceModelFactory::TYPE_DEFAULT ) : RestServiceModel
getModuleName ( ) : string
patch ( string $id, object | array $data ) : ZF\ApiProblem\ApiProblem | RestServiceEntity Update an existing REST service

Защищенные методы

Метод Описание
injectDocumentation ( RestServiceEntity $service )
injectInputFilters ( RestServiceEntity $service ) Inject the input filters collection, if any, as an embedded collection

Описание методов

__construct() публичный Метод

public __construct ( RestServiceModelFactory $restFactory, InputFilterModel $inputFilterModel, DocumentationModel $documentationModel )
$restFactory RestServiceModelFactory
$inputFilterModel InputFilterModel
$documentationModel DocumentationModel

create() публичный Метод

Create a new REST service
public create ( array | object $data ) : RestServiceEntity | ZF\ApiProblem\ApiProblem
$data array | object
Результат RestServiceEntity | ZF\ApiProblem\ApiProblem

delete() публичный Метод

Delete a service
public delete ( mixed $id ) : boolean
$id mixed
Результат boolean

fetch() публичный Метод

Fetch REST metadata
public fetch ( string $id ) : RestServiceEntity | ZF\ApiProblem\ApiProblem
$id string
Результат RestServiceEntity | ZF\ApiProblem\ApiProblem

fetchAll() публичный Метод

Fetch metadata for all REST services
public fetchAll ( array $params = [] ) : RestServiceEntity[]
$params array
Результат RestServiceEntity[]

getModel() публичный Метод

public getModel ( string $type = RestServiceModelFactory::TYPE_DEFAULT ) : RestServiceModel
$type string One of the RestServiceModelFactory::TYPE_* constants; defaults to RestServiceModelFactory::TYPE_DEFAULT.
Результат RestServiceModel

getModuleName() публичный Метод

public getModuleName ( ) : string
Результат string

injectDocumentation() защищенный Метод

protected injectDocumentation ( RestServiceEntity $service )
$service RestServiceEntity

injectInputFilters() защищенный Метод

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

patch() публичный Метод

Update an existing REST service
public patch ( string $id, object | array $data ) : ZF\ApiProblem\ApiProblem | RestServiceEntity
$id string
$data object | array
Результат ZF\ApiProblem\ApiProblem | RestServiceEntity

Описание свойств

$documentationModel защищенное свойство

protected DocumentationModel,ZF\Apigility\Admin\Model $documentationModel
Результат DocumentationModel

$inputFilterModel защищенное свойство

protected InputFilterModel,ZF\Apigility\Admin\Model $inputFilterModel
Результат InputFilterModel

$model защищенное свойство

protected RestServiceModel,ZF\Apigility\Admin\Model $model
Результат RestServiceModel

$moduleName защищенное свойство

protected string $moduleName
Результат string

$restFactory защищенное свойство

protected RestServiceModelFactory,ZF\Apigility\Admin\Model $restFactory
Результат RestServiceModelFactory