Download the PHP package klongchu/bud-docuware without Composer

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. See the documentation if you need further functionality. ⚠️

💡 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

> = v3.0

• PHP: `^8.2``
• Laravel: ^10.*
• DocuWare Cloud Access

> = v2.0

• PHP: ^8.1 |^8.2
• Laravel: ^9.* | ^10.*
• DocuWare Cloud Access

> = v1.2

• PHP: ^8.1
• Laravel: ^9.*
• DocuWare Cloud Access

< v1.2

• PHP: ^8.0
• Laravel: ^8.*
• DocuWare Cloud Access

⚙️ Installation

You can install the package via composer:

Add the following environment variables to your .env file: The "DOCUWARE_COOKIES" variable is optional and only used if you want to set the request cookie manually.

With the passphrase we are able to encrypt the URLs.

⚠️ You need to escape backslashes in your passphrase with another backslash:

🏗 Usage

🔍 Search usage

🖼 Make encrypted URL

Please see Tests for more details.

🏋️ DTO showcase

🔐 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.

You can run php artisan docuware:list-auth-cookie command to get your auth session that you can use in your .env file DOCUWARE_COOKIES key.

But if you need further control you can use the following methods to login and logout with DocuWare:

Manual authentication

If you want to provide your own authentication cookie you can use the following connector to authenticate with the DocuWare REST API:

📦 Caching requests

All Get Requests are cachable and will be cached by default.

To determine if the response is cached you can use the following method:

To invalidate the cache for a specific request you can use the following method:

To temporarily disable caching for a specific request you can use the following method:

💥 Exceptions explained

• Klongchu\DocuWare\Exceptions\UnableToMakeRequest

This is thrown if you are not authorized to make the request.

• Klongchu\DocuWare\Exceptions\UnableToProcessRequest

This is thrown if you passed wrong attributes. For example a file cabinet ID which does not exist.

• Klongchu\DocuWare\Exceptions\UnableToLogin

This exception can only be thrown during the login if the credentials did not match.

• Klongchu\DocuWare\Exceptions\UnableToLoginNoCookies

This exception can only be thrown during the login if there was no cookies in the response from the api.

• Klongchu\DocuWare\Exceptions\UnableToFindPassphrase

This exception can only be thrown during the url making if the passphrase could not be found.

• Klongchu\DocuWare\Exceptions\UnableToMakeUrl

Something is wrong during the URL making.

• Klongchu\DocuWare\Exceptions\UnableToUpdateFields

No fields were supplied.

• Klongchu\DocuWare\Exceptions\UnableToGetDocumentCount

Something is wrong with the response from getting the document count.

• Illuminate\Http\Client\RequestException

All other cases if the response is not successfully.

✨ Events

Following events will be fired:

🔧 Configuration file

You can publish the config file with:

This is the contents of the published config file:

🚧 Testing

Copy your own phpunit.xml-file.

Modify environment variables in the phpunit.xml-file:

Run the tests:

📝 Changelog

Please see CHANGELOG for more information on what has changed recently.

✏️ Contributing

Please see CONTRIBUTING for details.

🧑‍💻 Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

🙏 Credits

• Sebastian Fix
• Rhys Lees
• All Contributors
• Skeleton Repository from Spatie
• Laravel Package Training from Spatie

🎭 License

The MIT License (MIT). Please see License File for more information.