PHP Class ZF\Apigility\Admin\Model\ModuleVersioningModel

Author: Gabriel Somoza ([email protected])
Afficher le fichier Open project: zfcampus/zf-apigility-admin Class Usage Examples

Protected Properties

Свойство Type Description
$configResource ZF\Configuration\ConfigResource
$docsConfigResource null | ZF\Configuration\ConfigResource
$moduleNameFilter Zend\Filter\FilterChain

Méthodes publiques

Méthode Description
__construct ( string $moduleName, string $configDirPath, string $srcPath, ZF\Configuration\ConfigResource $config, ZF\Configuration\ConfigResource $docsConfig = null, null | string $pathSpecType = null )
createVersion ( integer $version ) : true Create a new version for a module
createWithPathSpec ( string $moduleName, ModulePathSpec $pathSpec, ZF\Configuration\ConfigResource $config, ZF\Configuration\ConfigResource $docsConfig = null ) : static createWithPathSpec
getModuleVersions ( ) : 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.

Méthodes protégées

Méthode Description
changeVersionArray ( array $data, integer $previous, integer $version ) : array Change version in an array
changeVersionNamespace ( string $string, integer $previous, integer $version ) : string Change version in a namespace
getModuleNameFilter ( ) : Zend\Filter\FilterChain Filter for module names
recursiveCopy ( string $source, string $target, integer $previous, integer $version ) Copy file and folder recursively
updateConfigVersion ( string $file, integer $previous, integer $version ) : boolean Update a PHP configuration file from $previous to $version version
updateDocumentationVersion ( integer $previous, integer $version ) : true Update the documentation to add a new $version based on the $previous

Private Methods

Méthode Description
setConfigDirPath ( string $configDirPath ) : void
setPathSpecType ( string $pathSpecType ) : void
setVersionsPath ( string $srcPath ) : void Sets the path to the directory that contains each of the module's version. If the current module is a PSR-0 module then it automatically appends the module's namespace.

Method Details

__construct() public méthode

public __construct ( string $moduleName, string $configDirPath, string $srcPath, ZF\Configuration\ConfigResource $config, ZF\Configuration\ConfigResource $docsConfig = null, null | string $pathSpecType = null )
$moduleName string Name of the module. MUST be normalized.
$configDirPath string Path the the configuration folder, with one or more *.config.php files.
$srcPath string Path to the module's source folder for versions, resources & collections.
$config ZF\Configuration\ConfigResource
$docsConfig ZF\Configuration\ConfigResource
$pathSpecType null | string Whether the module uses a PSR-0 directory structure or not. Defaults to ModulePathSpec::PSR_0.

changeVersionArray() protected méthode

Change version in an array
protected changeVersionArray ( array $data, integer $previous, integer $version ) : array
$data array
$previous integer
$version integer
Résultat array

changeVersionNamespace() protected méthode

Change version in a namespace
protected changeVersionNamespace ( string $string, integer $previous, integer $version ) : string
$string string
$previous integer
$version integer
Résultat string

createVersion() public méthode

Create a new version for a module
public createVersion ( integer $version ) : true
$version integer
Résultat true

createWithPathSpec() public static méthode

createWithPathSpec
public static createWithPathSpec ( string $moduleName, ModulePathSpec $pathSpec, ZF\Configuration\ConfigResource $config, ZF\Configuration\ConfigResource $docsConfig = null ) : static
$moduleName string
$pathSpec ModulePathSpec
$config ZF\Configuration\ConfigResource
$docsConfig ZF\Configuration\ConfigResource
Résultat static

getModuleNameFilter() protected méthode

Filter for module names
protected getModuleNameFilter ( ) : Zend\Filter\FilterChain
Résultat Zend\Filter\FilterChain

getModuleVersions() public méthode

Get the versions of a module
public getModuleVersions ( ) : array | boolean
Résultat array | boolean

recursiveCopy() protected méthode

Copy file and folder recursively
protected recursiveCopy ( string $source, string $target, integer $previous, integer $version )
$source string
$target string
$previous integer
$version integer

setDefaultVersion() public méthode

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

updateConfigVersion() protected méthode

Update a PHP configuration file from $previous to $version version
protected updateConfigVersion ( string $file, integer $previous, integer $version ) : boolean
$file string
$previous integer Previous version
$version integer New version
Résultat boolean

updateDocumentationVersion() protected méthode

Update the documentation to add a new $version based on the $previous
protected updateDocumentationVersion ( integer $previous, integer $version ) : true
$previous integer Previous version
$version integer New version
Résultat true

Property Details

$configResource protected_oe property

protected ConfigResource,ZF\Configuration $configResource
Résultat ZF\Configuration\ConfigResource

$docsConfigResource protected_oe property

protected null|ConfigResource,ZF\Configuration $docsConfigResource
Résultat null | ZF\Configuration\ConfigResource

$moduleNameFilter protected_oe property

protected FilterChain,Zend\Filter $moduleNameFilter
Résultat Zend\Filter\FilterChain