PHPackages imagina/requestable-module - 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. imagina/requestable-module ActiveAsgard-module imagina/requestable-module ========================== v10.x-dev(1y ago)024771MITPHPPHP ^8.1CI passing Since Dec 19Pushed 1y ago3 watchersCompare [ Source](https://github.com/imagina/imaginacms-requestable)[ Packagist](https://packagist.org/packages/imagina/requestable-module)[ RSS](/packages/imagina-requestable-module/feed)WikiDiscussions v8.x Synced 5d ago READMEChangelogDependencies (5)Versions (5)Used By (1) Requestable Imagina Module ========================== [](#requestable-imagina-module) Requestable it's a module for Imagina CMS open source fully customizable for entrepreneurs around the world. \###Seeder config This module has a seed in charge of going through all the configurations of the enabled modules looking for a configuration named 'requestable' with which it creates the necessary categories and statuses in the database, such config must be an array of arrays and needs to have the following structure: ``` /* |-------------------------------------------------------------------------- | Requestable config |-------------------------------------------------------------------------- */ "requestable" => [ 1 => [ //Required: this is the identificator of the request, must be unique with respect to other requestable types "type" => "nameOfTheRequest", // Title can be trantaled or not, the language take the config app.locale "title" => "module::tranlation.requestable1.title", // Time elapsed to cancel in days "timeElapsedToCancel" => 30, /* Optional: Path of the Entity related to the requestable The requestable Id can be saved in the requestable if the requestableType is Modules\\User\\Entities\\Sentinel\\User the id can be taked automatically of the Auth User if the id it's not specified */ "requestableType" => "Modules\\ModuleName\\Entities\\EntityName", // Optional: this form is used to get the fields data of the requestable, need to be a setting name previously charged with the formId "formId" => "module::settingNameForm", // Optional: This columns has true by default "internal" => false, //requestable events to dispatch "events" => [ "create" => "Modules\\ModuleName\\Events\\EventDispatchedWhenRequestWasCreated", "update" => "Modules\\ModuleName\\Events\\EventDispatchedWhenRequestWasUpdated", "delete" => "Modules\\ModuleName\\Events\\EventDispatchedWhenRequestWasDeleted", "etaUpdated" => "Modules\\ModuleName\\Events\\EventDispatchedWhenRequestEtaWasUpdated", ], /* The module has four statuses by default with the following structure: const PENDING = 1; (default) const INPROGRESS = 2; const COMPLETED = 3; (final) const CANCELLED = 4; (final) */ "useDefaultStatuses" => true, //Optional: if the useDefaultStatuses is true, statuses is ignored "statuses" => [ 1 => [ "id" => 1, "title" => "module::translation.status1.title", // Title can be trantaled or not, the language take the config app.locale "final" => false, //optional (default false) "default" => true, "delete_request" => false, //optional (default false) "cancelled_elapsed_time" => false, "events" => "Modules\\ModuleName\\Events\\RequestInStatus1" //optional (default null) ], 2 => [ "id" => 2, "title" => "module::translation.status2.title", "final" => true, "default" => false, "delete_request" => true, "cancelled_elapsed_time" => true, "events" => [ //optional can be multiple too "Modules\\ModuleName\\Events\\RequestInStatus2", "Modules\\ModuleName\\Events\\RequestInStatus2SecondEvent" ] ], . . . "N" => [ "id" => "N", "title" => "module::translation.statusN.title" "final" => true/false, "default" => true/false, "delete_request" => true/false, "cancelled_elapsed_time" => true/false, "events" => [ "Modules\\ModuleName\\Events\\RequestInStatusN", "Modules\\ModuleName\\Events\\RequestInStatusNSecondEvent" ] ], ], //if you don't use the statuses configuration but you need to configure the delete request by status you can use this extra config: 'deleteRequestWhenStatus' => [ 1 => false, 2 => true, 3 => false, 4 => true ], //if you don't use the statuses configuration but you need to configure the events by status you can use this extra config: "eventsWhenStatus" => [ 2 => "Modules\\ModuleName\\Events\\RequestInStatus2", 3 => [ "Modules\\ModuleName\\Events\\RequestInStatus3", "Modules\\ModuleName\\Events\\RequestInStatus3SecondEvent" ], ], /* Optional: If you don't use this config and the useDefaultStatuses is true the default status used is 1 if you use the statuses and defined some one by default that's would be the status applied. */ 'defaultStatus' => 1, //Optional: if you don't use the statuses configuration but you need to configure the cancelled when elapsed time status you can use this extra config: "statusToSetWhenElapsedTime" => 4, ] ] ``` - Note: All the information obtained from the config is stored in the database in Category and Status models, which can then be customized if necessary via api. \###Api The module has implemented the standard json:api in all its entities so that it can be consumed with the endpoint prefix: `api/requestable/v1` \###Services There is a service to create and update request to be consumed by the backend itself when needed. `Modules\Requestable\Services\RequestableService` Example of data to the service create: ``` $requestableService = app("Modules\Requestable\Services\RequestableService"); $requestableService->create([ "type":"withdrawalFunds", "fields": [ { "name": "amount", "value": 43000 } ] ]); ``` Example of data to the service update: ``` $requestableService = app("Modules\Requestable\Services\RequestableService"); $requestableService->update(11, [ //if you know the status_id in the database you can send status_id, but if only know the status value defined in the config just send status "status": 2, "eta": "2021-06-21" ]); ``` All the rest of the request configuration is taken from the information obtained from the config with the same type \###Events The module is very customizable when you need it to execute events, in each type of enabled event different parameters are sent: EventParameterscreated$requestupdated$updatedRequest - $oldRequestdeleted$deletedRequestetaUpdated$updatedRequest - $oldRequest### JOBS to Automation Rules [](#jobs-to-automation-rules) #### Migration Commands [](#migration-commands) ``` php artisan queue:table ``` ``` php artisan queue:failed-table ``` #### Extra Commands [](#extra-commands) ``` php artisan queue:restart ``` #### File .env [](#file-env) ``` QUEUE_CONNECTION=database ``` #### Migrate jobs table [](#migrate-jobs-table) ``` php artisan migrate ``` ### Reports [](#reports) #### Create Multiples Reports [](#create-multiples-reports) 1. Add a new "option" in reportType ("config.exportable.requestables.exportFields.reportType") example: ``` ['label' => 'requestable::exports.exportFields.type.mynew', 'value' => "mynew"], ``` 2. Go to Requestable/Exports/Reports/" and copy the file from other report (Ej: detailedReport.php) and set name to the file (mynewReport.php) and the new class (class mynewReport) with the same value from the option created above Example: ``` mynewReport.php ``` 3. To set the Heading use the method "getHeading" in the new file. ``` public function getHeading() { //your nice code here } ``` 4. To set each Row use the method "getMap" in the new file. ``` public function getMap($item) { //your nice code here } ``` 5. If you need a method from the RequestableExport you can use: ``` $this->requestableExport ``` ### Health Score 31 — LowBetter than 68% of packages Maintenance42 Moderate activity, may be stable Popularity14 Limited adoption so far Community22 Small or concentrated contributor base Maturity44 Maturing project, gaining track record Bus Factor1 Top contributor holds 50.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 2 Last Release 473d ago Major Versions v8.x-dev → v10.x-dev2025-01-29 PHP version history (2 changes)v8.x-devPHP ^7.1.3 v10.x-devPHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/2bc4bd5d733cfbe7e145670fbb1539bdb8d33f43c2cca4f26a119d37dfbad62f?d=identicon)[imagina](/maintainers/imagina) --- Top Contributors [![willvrd](https://avatars.githubusercontent.com/u/8865099?v=4)](https://github.com/willvrd "willvrd (157 commits)")[![JCEC007](https://avatars.githubusercontent.com/u/7571125?v=4)](https://github.com/JCEC007 "JCEC007 (85 commits)")[![CristianMarin19](https://avatars.githubusercontent.com/u/54483189?v=4)](https://github.com/CristianMarin19 "CristianMarin19 (31 commits)")[![msolanoimagina](https://avatars.githubusercontent.com/u/121646384?v=4)](https://github.com/msolanoimagina "msolanoimagina (16 commits)")[![imagina](https://avatars.githubusercontent.com/u/758247?v=4)](https://github.com/imagina "imagina (10 commits)")[![msolanorenuity](https://avatars.githubusercontent.com/u/121646154?v=4)](https://github.com/msolanorenuity "msolanorenuity (4 commits)")[![msolanogithub](https://avatars.githubusercontent.com/u/38920570?v=4)](https://github.com/msolanogithub "msolanogithub (3 commits)")[![Nikos1010](https://avatars.githubusercontent.com/u/80610151?v=4)](https://github.com/Nikos1010 "Nikos1010 (2 commits)")[![IMNicolasM](https://avatars.githubusercontent.com/u/143624699?v=4)](https://github.com/IMNicolasM "IMNicolasM (1 commits)")[![wilmerace2793](https://avatars.githubusercontent.com/u/108033674?v=4)](https://github.com/wilmerace2793 "wilmerace2793 (1 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/imagina-requestable-module/health.svg) ``` [![Health](https://phpackages.com/badges/imagina-requestable-module/health.svg)](https://phpackages.com/packages/imagina-requestable-module) ``` ### Alternatives [elgg/elgg Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities and associations to create their own fully-featured social networks and applications. 1.7k15.7k5](/packages/elgg-elgg)[pressbooks/pressbooks Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS. 44643.1k1](/packages/pressbooks-pressbooks)[rainlab/blog-plugin Blog plugin for October CMS 17257.7k](/packages/rainlab-blog-plugin)[rainlab/user-plugin User plugin for October CMS 11954.3k13](/packages/rainlab-user-plugin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)