Eloquent Viewable 开源项目安装与使用指南

Eloquent Viewable 开源项目安装与使用指南

eloquent-viewable Associate views with Eloquent models in Laravel 项目地址: https://gitcode.com/gh_mirrors/el/eloquent-viewable

项目概述

Eloquent Viewable 是一个专为 Laravel 设计的包，它允许开发者轻松地将页面查看次数与 Eloquent 模型关联起来。这在不需要依赖如 Google Analytics 这类第三方服务时特别有用，通过简单的接口实现模型视图统计功能。

目录结构及介绍

Eloquent Viewable 的项目结构旨在支持清晰的开发流程和易于维护。以下是关键文件夹和文件的简介：

• src: 包含核心逻辑，如处理视图关联的类。
• config: 存放配置文件，用于自定义包的行为。
• database/migrations: 提供了数据库迁移脚本，用于创建存储视图记录的数据表。
• tests: 测试套件，确保代码质量。
• README.md: 主要的说明文件，包含了快速入门和主要特性的描述。
• LICENSE: 许可证文件，指出项目遵循 MIT 协议。

启动文件介绍

虽然这个包没有传统意义上的“启动文件”，其核心入口点是通过 Laravel 的自动加载机制来实现的。当你安装并注册了服务提供者后，CyrildeWit\EloquentViewable\EloquentViewableServiceProvider，包的核心功能即被激活。具体到应用中，首次交互通常发生在尝试记录或查询模型视图次数的代码处。

配置文件介绍

安装后，你可以选择发布配置文件来定制行为：

php artisan vendor:publish --provider="CyrildeWit\EloquentViewable\EloquentViewableServiceProvider" --tag="config"

发布的配置文件通常位于 config/eloquent-viewable.php。此文件可能包括以下配置选项（实际选项以发布的配置为准）：

• viewable: 可能允许你指定默认的视图记录模型或其他特定配置。
• cache: 控制缓存策略，如何以及何时缓存视图计数。
• cooldown: 设置默认的冷却时间间隔，防止重复记录。
• ignore_crawlers: 列出的爬虫将不会计入视图统计内。

快速实战：基本设置与使用

1. 安装：通过 Composer 安装包。

   composer require cyrildewit/eloquent-viewable
   

2. 数据库准备：发布迁移并运行。

   php artisan vendor:publish --provider="CyrildeWit\EloquentViewable\EloquentViewableServiceProvider" --tag="migrations"
   php artisan migrate
   

3. 模型集成：让你的模型实现 CyrildeWit\EloquentViewable\Contracts\Viewable 并使用 InteractsWithViews 特性。

   use Illuminate\Database\Eloquent\Model;
   use CyrildeWit\EloquentViewable\InteractsWithViews;
   use CyrildeWit\EloquentViewable\Contracts\Viewable;
   
   class Post extends Model implements Viewable
   {
       use InteractsWithViews;
   }
   

4. 记录视图：在控制器中记录模型被查看的事件。

   use App\Models\Post;
   
   public function show(Post $post)
   {
       views($post)->record();
       return view('post.show', ['post' => $post]);
   }
   

记住，在集成过程中参考项目的官方文档和示例，以获得更详细的指引和高级功能的使用方法。

eloquent-viewable Associate views with Eloquent models in Laravel 项目地址: https://gitcode.com/gh_mirrors/el/eloquent-viewable