PHPackages                             jsadways/operationrecord - 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. [Utility & Helpers](/categories/utility)
4. /
5. jsadways/operationrecord

ActiveLibrary[Utility & Helpers](/categories/utility)

jsadways/operationrecord
========================

1.0.20(5mo ago)0289↓82.2%1PHP

Since Aug 14Pushed 5mo ago1 watchersCompare

[ Source](https://github.com/JsAdways/operationRecord)[ Packagist](https://packagist.org/packages/jsadways/operationrecord)[ RSS](/packages/jsadways-operationrecord/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (3)Versions (29)Used By (1)

Install
-------

[](#install)

step1 use docker-compose set up a MongoDB Server

```
version: "3.3"

services:
  mongo:
    container_name: mongo
    image: mongo:7.0.12
    restart: unless-stopped
    environment:
      - MONGO_INITDB_ROOT_USERNAME=admin
      - MONGO_INITDB_ROOT_PASSWORD=123456
    ports:
      - 27017:27017
    volumes:
      - mongo-data:/data/db
    networks:
      - dev
networks:
  dev:
volumes:
  mongo-data:

```

step2 install package

```
composer require jsadways/operationrecord

```

step3 : edit config/database.php

```
'connections' => [
    ...
    'mongodb' => [
        'driver' => 'mongodb',
        'dsn' => env('MONGO_DB_URI'),
        'database' => env('MONGO_DB_DATABASE', 'forge'),
    ]
    ...
]

```

step4: add element in .env file

```
MONGO_DB_URI=mongodb://admin:123456@SERVER_LOCATION
MONGO_DB_DATABASE=YOUR_DB_NAME

```

---

Support functions and arguments
-------------------------------

[](#support-functions-and-arguments)

1. set(SetDto) : set data to MongoDB collection
2. get(array $filter) : get one document form MongoDB collection
3. list(ListDto) : get list of document form MongoDB collection

- SetDto : Object contains $data\_id,$creator\_id,$action\_name,$data(\*optional)
- ListDto : Object contains $filter,$sort\_by,$sort\_order,$per\_page,$show\_diff
- array filter : check filter usage from [JsAdways/scopeFilter](https://github.com/JsAdways/scopeFilter)

Usage
-----

[](#usage)

create a model

- this mode describes how to store records to MongoDB
- use artisan command : php artisan make:operation-record Record --table=example\_record
- the result will be :

```
#app/Models/ExampleRecord.php