maglnet / magl-legacy-application
Provides a laminas module that is able to run legacy applications with the power of laminas.
Installs: 33 924
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 6
Forks: 4
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- laminas/laminas-eventmanager: ^3.0
- laminas/laminas-http: ^2.0
- laminas/laminas-mvc: ^3.0
- laminas/laminas-router: ^3.0
- laminas/laminas-servicemanager: ^3.0
- laminas/laminas-stdlib: ^3.0
- laminas/laminas-view: ^2.5
Requires (Dev)
- laminas/laminas-modulemanager: ^2.5
- laminas/laminas-test: ^3.0
- phpunit/phpunit: ^9
README
Run your legacy applications within Laminas.
Introduction
Since rewriting your legacy application from scratch to a Laminas application could be nearly impossible due to time, effort, and resources, I was searching for a way to migrate a legacy application to a Laminas application.
A great article by Chris Abernethy described a way on how to run your legacy application within ZF1, so I migrated this HowTo to a small Laminas module, to be able to run a legacy application within Laminas.
While running your legacy application within a Laminas application it is possible to slowly migrate an existing application
to Laminas by leaving your old application (nearly - see "Adjust your legacy Application") untouched and build new modules
with the power of Laminas.
By adding a simple wrapper (see "Using Laminas within your legacy application") you could also use the new modules
within your legacy application.
Installation
Install through composer
{ "require" : { "maglnet/magl-legacy-application" : "*" } }
Enable the module within your Laminas application.config.php
'modules' => array( 'Application', 'MaglLegacyApplication', ),
Copy the provided file data/magl-laminas-legacy-wrapper.php
to your public/
folder.
Copy the provided file data/.htaccess
to your publix folder.
Copy your legacy Application to your public/
folder.
Your legacy application should now run within Laminas. :)
Configuration
For any SEO optimized route within your legacy application, add a route to the zend router that
routes to legacy controller and remove the mod_rewrite rules from your .htaccess
return array( 'router' => array( 'routes' => array( // example for transferring mod rewrite rules to laminas routes 'legacy-seo-calendar' => array( 'type' => 'Laminas\Mvc\Router\Http\Regex', 'options' => array( 'regex' => '/calendar/(?<foo>.+)', 'defaults' => array( 'controller' => 'MaglLegacyApplication\Controller\Legacy', 'action' => 'index', 'script' => 'index-already-seo-optimized.php', ), 'spec' => '/', ), ), ), ), );
Adjust your legacy Application
There are several cases in which your legacy application won't run without additional adjustments, here are some of them:
Relative Paths
Using relative paths for require
, require_once
or includes
will possibly fail now, since Laminas will do a chdir()
to the Laminas' application root. So you will need to adjust your paths to match the new root.
Example:
include '../lib/somelib.php';
should be changed to:
include __DIR__ . '/../lib/somelib.php';
Using Globals / Server SCRIPT_FILENAME
or SCRIPT_NAME
Because of mod_rewrite
rules, SCRIPT_FILENAME
and SCRIPT_NAME
won't be your real script anymore.
If you use these variables, you need to adjust these places within your legacy application:
Example:
$script_filename = $_SERVER['SCRIPT_FILENAME']; $script_name = $_SERVER['SCRIPT_NAME'];
should be changed to:
use MaglLegacyApplication\Application\MaglLegacy; $legacy = MaglLegacy::getInstance(); $script_filename = $legacy->getLegacyScriptFilename(); $script_name = $legacy->getLegacyScriptName();
Using Laminas within your legacy application
use MaglLegacyApplication\Application\MaglLegacy; $application = MaglLegacy::getInstance()->getApplication(); $yourService = $application->getServiceManager()->get('YourService');
Injecting responses from within your legacy application
from wherever you are within your legacy application, it is possible to bypass your legacy applications controller code and send a response to the Laminas Controller wrapper. This response will then be handled like within a normal Laminas controller.
use MaglLegacyApplication\Application\MaglLegacy; $application = MaglLegacy::getInstance()->getApplication(); $application->getEventManager()->getSharedManager()->attach('*', MaglLegacy::EVENT_SHORT_CIRCUIT_RESPONSE, function(Event $e){ $response = new \Laminas\Http\Response(); $response->setStatusCode(404); $response->setContent('not found'); $e->stopPropagation(true); return $response; });
Contributing
If you have questions or problems regarding this module just open an issue or, even better, solve it and open a pull request. 👍