Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader

protected

• $aboveWebRootDirLocation — string
  location of web root above module
• $argv
• $arrayOfModules — array
  specified like this: [ 'VendorName' => 'A', 'VendorNamespace' => 'A', 'PackageName' => 'Package1', 'PackageNamespace' => 'Package1', 'GitLink' => 'git@github.com:foor/bar-1.git', 'UpgradeAsFork' => false, 'NameOfBranchForBaseCode' => 'develop', ], [ 'VendorName' => 'A', 'VendorNamespace' => 'A', 'PackageName' => 'Package2', 'PackageNamespace' => 'Package2', 'GitLink' => 'git@github.com:foor/bar-2.git', 'UpgradeAsFork' => false, 'NameOfBranchForBaseCode' => 'master', ], required are: - VendorName - PacakageName The rest can be deduced (theoretically)
• $availableRecipes — array
  list of recipes available
• $commandLineExec — Sunnysideup\UpgradeToSilverstripe4\PHP2CommandLineSingleton|null
  Reference to the commandline printer that outputs everything to the command line
• $composerEnvironmentVars — string
  e.g. COMPOSER_HOME="/home/UserName"
• $currentlyRunning — string
  command that is currently running
• $customVariablesForTasks — array
  records variables for tasks, like this: [ 'TaskName' => [ 'VariableName' => 'VariableValue', ], ]
• $defaultNamespaceForTasks — string
  The default namespace for all tasks
• $endWith — string
  end the upgrade sequence after a particular task
• $frameworkComposerRestraint — string
  e.g. ^4.4
• $gitLink — string
  git link for the module in ssh form e.g. git@github.com:sunnysideup/silverstripe-dynamiccache.git
• $gitLinkAsHTTPS — string
  git link for the module in https form e.g. https://github.com/sunnysideup/silverstripe-dynamiccache/
• $gitLinkAsRawHTTPS — string
  git link for the module in raw https form e.g. https://raw.githubusercontent.com/sunnysideup/silverstripe-dynamiccache/
• $isModuleUpgrade — Sunnysideup\UpgradeToSilverstripe4\bool
  are we upgrading a module or a whole project?
• $lastMethodHasBeenRun — Sunnysideup\UpgradeToSilverstripe4\bool
  Is this the last TASK we are running?
• $listOfTasks — array
  An array of all the 'taskName's of the tasks that you wish to run during the execution of this upgrader task.
• $locationOfSSUpgradeModule — string
  //e.g. 'upgrade-code' //e.g. '~/.composer/vendor/bin/upgrade-code' //e.g. '/var/www/silverstripe-upgrade_to_silverstripe_4/vendor/silverstripe/upgrader/bin/upgrade-code'
• $locationOfThisUpgrader — string
  //e.g. 'upgrade-code' //e.g. '~/.composer/vendor/bin/upgrade-code' //e.g. '/var/www/silverstripe-upgrade_to_silverstripe_4/vendor/silverstripe/upgrader/bin/upgrade-code'
• $logFileLocation — string
• $logFolderDirLocation — string
  The folder for storing the log file in used in setting the php2 command line printer up
• $makeKeyNotes — Sunnysideup\UpgradeToSilverstripe4\bool
  does the exec output Key Notes?
• $moduleDirLocations — array
  Directory that holds the module or project.
• $nameOfBranchForBaseCode — string
  name of the branch that exists as the starting point for upgrade
• $nameOfTempBranch — string
  name of the branch created to do the upgrade
• $nameOfUpgradeStarterBranch — string
  name of the branch to be created that we use a starter branch for upgrade
• $onlyRun — string
  only run this task ...
• $originComposerFileLocation — string
• $outOfOrderTask — Sunnysideup\UpgradeToSilverstripe4\bool
  is this out of order - i.e. no influence on next task
• $packageFolderNameForInstall — string
  e.g. install folder for package in SS3.
• $packageName — string
  Package name for the module
• $packageNamespace — string
  Name space for the modules package
• $parentProjectForModule — string
  e.g. git@github.com:sunnysideup/silverstripe-ecommerce_test.git
• $parentProjectForModuleBranchOrTag — string
  e.g. master or 4.2.2
• $recipe — string
• $restartSession — Sunnysideup\UpgradeToSilverstripe4\bool
  Should the session details be deleted before we start?
• $runInteractively — Sunnysideup\UpgradeToSilverstripe4\bool
  if set to true it will run each step and then stop.
• $runIrreversibly — Sunnysideup\UpgradeToSilverstripe4\bool
  finish the run with a merge into master.
• $runLastOneAgain — Sunnysideup\UpgradeToSilverstripe4\bool
  Do we run the last step again?
• $sessionFileName — string
• $sessionManager — Sunnysideup\UpgradeToSilverstripe4\SessionManagementInterface|null
  Reference to the commandline printer that outputs everything to the command line
• $singleton — mixed
  Holds the only instance of me
• $startFrom — string
  start the upgrade sequence at a particular task
• $taskSteps — array
  A list of task groups this will be set from recipe - so we need this!
• $themeDirLocation — string
  Combination of the web dir root name and the aboveWebRootDirLocation
• $upgradeAsFork — Sunnysideup\UpgradeToSilverstripe4\bool
  Should the upgrade to this module create a fork
• $vendorAndPackageFolderNameForInstall — string
  e.g. sunnysideup/my-cool-module
• $vendorName — string
  Name of module vendor
• $vendorNamespace — string
  module vendors namespace
• $verbose — Sunnysideup\UpgradeToSilverstripe4\bool
  Show ALL the information or just a little bit.
• $webRootDirLocation — string
  Combination of the web dir root name and the aboveWebRootDirLocation
• $webRootName — string