DEV Community

loading...
Cover image for CRUD model class

CRUD model class

alexdodonov
PHP developer
・2 min read

CRUD model

This model will help you to create CRUD models for your entitites, and provides you a huge set of methods after a simpe setup.

Installation

Just print in console

composer require mezon/crud-service-model
Enter fullscreen mode Exit fullscreen mode

And that's all )

First steps

Let's define a new class for your DB entity:

class EntityModel extends CrudServiceModel
{
    /**
     * Constructor
     */
    public function __construct()
    {
        parent::__construct('*', 'entity_table_name');
    }
}
Enter fullscreen mode Exit fullscreen mode

In this exact line of code:

parent::__construct('*', 'entity_table_name');
Enter fullscreen mode Exit fullscreen mode

We have specified that we need '*' (all fields) from the table with name 'entity_table_name'.

If you need only some fields from your database, just list them in the first parameter:

parent::__construct('id,field1,field2,field3', 'entity_table_name');
Enter fullscreen mode Exit fullscreen mode

And when you have done this, you will get the following methods.

But before using these methods note that you will need to meet the requirements for some naming conventions.

Field with the primary key must be named as id. I shall add setting to use another name.

Some methods reqire field creation_date for fetching new records for example.

You may add to the table field domain_id for implementing multy instancing out of the box.

Now lets look at available methods:

// Method fetches all new records since the $date
// For example $model->newRecordsSince($domainId, '2021-01-01');
newRecordsSince($domainId, string $date): array;
Enter fullscreen mode Exit fullscreen mode
// Method calculates count of records fetched by filter
// For example $model->recordsCount(false, ['field1 = 1', 'field2 = 2']);
recordsCount($domainId = false, array $where = ['1=1']);
Enter fullscreen mode Exit fullscreen mode
// Method returns data as is without any transformations
getSimpleRecords($domainId, int $from, int $limit, array $where, array $order = []): array;
Enter fullscreen mode Exit fullscreen mode
// Method returns records wich are transformed by method getRecordsTransformer wuch 
// you can override in your subclass
getRecords($domainId, int $from, int $limit, array $where = ['1=1'], array $order = []): array;
Enter fullscreen mode Exit fullscreen mode
// Method returns the last $count records filtered by where
lastRecords($domainId, $count, $where): array;
Enter fullscreen mode Exit fullscreen mode
// Method returns records by their ids
fetchRecordsByIds($domainId, string $ids): array;
Enter fullscreen mode Exit fullscreen mode
// Method calculates count of records grouped by fieldName and filtered by where
recordsCountByField($domainId, string $fieldName, array $where): array;
Enter fullscreen mode Exit fullscreen mode
// Method updates records with values record
updateBasicFields($domainId, array $record, array $where): array;
Enter fullscreen mode Exit fullscreen mode
// Method inserts record record
insertBasicFields(array $record, $domainId = 0): array;
Enter fullscreen mode Exit fullscreen mode
// Method deletes all records filtered by where
deleteFiltered($domainId, array $where): int;
Enter fullscreen mode Exit fullscreen mode

It will be great if you will contribute something to this project. Documentation, sharing the project in your social media, bug fixing, refactoring, or even submitting issue with question or feature request. Thanks anyway )

Discussion (0)