Property | Type | Description | |
---|---|---|---|
$migrationsManager | |||
$notes | array | ||
$operations | array | ||
$sourcePackageKey | string | ||
$targetPackageData | array | ||
$warnings | array |
Method | Description | |
---|---|---|
__construct ( |
||
execute ( ) : void | ||
getDescription ( ) : string | Returns the first line of the migration class doc comment | |
getIdentifier ( ) : string | Returns the identifier of this migration, e.g. 'Neos.Flow-20120126163610'. | |
getNotes ( ) : array | ||
getSourcePackageKey ( ) : string | Returns the package key this migration comes from. | |
getVersionNumber ( ) : string | Returns the version of this migration, e.g. '20120126163610'. | |
getWarnings ( ) : array | ||
hasNotes ( ) : boolean | ||
hasWarnings ( ) : boolean | ||
prepare ( array $targetPackageData ) : void | Resets internal state and sets the target package data. | |
up ( ) : void | Anything that needs to be done in the migration when migrating into the "up" direction needs to go into this method. |
Method | Description | |
---|---|---|
applyFileOperations ( ) : void | Applies all registered moveFile operations. | |
applySearchAndReplaceOperations ( ) : void | Applies all registered searchAndReplace operations. | |
deleteFile ( string $pathAndFileName ) : void | Delete a file. | |
moveFile ( string $oldPath, string $newPath ) : void | Move a file (or directory) from $oldPath to $newPath. | |
moveSettingsPaths ( string $sourcePath, string $destinationPath ) | Move a settings path from "source" to "destination"; best to be used when package names change. | |
processConfiguration ( string $configurationType, Closure $processor, boolean $saveResult = false ) : void | Apply the given processor to the raw results of loading the given configuration type for the package from YAML. If multiple files exist (context configuration) all are processed independently. | |
renameClass ( string $oldName, string $newName ) : void | Rename a class from $oldName to $newName. | |
renameMethod ( string $className, string $oldMethodName, string $newMethodName, boolean $withInheritance = true ) : void | Rename a class method. | |
searchAndReplace ( string $search, string $replacement, array | string $filter = ['php', 'yaml', 'html'] ) : void | Does a simple search and replace on all (textual) files. The filter array can be used to give file extensions to limit the operation to. | |
searchAndReplaceRegex ( string $search, string | Closure $replacement, array | string $filter = ['php', 'yaml', 'html'] ) : void | Does a regex search and replace on all (textual) files. The filter array can be used to give file extensions to limit the operation to. | |
showNote ( string $note ) : void | This can be used to show a note to the developer. | |
showWarning ( string $warning ) : void | This can be used to show a warning to the developer. |
public __construct ( |
||
$manager | ||
$packageKey | string |
protected applyFileOperations ( ) : void | ||
return | void |
protected applySearchAndReplaceOperations ( ) : void | ||
return | void |
protected deleteFile ( string $pathAndFileName ) : void | ||
$pathAndFileName | string | |
return | void |
public getDescription ( ) : string | ||
return | string |
abstract public getIdentifier ( ) : string | ||
return | string |
public getSourcePackageKey ( ) : string | ||
return | string |
public getVersionNumber ( ) : string | ||
return | string |
protected moveSettingsPaths ( string $sourcePath, string $destinationPath ) | ||
$sourcePath | string | |
$destinationPath | string |
protected renameMethod ( string $className, string $oldMethodName, string $newMethodName, boolean $withInheritance = true ) : void | ||
$className | string | the class that contains the method to be renamed |
$oldMethodName | string | the method to be renamed |
$newMethodName | string | the new method name |
$withInheritance | boolean | if true, also rename method on child classes |
return | void |
protected searchAndReplaceRegex ( string $search, string | Closure $replacement, array | string $filter = ['php', 'yaml', 'html'] ) : void | ||
$search | string | |
$replacement | string | Closure | |
$filter | array | string | either an array with file extensions to consider or the full path to a single file to process |
return | void |
protected showWarning ( string $warning ) : void | ||
$warning | string | |
return | void |
protected Manager,Neos\Flow\Core\Migrations $migrationsManager | ||
return |