{"id":291,"date":"2023-01-21T20:35:22","date_gmt":"2023-01-21T17:35:22","guid":{"rendered":"https:\/\/akaunting.com\/hc\/?post_type=docs&p=291"},"modified":"2023-01-21T20:36:15","modified_gmt":"2023-01-21T17:36:15","slug":"beyond-crud","status":"publish","type":"docs","link":"https:\/\/akaunting.com\/hc\/docs\/developers\/beyond-crud\/","title":{"rendered":"Beyond CRUD"},"content":{"rendered":"\n

In this article you\u2019ll learn how to make a Blog<\/strong> module with beyond CRUD functions for admin and shown in the client portal.<\/p>\n\n\n\n

my-blog<\/code>\u00a0is the alias aka unique identifier of the\u00a0module<\/a>.<\/p>\n\n\n\n

Download<\/h3>\n\n\n\n

You can get the ready-to-use files from GitHub<\/a> or apply the following steps to create the same module.<\/p>\n\n\n\n

Scaffold<\/h3>\n\n\n\n

First of all, generate the scaffold by running the following command:<\/p>\n\n\n\n

php artisan module:make my-blog<\/code><\/pre>\n\n\n\n
Migrations<\/h3>\n\n\n\n
Before installing the module, create the database tables:<\/p>\n\n\n\n
php artisan module:make-migration my_blog_v1 my-blog<\/code><\/pre>\n\n\n\n
The command will create the migration<\/a> file into modules\/MyBlog\/Database\/Migrations<\/code> folder.<\/p>\n\n\n\n
Installation<\/h3>\n\n\n\n
Now you can install the module. Akaunting will also run the migrations.<\/p>\n\n\n\n
php artisan module:install my-blog 1<\/code><\/pre>\n\n\n\n
Model<\/h3>\n\n\n\n
Create the model<\/a> by using the following command:<\/p>\n\n\n\n
php artisan module:make-model Post my-blog --fillable=company_id,name,description,category_id,enabled,created_by<\/code><\/pre>\n\n\n\n
Routes<\/h3>\n\n\n\n
The scaffold comes with 2 route files<\/a>. Add the controllers for both admin and portal.<\/p>\n\n\n\n
Controllers<\/h3>\n\n\n\n
By default, a Main<\/code> controller is automatically created when you make a module. However, in this case, you need a separate controller for admin and another one for portal. So create them using the following commands:<\/p>\n\n\n\n
php artisan module:make-controller Posts my-blog\nphp artisan module:make-controller Portal\\Posts my-blog<\/code><\/pre>\n\n\n\n
You should also add the new controllers to the\u00a0FinishInstallation<\/code>\u00a0listener<\/a>\u00a0as mentioned in the\u00a0Permissions<\/a>\u00a0article.<\/p>\n\n\n\n
Jobs<\/h3>\n\n\n\n
Akaunting uses the Job<\/strong> kind of action to Create<\/code>, Update<\/code>, and Delete<\/code> records. It makes that code re-usable in other places such as API, console, etc.<\/p>\n\n\n\n
php artisan module:make-job CreatePost my-blog --sync\nphp artisan module:make-job UpdatePost my-blog --sync\nphp artisan module:make-job DeletePost my-blog --sync<\/code><\/pre>\n\n\n\n
Check out the CreateItem<\/a> or DeleteCompany<\/a> jobs for real-life examples.<\/p>\n\n\n\n
Search String<\/h3>\n\n\n\n
Akaunting uses the Search String<\/a> package in the backend to search and filter the records. To make the module compatible, create a search-string.php<\/code> config file referring to the model, merge it to the core config in the service provider, and put a couple of lines in the index.blade.php<\/code> file, Akaunting will do the frontend magic.<\/p>\n\n\n\n
Menu<\/h3>\n\n\n\n
In order to show the blog in the menu (left sidebar), you should listen to the AdminCreated<\/code> and PortalCreated<\/code> events, separately.<\/p>\n\n\n\n
Language<\/h3>\n\n\n\n
The language file is Resources\/lang\/en-GB\/general.php<\/code> .<\/p>\n","protected":false},"excerpt":{"rendered":"
In this article you\u2019ll learn how to make a Blog module with beyond CRUD functions for admin and shown in the client portal. my-blog\u00a0is the alias aka unique identifier of the\u00a0module. Download You can get the ready-to-use files from GitHub or apply the following steps to create the same module. Scaffold First of all, generate the scaffold by running […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":31,"menu_order":12,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-291","docs","type-docs","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/291","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/comments?post=291"}],"version-history":[{"count":2,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/291\/revisions"}],"predecessor-version":[{"id":293,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/291\/revisions\/293"}],"up":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/31"}],"wp:attachment":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/media?parent=291"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/doc_tag?post=291"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}