ijodkor/only-office

OnlyOffice package for Laravel/PHP

v1.0.4 2025-05-23 07:33 UTC

Requires

• php: ^8.1
• firebase/php-jwt: ^6.10
• ijodkor/laravel-api-response: ^1.2
• illuminate/contracts: ^9.21|^10.0|^11.0
• illuminate/support: ^9.21|^10.0|^11.0
• spatie/laravel-package-tools: ^1.16|^1.18

Requires (Dev)

• orchestra/testbench: ^7.0|^8.0|^9.0

MIT

• Anvar Zaripboyev
• Azizbek Gulaliyev

README

This is a Laravel package designed to integrate OnlyOffice functionality into Laravel applications. OnlyOffice is an open-source office suite that includes tools for document, spreadsheet, and presentation editing, and supports collaborative editing in real time.

Installation

Install package

composer require only-office

Publish config

php artisan vendor:publish --tag only-office-config

Publish assets

php artisan vendor:publish --tag only-office-assets

Usage

Go to /office/workspace page to open workspace

Document edit/view controller

<?php

namespace App\Http\Controllers;

use Illuminate\Contracts\View\View;
use OnlyOffice\Config\ConfigService;
use OnlyOffice\Config\OfficeConfig;
use OnlyOffice\DocServer\DocFile;
use OnlyOffice\DocServer\FileManagement\FileService;

class TemplateController {

    public function __construct(
        private FileService   $fileService,
        private ConfigService $configService
    ) {
    }

    public function create(): string {
        $filename = "school/document.docx";

        // File
        $example = "new.docx";
        $source = DocFile::getSourcePath($example);

        // File path (/storage/app/private/templates/school/document.docx)
        $path = $this->fileService->storeAs($source, $filename);
        return $path;
    }


    public function show(): View {
        $fileInfo = [
            "directory" => "school",
            "name" => "document.docx",
            'path' => '/app/private/templates/school/document.docx'
        ];

        $config = $this->configService->view([], $fileInfo, ConfigService::FILE_TYPE_DOCX);
        return view('office::index', [
            'config' => array_merge($config, [
                'js' => OfficeConfig::getUrl()
            ])
        ]);
    }


    public function edit(): View {
        $fileInfo = [
            "directory" => "school",
            "name" => "document.docx",
            'path' => '/app/private/templates/school/document.docx'
        ];

        $config = $this->configService->modify([], $fileInfo, ConfigService::FILE_TYPE_DOCX);
        return view('office::index', [
            'config' => array_merge($config, [
                'js' => OfficeConfig::getUrl()
            ])
        ]);
    }
}

There are command controller in package to store file via api

/*** Callback ***/
Route::prefix('/template/document')->group(function () {
    Route::post('/callback', [CallbackController::class, 'handle'])->name('only-office.callback');
    Route::post('/store', [CommandController::class, 'command'])->name('only-office.command');
});

Remainder

All files stored to /storage/app/private path

Requirements

• PHP ^8.1
• Laravel ^8

References

Recommendations

• Use route name in package - It helps to get route in anywhere

Links

• Config 1
• Config
• Callback
• Conversion
• Command
• https://github.com/sibalonat/Dokumentat/blob/main/src/DokumentatServiceProvider.php
• https://jwt.io/

Resources

• Configuring
• OnlyOffice in docker
• Proxy OnlyOffice
• install onlyOffice
• Uninstall onlyOffice in ubuntu
• OnlyOffice in docker
• Office Convertor api
• DocEditor Events

Issues

• [ONLYOFFICE/DocumentServer#1094]
• https://stackoverflow.com/questions/42995866/cant-start-onlyoffice-document-server-without-docker
• https://laracasts.com/discuss/channels/tips/convert-php-array-to-json-in-blade-file

Remainders

!!! Do not use word token as key in document callback url. Because only-office use own token key. And it interrupts custom key. Use key another name (shared_key) for example

Co-author

• Azizbek Gulaliyev