Create custom models for modules

[DennisHermannsen]

Hi.

For convenience, I wanted to create a custom model for my module. I didn't like having to call Capsule every time I needed information that the module stored in the database.
I want to share the code here in case other people didn't know how to do it but also to gather some feedback on this way of doing it.

<?php

namespace WHMCS\Module\Addon\MyModule;

use WHMCS\Model\AbstractModel;

/**
 * Convenience model for custom modules
 */

class MyModel extends AbstractModel
{
    // Set the table that should be used for searching
    protected $table = 'mod_mymodule';

    // We almost always have access to the service ID. Has to represent a column in the mod_mymodule table
    protected $primaryKey = 'serviceid';
}

When using the model, we're able to do MyModule::find() or create a new instance using 'new MyModule()'.

 

Edited November 9, 2022 by DennisHermannsen

[steven99]

Just a quick note, nearly every Eloquent (Laravel database manager) information will apply here. 

[DennisHermannsen]

@steven99 the keyword in your post is "nearly". I can't count how many times I've tried to use an Eloquent function in WHMCS that for some reason wasn't implemented 😅