Download the PHP package contenir/contenir-maintenance without Composer

On this page you can find all versions of the php package contenir/contenir-maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of contenir/contenir-maintenance

Informations about the package contenir-maintenance

contenir/contenir-maintenance

Formerly contenir/maintenance; the old package is abandoned in favour of this one.

Continuous Integration codecov

Framework-agnostic maintenance-mode toggle for Contenir CMS.

The CMS writes a maintenance flag (and optional message); the consuming Site (Mezzio, Laminas MVC, anything else) reads it on every request and returns 503 with the message until the flag is cleared.

This package provides the domain: a small immutable state value plus a repository interface, with file-based and in-memory implementations. Framework-specific middleware and listeners come from sibling packages such as contenir/contenir-maintenance-laminas-mvc.

Requirements

The 0.x releases, which support PHP 8.1, remain available from the 0.x branch and v0.* tags; see UPGRADE-2.0.md.

Install

Usage

MaintenanceState

An immutable value with three public readonly properties:

Property Type Meaning
active bool Whether the Site should serve 503
message string Operator message shown on the 503 page; '' when inactive
since ?DateTimeImmutable When maintenance was switched on; always null when inactive

MaintenanceRepositoryInterface

Implementations treat a missing or unreadable backing store as inactive rather than throwing; write failures must throw so the admin UI can show them.

Repository\FileRepository (admin side)

Writes are atomic and invalidate the file's opcache entry (via contenir/contenir-config). A failed write throws Contenir\Config\Exception\WriteException, a RuntimeException, with a message such as Cannot write maintenance state to "...".

File format

FileRepository reads and writes a Laminas/Mezzio-style config file, so the Site can drop it into config/autoload/ and have it merged into the application config:

The repository owns only maintenance.state. Other top-level keys, and sibling keys under maintenance, are preserved on save.

On read:

Repository\InMemoryRepository

Holds state in memory. It is shipped in src/ so Sites can build state from their merged config without touching the filesystem, and so consumers can use it in their own tests:

Development

The QA toolchain is contenir/contenir-qa-tools. Mago is a standalone binary, installed separately (brew install mago).

License

MIT. See LICENSE.

All versions of contenir-maintenance with dependencies

PHP Build Version
Package Version
Requires php Version ~8.3.0 || ~8.4.0 || ~8.5.0
contenir/contenir-config Version ^2.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package contenir/contenir-maintenance contains the following files

Loading the files please wait ...