Rummage Phoenix 使用教程

Rummage Phoenix 使用教程

rummage_phoenixFull Phoenix Support for Rummage. It can be used for searching, sorting and paginating collections in phoenix.项目地址:https://gitcode.com/gh_mirrors/ru/rummage_phoenix

项目介绍

Rummage Phoenix 是一个为 Phoenix 框架提供支持的框架，主要用于操作 Phoenix 集合和 Ecto 模型。它支持搜索、排序和分页功能，使得在 Phoenix 应用中处理数据集合变得更加简单和高效。

项目快速启动

安装

首先，将 rummage_phoenix 添加到你的 mix.exs 文件的依赖列表中：

def deps do
  [
    {:rummage_phoenix, "~> 1.2.0"}
  ]
end

然后运行以下命令来获取依赖：

mix deps.get

配置

在你的应用中配置 Rummage Phoenix。例如，在 router.ex 文件中添加以下配置：

use Rummage.Phoenix.Router

使用

在你的控制器中使用 Rummage 进行搜索、排序和分页。例如：

def index(conn, params) do
  {query, rummage} = MyApp.Product
                      |> Rummage.Ecto.rummage(params["rummage"])

  products = MyApp.Repo.all(query)
  render(conn, "index.html", products: products, rummage: rummage)
end

在视图中渲染分页链接：

<%= pagination_links(@conn, @rummage) %>

应用案例和最佳实践

搜索

使用 Rummage 进行搜索非常简单。你只需要在控制器中定义搜索参数，并在视图中渲染搜索表单。

def index(conn, params) do
  {query, rummage} = MyApp.Product
                      |> Rummage.Ecto.rummage(params["rummage"])

  products = MyApp.Repo.all(query)
  render(conn, "index.html", products: products, rummage: rummage)
end

排序

在视图中使用 sort_link 进行排序：

<th><%= sort_link(@conn, @rummage, "Name") %></th>
<th><%= sort_link(@conn, @rummage, "Price") %></th>
<th><%= sort_link(@conn, @rummage, "Category") %></th>

分页

在视图中渲染分页链接：

<%= pagination_links(@conn, @rummage) %>

典型生态项目

Kerosene

Kerosene 是一个与 Rummage 配合使用的分页库，可以进一步简化分页操作。

Scrivener

Scrivener 是另一个流行的分页库，也可以与 Rummage 结合使用，提供更灵活的分页功能。

通过这些生态项目，你可以进一步扩展 Rummage Phoenix 的功能，使其更符合你的应用需求。

rummage_phoenixFull Phoenix Support for Rummage. It can be used for searching, sorting and paginating collections in phoenix.项目地址:https://gitcode.com/gh_mirrors/ru/rummage_phoenix