README

Giới thiệu

Một lớp kho lưu trữ cơ sở cho Eloquent với các phương thức tiện lợi bao gồm hầu hết các truy vấn. Hữu ích để tóm tắt lớp bền vững của bạn từ mã doanh nghiệp của bạn.

Dành riêng cho Genie

Dành riêng cho Thần đèn Chúc mừng sự tự do.

Cài đặt

composer require ninhtqse/genie

Thực hiện

Các ví dụ sẽ sử dụng Eloquent model giả định có tên là User.

<?php

namespace App\Repositories;

use App\Models\User;
use Ninhtqse\Genie\Repository;

class UserRepository extends Repository
{
    protected function getModel()
    {
        return new User;
    }
}

Tùy chọn

Genie đã được tích hợp với ninhtqse\bruno. Xem tài liệu để biết thêm thông tin. Biến $options được cung cấp bởi tất cả các phương thức get có định dạng sau:

Parameter	Kiểu dữ liệu	Mô tả
includes	array	Mảng các mối quan hệ để tải eager load
sort	array	Mảng các quy tắc sắp xếp, e.g. `[['key' => 'username', 'direction' => 'ASC']]`
filter_groups	array	Xem tài liệu Bruno
limit	int	Hàng trên mỗi trang
page	int	Trang để bắt đầu (sử dụng có giới hạn)
fields	array	Nhận các trường theo các tham số được truyền vào.
skip	integer	Vị trí bắt đầu nằm trong cơ sở dữ liệu
take	integer	Số lượng bản ghi muốn lấy

Lưu ý: Nếu bạn sử dụng bộ điều khiển của Bruno, nó sẽ tự động phân tích cú pháp của yêu cầu chuỗi truy vấn thành định dạng chính xác.

API

Các ví dụ sẽ sử dụng một giả thuyết Eloquent model tên User.

get (array $options = [])

lấy ra tất cả bản ghi User

getById ($id, array $options = [])

Lấy ra 1 bản ghi của User theo khóa chính

getRecent (array $options = [])

Lấy bản ghi của User sắp xếp theo created_at giảm dần

getRecentWhere (string $column, mixed $value, array $options = [])

Lấy ra bản ghi của User theo điều kiện $column=$value, sắp xếp created_at giảm dần

getWhere (string $column, mixed $value, array $options = [])

Lấy ra bản ghi của User theo điều kiện $column=$value

getWhereArray (array $clauses, array $options = [])

Lấy ra bản ghi của User theo một bảng các điều kiện được truyền vào ([$column1 => $value1, $column2 => $value2])

getWhereIn (string $column, array $values, array $options = [])

Lấy ra bản ghi của User theo giá trị $column có thể nằm trong mảng $values

getLatest (array $options = [])

Lấy ra bản ghi của User được thêm vào gần đây nhất

getLatestWhere (string $column, mixed $value, array $options = [])

Lấy ra bản ghi của User được thêm vào gần đây nhất và theo điều kiện $column=$value

delete ($id)

Xóa bản ghi của User theo khóa chính

deleteWhere ($column, $value)

Xóa bản ghi của User theo điều kiện $column=$value

deleteWhereArray (array $clauses)

Xóa bản ghi của User theo một mảng các điều kiện được truyền vào ([$column1 => $value1, $column2 => $value2])

Tiêu chuẩn

Gói này tuân thủ PSR-1, PSR-2 và PSR-4. Nếu bạn nhận thấy giám sát tuân thủ, xin vui lòng gửi một bản vá thông qua yêu cầu kéo.

Giấy phép

Giấy phép MIT (MIT). Mời các bạn xem Giấy phép đăng ký để biết thêm thông tin.

ninhtqse / genie

Maintainers

Details