Download the PHP package codebar-ag/laravel-zammad without Composer
On this page you can find all versions of the php package codebar-ag/laravel-zammad. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codebar-ag/laravel-zammad
More information about codebar-ag/laravel-zammad
Files in codebar-ag/laravel-zammad
Package laravel-zammad
Short Description Zammad integration with Laravel
License MIT
Homepage https://github.com/codebar-ag/laravel-zammad
Informations about the package laravel-zammad
This package was developed to give you a quick start to communicate with the Zammad REST API. It is used to query the most common endpoints.
⚠️ This package is not designed as a replacement of the official Zammad REST API. See the documentation if you need further functionality. ⚠️
💡 What is Zammad?
Zammad is a web-based open source helpdesk/customer support system with many features to manage customer communication.
🛠 Requirements
Package | PHP | Laravel | Zammad |
---|---|---|---|
>v3.0 | >8.2 | > Laravel 10.0 | ✅ |
>v2.0 | >8.1 | > Laravel 9.0 | ✅ |
>v1.0 | >8.0 | > Laravel 8.12 | ✅ |
⚙️ Installation
You can install the package via composer:
Add the following environment variables to your .env
file:
🔑 Where can I find the token?
Go to your profile page in your Zammad application. In the tab Token Access you can create your token. Be sure to activate all rights you need.
👉 Make sure to activate HTTP Token Authentication in your system settings.
📝 How to add dynamic ticket attributes?
- Publish your configuration file (see chapter
🔧 Configuration file
). - Add attributes to the ticket key:
🏗 Usage
👶 User Resource
🎫 Ticket Resource
💬 Comment Resource
🏠 Object Resource
🧷 Attachment Resource
Expanding response payloads
You can use the expand()
method to expand the response with additional data.
See documentation on this in the Zammad API Docs.
Limit search response payloads
You can use the limit(int $limit = 1)
method to expand the response with additional data.
See documentation on this in the Zammad API Docs.
Paginate list response payloads
You can use the perPage(int $perPage)
and page(int $page)
methods to set the page and per page values for the
response
Alternatively you can use the paginate(int $page, int $perPage):
method to set both at once.
See documentation on this in the Zammad API Docs.
🏋️ DTO showcase
🔧 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.
Code Style
🧑💻 Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
🙏 Credits
- Sebastian Fix
- Ruslan Steiger
- All Contributors
- Skeleton Repository from Spatie
- Laravel Package Training from Spatie
🎭 License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-zammad with dependencies
guzzlehttp/guzzle Version ^7.8.1
illuminate/contracts Version ^10.0
spatie/laravel-package-tools Version ^1.16
saloonphp/laravel-plugin Version ^3.3
saloonphp/saloon Version ^3.6