PHP Class ZF\Apigility\Admin\Model\VersioningModel

Deprecation: use \ZF\Apigility\Admin\Model\ModuleVersioningModel instead
Show file Open project: zfcampus/zf-apigility-admin Class Usage Examples

Protected Properties

Property Type Description
$configResource
$docsConfigResource
$moduleNameFilter

Public Methods

Method Description
__construct ( ZF\Configuration\ConfigResource $config, ZF\Configuration\ConfigResource $docsConfig = null, ModulePathSpec $pathSpec = null )
createVersion ( string $module, integer $version, boolean | string $path = false ) : boolean Create a new version for a module
getModuleVersions ( string $module, boolean | string $path = false ) : array | boolean Get the versions of a module
setDefaultVersion ( integer $defaultVersion ) : boolean Updates the default version of a module that will be used if no version is specified by the API consumer.

Protected Methods

Method Description
getModuleNameFilter ( ) : Zend\Filter\FilterChain Filter for module names
getModuleSourcePath ( string $module, boolean $appendNamespace = true ) : string Determine the source path for the module
locateConfigPath ( string $srcPath ) : string | false Locate the config path for this module
normalizeModule ( string $module ) : string Normalize a module name

Private Methods

Method Description
getModuleVersioningModel ( $name, null | string $srcPath = null ) : ModuleVersioningModel getModuleVersioningModel

Method Details

__construct() public method

Deprecation:
public __construct ( ZF\Configuration\ConfigResource $config, ZF\Configuration\ConfigResource $docsConfig = null, ModulePathSpec $pathSpec = null )
$config ZF\Configuration\ConfigResource
$docsConfig ZF\Configuration\ConfigResource
$pathSpec ModulePathSpec

createVersion() public method

Create a new version for a module
Deprecation:
public createVersion ( string $module, integer $version, boolean | string $path = false ) : boolean
$module string
$version integer
$path boolean | string
return boolean

getModuleNameFilter() protected method

Filter for module names
Deprecation:
protected getModuleNameFilter ( ) : Zend\Filter\FilterChain
return Zend\Filter\FilterChain

getModuleSourcePath() protected method

Usually, this is the "src/{modulename}" subdirectory of the module.
Deprecation:
protected getModuleSourcePath ( string $module, boolean $appendNamespace = true ) : string
$module string
$appendNamespace boolean If true, it will append the module's namespace to the path - for PSR0 compatibility
return string

getModuleVersions() public method

Get the versions of a module
Deprecation:
public getModuleVersions ( string $module, boolean | string $path = false ) : array | boolean
$module string
$path boolean | string
return array | boolean

locateConfigPath() protected method

Locate the config path for this module
Deprecation:
protected locateConfigPath ( string $srcPath ) : string | false
$srcPath string
return string | false

normalizeModule() protected method

Module names come over the wire dot-separated; make them namespaced.
Deprecation:
protected normalizeModule ( string $module ) : string
$module string
return string

setDefaultVersion() public method

Updates the default version of a module that will be used if no version is specified by the API consumer.
Deprecation:
public setDefaultVersion ( integer $defaultVersion ) : boolean
$defaultVersion integer
return boolean

Property Details

$configResource protected property

protected $configResource

$docsConfigResource protected property

protected $docsConfigResource

$moduleNameFilter protected property

protected $moduleNameFilter