, (*1)
, (*2)
Juliangut Zend Framework Maintenance Module
Maintenance module for Zend Framework 2., (*3)
Installation
- Best way to install is using Composer:
php composer.phar require juliangut/zf-maintenance
or download it directly from github and place it in your application's module/ directory., (*4)
-
Add Jgut\Zf\Maintenance module to the module section of your config/application.config.php, (*5)
-
Copy config\zf-maintenance.global.php.dist to your config directory and rename it zf-maintenance.global.php, (*6)
-
Install zend-developer-tools (optional), (*7)
php composer.phar require zendframework/zend-developer-tools
Configuration
Configuration example can be found in config\zf-maintenance.global.php.dist, (*8)
use DateTime;
return array(
'zf-maintenance' => array(
// Strategy service to be used on maintenance
'strategy' => 'ZfMaintenanceStrategy',
// Template for the maintenance strategy
'template' => 'zf-maintenance/maintenance',
// Maintenance blocks access to application
'block' => true,
/*
* Maintenance providers
* Different means to activate maintenance mode
*/
'providers' => array(
'ZfMaintenanceConfigProvider' => array(
'active' => false,
),
'ZfMaintenanceConfigScheduledProvider' => array(
'start' => '2020-01-01 00:00:00',
'end' => new DateTime('2020-01-02 05:00:00'),
'message' => 'Undergoing scheduled maintenance tasks',
),
'ZfMaintenanceEnvironmentProvider' => array(
'variable' => 'zf-maintenance',
'value' => 'On',
),
'ZfMaintenanceFileProvider' => array(
'file' => __DIR__ . '/maintenance',
'message' => 'We are currently running maintenance proccesses',
),
'ZfMaintenanceCrontabProvider' => array(
'expression' => '0 0 1 * *', // @monthly
'interval' => 'PT1H', // 1 hour
'message' => 'We are currently running maintenance proccesses',
),
),
/*
* Exceptions to maintenance mode
* Provides a way to bypass maintenance mode by fulfilling at least one of the conditions
*/
'exclusions' => array(
'ZfMaintenanceIpExclusion' => array(
'127.0.0.1', // Localhost
'192.168.1.10', // Private network
),
'ZfMaintenanceRouteExclusion' => array(
'home',
'admin',
),
),
),
);
Strategy
Custom strategy to handle maintenance mode., (*9)
To create your own just extend Jgut\Zf\Maintenance\View\MaintenanceStrategy, (*10)
Template
Template file for maintenance strategy, (*11)
Block
By default maintenance mode prevents application from continuing execution by throwing Zend\Mvc\MvcEvent::EVENT_DISPATCH_ERROR handled by Jgut\Zf\Maintenance\View\MaintenanceStrategy, (*12)
If you don't want maintenance mode to stop execution and show maintenance page then set block to false., (*13)
This can be used in case you are performing maintenance tasks that don't need the application to be shut down, like ddbb backup, ..., (*14)
In this case it is usefull to use maintenanceMessage view helper to show maintenance information, (*15)
Providers
Maintenance mode providers serve different means to activate maintenance mode, (*16)
Providers are checked in the order they appear in providers array, when one provider is active the rest of providers are not checked, (*17)
Common attributes
All maintenance providers have a message attribute used in maintenance strategy page, (*18)
$provider = new ConfigProvider();
$provider->setMessage('custom maintenance mode message');
ConfigProvider
Manual provider, set maintenance mode just by setting active attribute, (*19)
use Jgut\Zf\Maintenance\Provider\ConfigProvider;
$provider = new ConfigProvider();
$provider->setActive(true);
EnvironmentProvider
Environment variable check provider, checks an environment variable to set maintenance mode, (*20)
use Jgut\Zf\Maintenance\Provider\EnvironmentProvider;
putenv('zf-maintenance=On');
$provider = new EnvironmentProvider();
$provider->setVar('zf-maintenance');
$provider->setValue('On');
FileProvider
File provider, verifies the existance of a file to set maintenance mode, (*21)
use Jgut\Zf\Maintenance\Provider\FileProvider;
$provider = new FileProvider();
$provider->setFile(__DIR__ . '/maintenance_file');
Scheduled Providers
Any provider implementing Jgut\Zf\Maintenance\Provider\ScheduledProviderInterface will be used to determine future maintenance situations and used on scheduledMaintenance view helper as well as in zend-developer-tools, (*22)
ConfigScheduledProvider
Manually scheduled maintenance time frame, (*23)
Maintenance mode will be set on during the time span provided by start and end attributes (DateTime valid string or object)., (*24)
If only start provided maintenance mode won't stop once started. If only end provided maintenance mode will be on from this moment and until end time, (*25)
use Jgut\Zf\Maintenance\Provider\ConfigScheduledProvider;
use DateTime;
$provider = new ConfigScheduledProvider();
$provider->setStart('2020-01-01 00:00:00');
$provider->setEnd(new DateTime('2020-01-01 05:00:00')),
CrontabProvider
Scheduled maintenance based on CRON expression syntax, (*26)
* * * * * *
| | | | | |
| | | | | +--- Year [optional]
| | | | +-------- Day of week (0-7) (Sunday=0|7)
| | | +------------- Month (1-12)
| | +------------------ Day of month (1-31)
| +----------------------- Hour (0-23)
+---------------------------- Minute (0-59)
Maintenance mode will be set on during the time span provided by CRON expression and interval attribute (valid DateInterval specification string)., (*27)
use Jgut\Zf\Maintenance\Provider\CrontabProvider;
$provider = new CrontabProvider();
$provider->setExpression('@monthly'); // 0 0 1 * *
$provider->setInterval('PT1H'), // 1 hour
// Maintenance will be ON the 1st of every month at 0:00 during 1 hour
Uses Michael Dowling (mtdowling) cron-expression, (*28)
Exclusions
Conditions to bypass maintenance mode, (*29)
Exclusions are checked the same way as providers are, in the order they are located in exclusions array, when one exclusion is active (isExcluded) the rest of exclusions are not checked, (*30)
IpExclusion
Excludes IPs from maintenance mode, (*31)
use Jgut\Zf\Maintenance\Exclusion\IpExclusion;
use Zend\Http\PhpEnvironment\RemoteAddress;
$excludedIps = array(
'127.0.0.1',
'192.168.1.10',
);
$exclusion = new IpExclusion($excludedIps, new RemoteAddress);
RuteExclusion
Excludes routes from maintenance mode, (*32)
use Jgut\Zf\Maintenance\Exclusion\RouteExclusion;
use Zend\Mvc\Router\RouteMatch;
$excludedRoutes = array(
'routeName',
array(
'controller' => 'controllerName',
),
array(
'controller' => 'controllerName',
'action' => 'actionName',
),
);
$exclusion = new RouteExclusion($excludedRoutes, new RouteMatch);
View helpers
MaintenanceMessage
maintenanceMessage will return the message of current active maintenance provider or empty string if not in maintenance mode, (*33)
Allows you to show maintenance message when maintenance is in non blocking state or for those users for who exclusions apply, (*34)
This helper would normally be used on a general template as application header or footer as an informative area. Mind that if in maintenance blocking mode all requests not bound by exclusions will be redirected to maintenance page, (*35)
$maintenanceMessage = $this->maintenanceMessage();
if ($maintenanceMessage !== '') {
sprintf('<div class="alert alert-info">%s</div>', $maintenanceMessage);
}
ScheduledMaintenance
scheduledMaintenance will return an array with the next scheduled maintenance time period, (*36)
$maintenance = $this->scheduledMaintenance();
// Start or end can be null if not provided
/*
array(
'start' => \DateTime,
'end' => \DateTime,
);
*/
A collector jgut-zf-maintenance-collector is present for
ZendDeveloperTools showing current maintenance status and future scheduled maintenance period times, (*37)
Contributing
Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before, (*38)
See file CONTRIBUTING.md, (*39)
License
Release under BSD-3-Clause License.
See file LICENSE included with the source code for a copy of the license terms, (*40)
Wallogit.com
