WOPI Bundle
A Symfony bundle to facilitate the implementation of the WOPI endpoints and protocol.
Description
The Web Application Open Platform Interface (WOPI) protocol let you integrate Office for the web with your application. The WOPI protocol enables Office for the web to access and change files that are stored in your service.
Office for the web platforms:
Installation
composer require champs-libres/wopi-bundle
Usage
There are many different ways to store documents in an application. Therefore, this bundle does not provide a specific implementation of the WOPI protocol described through a basic interface from the champs-libres/wopi-lib bundle.
Thus, this bundle only provides the glue code between Symfony and champs-libres/wopi-lib.
It provides:
- The routes that the WOPI protocol needs
- A controller to for the WOPI routes
In order to use it, you must provide, through dependency injection, your own implementation of a service implementing the WOPI interface from champs-libres/wopi-lib.
With Symfony, bind your custom implementation to an alias as such in services.php:
<?php
declare(strict_types=1);
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
use ChampsLibres\WopiLib\WopiInterface;
use App\Service\CustomWopiImplementation;
return static function (ContainerConfigurator $container) {
$services = $container->services();
$services
->defaults()
->autoconfigure(true)
->autowire(true);
$services
->alias(WopiInterface::class, CustomWopiImplementation::class);
};
Documentation
Code quality, tests, benchmarks
Every time changes are introduced into the library, Github runs the tests.
The library has tests written with PHPSpec. Feel free to check them out in the spec directory. Run composer phpspec to trigger the tests.
Before each commit, some inspections are executed with GrumPHP; run composer grumphp to check manually.
The quality of the tests is tested with Infection a PHP Mutation testing framework, run composer infection to try it.
Static analyzers are also controlling the code. PHPStan and PSalm are enabled to their maximum level.
Contributing
Feel free to contribute to this project by submitting pull requests on Github.
Changelog
See CHANGELOG.md for a changelog based on git commits.
For more detailed changelogs, please check the release changelogs.
10 Nov 12, 2022
720 Dec 25, 2022
283 Dec 15, 2022
199 Jan 3, 2023
35 Nov 17, 2022
7 Oct 20, 2022
27 Jul 7, 2022
6 Aug 31, 2022
8 Dec 19, 2022
6 Dec 15, 2022
240 Jan 4, 2023
2 Oct 7, 2022
2 Nov 19, 2021
4 Apr 19, 2022
23 Aug 28, 2022
12 Dec 14, 2022
3 Sep 10, 2021
7 Aug 3, 2022
2.1k Jan 6, 2023