PHPackages alexgithubp/laravel-docuware-kubernetes - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. alexgithubp/laravel-docuware-kubernetes ActiveLibrary[API Development](/categories/api) alexgithubp/laravel-docuware-kubernetes ======================================= DocuWare integration with Laravel, with support for kubernetes pods. 1.0.0(2y ago)02.4k↓33.3%MITPHPPHP ^8.0 Since Sep 28Pushed 2y agoCompare [ Source](https://github.com/AlexGitHubP/laravel-docuware-kubernetes)[ Packagist](https://packagist.org/packages/alexgithubp/laravel-docuware-kubernetes)[ Docs](https://github.com/AlexGitHubP/laravel-docuware-kubernetes)[ RSS](/packages/alexgithubp-laravel-docuware-kubernetes/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (9)Versions (2)Used By (0) [![](https://camo.githubusercontent.com/4bf4225c3a9875c26a21fd07b734caaaf83798321885f70528f25cb2ab07dbed/68747470733a2f2f62616e6e6572732e6265796f6e64636f2e64652f4c61726176656c253230446f6375576172652e706e673f7468656d653d6c69676874267061636b6167654d616e616765723d636f6d706f7365722b72657175697265267061636b6167654e616d653d636f64656261722d61672532466c61726176656c2d646f637577617265267061747465726e3d63697263756974426f617264267374796c653d7374796c655f31266465736372697074696f6e3d416e2b6f70696e696f6e617465642b7761792b746f2b696e746567726174652b446f6375576172652b776974682b4c61726176656c266d643d312673686f7757617465726d61726b3d3026666f6e7453697a653d313735707826696d616765733d646f63756d656e742d7265706f7274)](https://camo.githubusercontent.com/4bf4225c3a9875c26a21fd07b734caaaf83798321885f70528f25cb2ab07dbed/68747470733a2f2f62616e6e6572732e6265796f6e64636f2e64652f4c61726176656c253230446f6375576172652e706e673f7468656d653d6c69676874267061636b6167654d616e616765723d636f6d706f7365722b72657175697265267061636b6167654e616d653d636f64656261722d61672532466c61726176656c2d646f637577617265267061747465726e3d63697263756974426f617264267374796c653d7374796c655f31266465736372697074696f6e3d416e2b6f70696e696f6e617465642b7761792b746f2b696e746567726174652b446f6375576172652b776974682b4c61726176656c266d643d312673686f7757617465726d61726b3d3026666f6e7453697a653d313735707826696d616765733d646f63756d656e742d7265706f7274) [![Latest Version on Packagist](https://camo.githubusercontent.com/5741a7d9912f58a5dd57b71327acda1eedd78173ba77db1d9db4add90a40f905/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f636f64656261722d61672f6c61726176656c2d646f6375776172652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/codebar-ag/laravel-docuware)[![Total Downloads](https://camo.githubusercontent.com/b0e4d8d7407c2a516e03d045b00bad2dd79780512e88a7cc06cd28025441193c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f636f64656261722d61672f6c61726176656c2d646f6375776172652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/codebar-ag/laravel-docuware)[![run-tests](https://github.com/codebar-ag/laravel-docuware/actions/workflows/run-tests.yml/badge.svg)](https://github.com/codebar-ag/laravel-docuware/actions/workflows/run-tests.yml)[![Psalm](https://github.com/codebar-ag/laravel-docuware/actions/workflows/psalm.yml/badge.svg)](https://github.com/codebar-ag/laravel-docuware/actions/workflows/psalm.yml)[![Check & fix styling](https://github.com/codebar-ag/laravel-docuware/actions/workflows/php-cs-fixer.yml/badge.svg)](https://github.com/codebar-ag/laravel-docuware/actions/workflows/php-cs-fixer.yml) This package was developed to give you a quick start to communicate with the DocuWare REST API. It is used to query the most common endpoints. ⚠️ This package is not designed as a replacement of the official [DocuWare REST API](https://developer.docuware.com/rest/index.html). See the documentation if you need further functionality. ⚠️ 💡 What is DocuWare? ------------------- [](#-what-is-docuware) DocuWare provides cloud document management and workflow automation software that enables you to digitize, secure and work with business documents, then optimize the processes that power the core of your business. 🛠 Requirements -------------- [](#-requirements) - PHP: `^8.0` - Laravel: `^8.12` - DocuWare Cloud Access ⚙️ Installation --------------- [](#️-installation) You can install the package via composer: ``` composer require codebar-ag/laravel-docuware ``` Add the following environment variables to your `.env` file: ``` DOCUWARE_URL=https://domain.docuware.cloud DOCUWARE_USERNAME=user@domain.test DOCUWARE_PASSWORD=password DOCUWARE_PASSPHRASE="passphrase" ``` With the passphrase we are able to encrypt the URLs. ⚠️ You need to escape backslashes in your passphrase with another backslash: ``` # ❌ Passphrase contains a backslash and is not escaped: DOCUWARE_PASSPHRASE="a#bcd>2~C1'abc\#" # ✅ We need to escape the backslash with another backslash: DOCUWARE_PASSPHRASE="a#bcd>2~C1'abc\\#" ``` 🏗 Usage ------- [](#-usage) ``` use CodebarAg\DocuWare\Facades\DocuWare; /** * Return all file cabinets. */ $cabinets = DocuWare::getFileCabinets(); /** * Return all fields of a file cabinet. */ $fields = DocuWare::getFields($fileCabinetId); /** * Return all dialogs of a file cabinet. */ $dialogs = DocuWare::getDialogs($fileCabinetId); /** * Return all used values for a specific field. */ $values = DocuWare::getSelectList($fileCabinetId, $dialogId, $fieldName); /** * Return a document. */ $document = DocuWare::getDocument($fileCabinetId, $documentId); /** * Return image preview of a document. */ $content = DocuWare::getDocumentPreview($fileCabinetId, $documentId); /** * Download single document. */ $content = DocuWare::downloadDocument($fileCabinetId, $documentId); /** * Download multiple documents. */ $content = DocuWare::downloadDocuments($fileCabinetId, $documentIds); /** * Update value of a indexed field. */ $value = DocuWare::updateDocumentValue($fileCabinetId, $documentId, $fieldName, $newValue); /** * Upload new document. */ $document = DocuWare::uploadDocument($fileCabinetId, $fileContent, $fileName); /** * Upload new document with index values. */ use CodebarAg\DocuWare\DTO\DocumentIndex; $indexes = collect([ DocumentIndex::make('DOCUMENT_TEXT', 'Indexed Text'), DocumentIndex::make('DOCUMENT_NUMBER', 42), ]); $document = DocuWare::uploadDocument( $fileCabinetId, $fileContent, $fileName, $indexes, ); /** * Delete document. */ DocuWare::deleteDocument($fileCabinetId, $documentId); ``` 🔍 Search usage -------------- [](#-search-usage) ``` use CodebarAg\DocuWare\Facades\DocuWare; /** * Most basic example to search for documents. You only need to provide a valid * file cabinet id. */ $id = '87356f8d-e50c-450b-909c-4eaccd318fbf'; $paginator = DocuWare::search() ->fileCabinet($id) ->get(); /** * Search in multiple file cabinets. Provide an array of file cabinet ids. */ $fileCabinetIds = [ '0ee72de3-4258-4353-8020-6a3ff6dd650f', '3f9cb4ff-82f2-44dc-b439-dd648269064f', ]; $paginator = DocuWare::search() ->fileCabinets($fileCabinetIds) ->get(); /** * Find results on the next page. * * Default: 1 */ $paginator = DocuWare::search() ->fileCabinet($id) ->page(2) ->get(); /** * Define the number of results which should be shown per page. * * Default: 50 */ $paginator = DocuWare::search() ->fileCabinet($id) ->perPage(30) ->get(); /** * Use the full-text search. You have to activate full-text search in your file * cabinet before you can use this feature. */ $paginator = DocuWare::search() ->fileCabinet($id) ->fulltext('My secret document') ->get(); /** * Search documents which are created from the first of march. */ $paginator = DocuWare::search() ->fileCabinet($id) ->dateFrom(Carbon::create(2021, 3, 1)) ->get(); /** * Search documents which are created until the first of april. */ $paginator = DocuWare::search() ->fileCabinet($id) ->dateUntil(Carbon::create(2021, 4, 1)) ->get(); /** * Order the results by field name. Supported values: 'asc', 'desc' */ $paginator = DocuWare::search() ->fileCabinet($id) ->orderBy('DWSTOREDATETIME', 'desc') ->get(); /** * Search documents filtered to the value. You can specify multiple filters. */ $paginator = DocuWare::search() ->fileCabinet($id) ->filter('TYPE', 'Order') ->filter('OTHER_FIELD', 'other') ->get(); /** * You can specify the dialog which should be used. */ $dialogId = 'bb42c30a-89fc-4b81-9091-d7e326caba62'; $paginator = DocuWare::search() ->fileCabinet($id) ->dialog($dialogId) ->get(); /** * You can also combine everything. */ $paginator = DocuWare::search() ->fileCabinet($id) ->page(2) ->perPage(30) ->fulltext('My secret document') ->dateFrom(Carbon::create(2021, 3, 1)) ->dateUntil(Carbon::create(2021, 4, 1)) ->filter('TYPE', 'Order') ->filter('OTHER_FIELD', 'other') ->orderBy('DWSTOREDATETIME', 'desc') ->dialog($dialogId) ->get(); ``` 🖼 Make encrypted URL -------------------- [](#-make-encrypted-url) ``` use CodebarAg\DocuWare\Facades\DocuWare; /** * Make encrypted URL for a document in a file cabinet. */ $fileCabinetId = '87356f8d-e50c-450b-909c-4eaccd318fbf'; $documentId = 42; $url = DocuWare::url() ->fileCabinet($fileCabinetId) ->document($documentId) ->make(); /** * Make encrypted URL for a document in a basket. */ $basketId = 'b_87356f8d-e50c-450b-909c-4eaccd318fbf'; $url = DocuWare::url() ->basket($basketId) ->document($documentId) ->make(); /** * Make encrypted URL valid for a specific amount of time. In the example below * the URL is valid for one week. Afterwards the URL is no longer working. */ $url = DocuWare::url() ->fileCabinet($fileCabinetId) ->document($documentId) ->validUntil(now()->addWeek()) ->make(); ``` Please see [Tests](tests/Feature/DocuWareTest.php) for more details. 🏋️ DTO showcase --------------- [](#️-dto-showcase) ``` CodebarAg\DocuWare\DTO\FileCabinet { +id: "2f071481-095d-4363-abd9-29ef845a8b05" // string +name: "Fake File Cabinet" // string +color: "Yellow" // string +isBasket: true // bool +assignedCabinet: "889c13cc-c636-4759-a704-1e6500d2d70f" // string } ``` ``` CodebarAg\DocuWare\DTO\Dialog { +id: "fae3b667-53e9-48dd-9004-34647a26112e" // string +type: "ResultList" // string +label: "Fake Dialog" // string +isDefault: true // boolean +fileCabinetId: "1334c006-f095-4ae7-892b-fe59282c8bed" // string } ``` ``` CodebarAg\DocuWare\DTO\Field { +name: "FAKE_FIELD" // string +label: "Fake Field" // string +type: "Memo" // string +scope: "User" // string ``` ``` CodebarAg\DocuWare\DTO\DocumentField { +name: "FAKE_DOCUMENT_FIELD" // string +label: "Fake Document Field" // string +value: 7680 // integer +type: "Int" // string } ``` ``` CodebarAg\DocuWare\DTO\Document { +id: 659732 // integer +file_size: 765336 // integer +total_pages: 100 // integer +title: "Fake Title" // string +extension: ".pdf" // string +content_type: "application/pdf" // string +file_cabinet_id: "a233b03d-dc63-42dd-b774-25b3ff77548f" // string +created_at: Illuminate\Support\Carbon // Carbon +updated_at: Illuminate\Support\Carbon // Carbon +fields: Illuminate\Support\Collection { // Collection|DocumentField[] #items: array:2 [ 0 => CodebarAg\DocuWare\DTO\DocumentField // DocumentField 1 => CodebarAg\DocuWare\DTO\DocumentField // DocumentField ] } } ``` ``` CodebarAg\DocuWare\DTO\DocumentPaginator +total: 39 // integer +per_page: 10 // integer +current_page: 9 // integer +last_page: 15 // integer +from: 1 // integer +to: 10 // integer +documents: Illuminate\Support\Collection { // Collection|Document[] #items: array:2 [ 0 => CodebarAg\DocuWare\DTO\Document // Document 1 => CodebarAg\DocuWare\DTO\Document // Document ] } +error: CodebarAg\DocuWare\DTO\ErrorBag { // ErrorBag|null +code: 422 // int +message: "'000' is not valid cabinet id" // string } } ``` 🔐 Authentication ---------------- [](#-authentication) You only need to provide correct credentials. Everything else is automatically handled from the package. Under the hood we are storing the authentication cookie in the cache named *docuware.cookies*. But if you need further control you can use the following methods to login and logout with DocuWare: ``` use CodebarAg\DocuWare\Facades\DocuWare; /** * Login with your credentials. You only need to login once. Afterwards the * authentication cookie is stored in the cache `docuware.cookies` and is * used for all further requests. */ DocuWare::login(); /** * Logout your current session. Removes the authentication cookie in the cache. */ DocuWare::logout(); ``` 💥 Exceptions explained ---------------------- [](#-exceptions-explained) - `CodebarAg\DocuWare\Exceptions\UnableToMakeRequest` This is thrown if you are not authorized to make the request. --- - `CodebarAg\DocuWare\Exceptions\UnableToProcessRequest` This is thrown if you passed wrong attributes. For example a file cabinet ID which does not exist. --- - `CodebarAg\DocuWare\Exceptions\UnableToLogin` This exception can only be thrown during the login if the credentials did not match. --- - `CodebarAg\DocuWare\Exceptions\UnableToFindPassphrase` This exception can only be thrown during the url making if the passphrase could not be found. --- - `CodebarAg\DocuWare\Exceptions\UnableToMakeUrl` Something is wrong during the URL making. --- - `Illuminate\Http\Client\RequestException` All other cases if the response is not successfully. ✨ Events -------- [](#-events) Following events will be fired: ``` use CodebarAg\DocuWare\Events\DocuWareResponseLog; // Log each response from the DocuWare REST API. DocuWareResponseLog::class => [ // ], ``` 🔧 Configuration file -------------------- [](#-configuration-file) You can publish the config file with: ``` php artisan vendor:publish --provider="CodebarAg\DocuWare\DocuWareServiceProvider" --tag="docuware-config" ``` This is the contents of the published config file: ```