PHP Class ZF\Apigility\Admin\Model\DocumentationModel

Show file Open project: zfcampus/zf-apigility-admin Class Usage Examples

Protected Properties

Property	Type	Description
$configFactory	ZF\Configuration\ResourceFactory
$moduleUtils	ZF\Configuration\ModuleUtils

Public Methods

Method	Description
__construct ( ZF\Configuration\ResourceFactory $configFactory, ZF\Configuration\ModuleUtils $moduleUtils )
controllerExists ( string $module, string $controller ) : boolean	Check if a module and controller exists
fetchDocumentation ( $module, $controllerServiceName )
getSchemaTemplate ( $type = self::TYPE_REST )
moduleExists ( string $module ) : boolean	Check if the module exists
storeDocumentation ( $module, $controllerType, $controllerServiceName, $documentation, $replace = false )

Protected Methods

Method	Description
getDocumentationConfigResource ( $module ) : ZF\Configuration\ConfigResource

Method Details

__construct() public method

public __construct ( ZF\Configuration\ResourceFactory $configFactory, ZF\Configuration\ModuleUtils $moduleUtils )
$configFactory	ZF\Configuration\ResourceFactory
$moduleUtils	ZF\Configuration\ModuleUtils

controllerExists() public method

Check if a module and controller exists

public controllerExists ( string $module, string $controller ) : boolean
$module	string
$controller	string
return	boolean

fetchDocumentation() public method

public fetchDocumentation ( $module, $controllerServiceName )

getDocumentationConfigResource() protected method

protected getDocumentationConfigResource ( $module ) : ZF\Configuration\ConfigResource
$module
return	ZF\Configuration\ConfigResource

getSchemaTemplate() public method

public getSchemaTemplate ( $type = self::TYPE_REST )

moduleExists() public method

Check if the module exists

public moduleExists ( string $module ) : boolean
$module	string
return	boolean

storeDocumentation() public method

public storeDocumentation ( $module, $controllerType, $controllerServiceName, $documentation, $replace = false )

Property Details

$configFactory protected property

protected ResourceFactory,ZF\Configuration $configFactory
return	ZF\Configuration\ResourceFactory

$moduleUtils protected property

protected ModuleUtils,ZF\Configuration $moduleUtils
return	ZF\Configuration\ModuleUtils