Property | Type | Description | |
---|---|---|---|
$configResource | ZF\Configuration\ConfigResource | ||
$events | Zend\EventManager\EventManagerInterface | ||
$module | string | ||
$moduleEntity | |||
$modulePath | string | ||
$modules | |||
$renderer | Zend\View\Renderer\PhpRenderer | ||
$restArrayUpdateOptions | array | Allowed REST update options that are arrays | |
$restScalarUpdateOptions | array | Allowed REST update options that are scalars | |
$routeNameFilter | Zend\Filter\FilterChain |
Method | Description | |
---|---|---|
__construct ( |
||
__get ( string $name ) : mixed | Allow read-only access to properties | |
createCollectionClass ( string $serviceName ) : string | Create a collection class for the resource | |
createContentNegotiationConfig ( |
Create content negotiation configuration based on payload and discovered controller service name | |
createControllerServiceName ( string $serviceName ) : string | Generate the controller service name from the module and service name | |
createEntityClass ( string $serviceName, string $template = 'entity', |
Create an entity class for the resource | |
createFactoryClass ( $serviceName ) | ||
createHalConfig ( |
Create HAL configuration | |
createMediaType ( ) : string | Create the mediatype for this | |
createResourceClass ( string $serviceName ) : string | Creates a new resource class based on the specified service name | |
createRestConfig ( |
Creates REST configuration | |
createRoute ( string $serviceName, string $route, string $routeIdentifier, string $controllerService ) : string | Create the route configuration | |
createService ( |
Create a new service using the details provided | |
deleteAuthorizationConfig ( |
Delete any authorization configuration for a service | |
deleteContentNegotiationConfig ( |
Delete content-negotiation configuration associated with a service | |
deleteContentValidationConfig ( |
Delete content-validation configuration associated with a service | |
deleteHalConfig ( |
Delete HAL configuration for the service | |
deleteRestConfig ( |
Delete the REST configuration associated with the given service | |
deleteRoute ( |
Delete the route associated with the given service | |
deleteService ( string $controllerService, boolean $recursive = false ) : true | Delete a named service | |
deleteServiceManagerConfig ( |
Delete any service manager configuration for the resource | |
deleteVersioningConfig ( |
Delete versioning configuration for a service | |
fetch ( string $controllerService, boolean $isAFetchOperation = true ) : |
||
fetchAll ( integer $version = null ) : |
Fetch all services | |
getEventManager ( ) : Zend\EventManager\EventManagerInterface | Retrieve the EventManager instance | |
setEventManager ( Zend\EventManager\EventManagerInterface $events ) | Set the EventManager instance | |
updateContentNegotiationConfig ( |
Update the content negotiation configuration for the service | |
updateHalConfig ( |
Update HAL configuration | |
updateRestConfig ( |
Update REST configuration | |
updateRoute ( |
Update the route for an existing service | |
updateService ( |
Update an existing service |
Method | Description | |
---|---|---|
createClassFile ( Zend\View\Model\ViewModel $model, string $type, string $classPath ) : boolean | Create a class file | |
deriveCollectionClass ( string $controllerServiceName, |
Derive the name of the collection class from the controller service name | |
deriveEntityClass ( string $controllerServiceName, |
Derive the name of the entity class from the controller service name | |
getConfigForSubkey ( string $subKey, array | mixed $default = [] ) : mixed | Traverse an array for a subkey | |
getRenderer ( ) : Zend\View\Renderer\PhpRenderer | Get a renderer instance | |
getRouteInfo ( |
Retrieve route information for a given service based on the configuration available | |
getRouteNameFilter ( ) : Zend\Filter\FilterChain | Retrieve the filter chain for generating the route name | |
getSourcePath ( string $serviceName ) : string | Get the source path for the module | |
injectResolver ( Zend\View\Renderer\PhpRenderer $renderer, string $type ) : string | Inject the renderer with a resolver | |
mergeContentNegotiationConfig ( string $controllerServiceName, |
Merge the content negotiation configuration for the given controller service into the REST metadata | |
mergeHalConfig ( string $controllerServiceName, |
Merge entity and collection class into metadata, if found | |
routeAlreadyExist ( string $route, string $excludeRouteName = null ) : boolean | Check if a route already exist in the configuration |
Method | Description | |
---|---|---|
moduleNameToRegex ( ) : string | Converts a module name (which could include namespace separators) into a string that can be used in regex matches. Use-cases: - Acme\Account => Acme\\Account - Acme\\Account (ideally it should never happen) => Acme\\Account - Acme => Acme |
public __construct ( |
||
$moduleEntity | ||
$modules | ||
$config | ZF\Configuration\ConfigResource |
public createCollectionClass ( string $serviceName ) : string | ||
$serviceName | string | |
return | string | The name of the newly created collection class |
public createContentNegotiationConfig ( |
||
$details | ||
$controllerService | string |
public createControllerServiceName ( string $serviceName ) : string | ||
$serviceName | string | |
return | string |
public createMediaType ( ) : string | ||
return | string |
public createResourceClass ( string $serviceName ) : string | ||
$serviceName | string | |
return | string | The name of the newly created class |
public createService ( |
||
$details | ||
return |
public deleteAuthorizationConfig ( |
||
$entity |
public deleteContentNegotiationConfig ( |
||
$entity |
public deleteContentValidationConfig ( |
||
$entity |
public deleteHalConfig ( |
||
$entity |
public deleteRestConfig ( |
||
$entity |
public deleteRoute ( |
||
$entity |
public deleteService ( string $controllerService, boolean $recursive = false ) : true | ||
$controllerService | string | |
$recursive | boolean | |
return | true |
public deleteServiceManagerConfig ( |
||
$entity |
public deleteVersioningConfig ( |
||
$entity |
public fetch ( string $controllerService, boolean $isAFetchOperation = true ) : |
||
$controllerService | string | |
$isAFetchOperation | boolean | If this is for a non-fetch operation, pass boolean false; allows listeners to include additional data necessary for clean updates. |
return |
public getEventManager ( ) : Zend\EventManager\EventManagerInterface | ||
return | Zend\EventManager\EventManagerInterface |
protected getRenderer ( ) : Zend\View\Renderer\PhpRenderer | ||
return | Zend\View\Renderer\PhpRenderer |
protected getRouteInfo ( |
||
$metadata | ||
$config | array |
protected getRouteNameFilter ( ) : Zend\Filter\FilterChain | ||
return | Zend\Filter\FilterChain |
protected getSourcePath ( string $serviceName ) : string | ||
$serviceName | string | |
return | string |
protected injectResolver ( Zend\View\Renderer\PhpRenderer $renderer, string $type ) : string | ||
$renderer | Zend\View\Renderer\PhpRenderer | |
$type | string | |
return | string | Template name |
protected mergeContentNegotiationConfig ( string $controllerServiceName, |
||
$controllerServiceName | string | |
$metadata | ||
$config | array |
protected mergeHalConfig ( string $controllerServiceName, |
||
$controllerServiceName | string | |
$metadata | ||
$config | array |
public setEventManager ( Zend\EventManager\EventManagerInterface $events ) | ||
$events | Zend\EventManager\EventManagerInterface |
public updateContentNegotiationConfig ( |
||
$original | ||
$update |
public updateHalConfig ( |
||
$original | ||
$update |
public updateRestConfig ( |
||
$original | ||
$update |
public updateRoute ( |
||
$original | ||
$update |
public updateService ( |
||
$update | ||
return |
protected ConfigResource,ZF\Configuration $configResource | ||
return | ZF\Configuration\ConfigResource |
protected EventManagerInterface,Zend\EventManager $events | ||
return | Zend\EventManager\EventManagerInterface |
protected ModuleEntity,ZF\Apigility\Admin\Model $moduleEntity | ||
return |
protected ModulePathSpec,ZF\Apigility\Admin\Model $modules | ||
return |
protected PhpRenderer,Zend\View\Renderer $renderer | ||
return | Zend\View\Renderer\PhpRenderer |
protected array $restArrayUpdateOptions | ||
return | array |
protected array $restScalarUpdateOptions | ||
return | array |