laminas-migration

TESTING PURPOSES ONLY

This package is currently in testing phases. While it can be used to migrate your application to Laminas packages, those packages do not yet exist in a stable form. Only use this to help provide feedback on edge cases to the Zend Framework and Laminas teams.

Migrate a Zend Framework project or third-party library to target Laminas, Expressive, and/or Apigility.

Installation

Via Composer

Install the library globally using Composer:

$ composer require --global laminas/laminas-migration

Via cloning

Clone the repository somewhere:

$ git clone https://github.com/laminas/laminas-migration.git

Install dependencies:

$ cd laminas-migration
$ composer install

From there, either add the bin/ directory to your $PATH, symlink the bin/laminas-migration script to a directory in your $PATH, or create an alias to the bin/laminas-migration script using your shell:

# Adding to PATH:
$ export PATH=/path/to/laminas-migration/bin:$PATH
# Symlinking to a directory in your PATH:
$ cd $HOME/bin && ln -s /path/to/laminas-migration/bin/laminas-migration .
# creating an alias:
$ alias laminas-migration=/path/to/laminas-migration/bin/laminas-migration

Usage

Migrating a library or project

To migrate a library or project to Laminas, use the migrate command:

$ laminas-migration migrate [--no-plugin] [--exclude=|-e=] [path]

where:

[path] is the path to the project you want to migrate; if omitted, the command assumes the current working directory.
[--no-plugin] can be specified to omit adding the Composer plugin laminas/laminas-dependency-plugin to your library or project. We do not recommend using this option; the plugin ensures that any nested dependencies on Zend Framework packages will instead install the Laminas variants. There are very few cases where this behavior is not desired.
[--exclude=|-e=] can be used multiple times to specify directories to omit from the migration. Examples might include your data/ or cache/ directories.

When done, you can check to see what files were changed, and examine the composer.json. Run composer install to install dependencies, and then test your application.

Forcing nested dependencies to resolve to Laminas packages

If you use the --no-plugin option to the migrate command, you can migrate nested dependencies manually using the nested-deps command:

$ laminas-migration nested-deps [path] [--composer=composer]