wearebraid/piction

此软件包最新版本(dev-master)没有提供许可证信息。

Piction API 库

dev-master 2018-11-12 21:15 UTC

This package is auto-updated.

Last update: 2024-09-29 04:20:25 UTC


README

注意:此版本处于测试模式,请勿在生产环境中使用

这是一个用于快速集成 Pictino 以更易用方式存储记录的软件包。

功能

安装

  1. 安装 composer 软件包:composer require wearebraid/piction
  2. 安装配置文件
php artisan vendor:publish --provider="Wearebraid\Piction\PictionServiceProvider"
  1. 将以下内容添加到您的 Laravel .env 文件中
PICTION_HOST=http://<your-host-here>/piction/
PICTION_USERNAME=username
PICTION_PASSWORD=password
  1. 将服务提供者和外观添加到您的应用的配置中:config/app.php
...
'providers' => [
	...
	Wearebraid\Piction\PictionServiceProvider::class,
	...
],
'aliases' => [
	...
	'Piction' => Wearebraid\Piction\Facades\Piction::class,
	...
],
...

基本配置设置

config/piction.php
  • host:此设置从 .env 文件中获取以设置 Piction 安装的宿主 URL
  • user:此设置从 .env 文件中获取以设置从 Piction 获取数据所需用户
  • pass:此设置从 .env 文件中获取以设置从 Piction 获取数据所需用户的密码
  • endpoint:默认为 !soap.jsonget,您通常不需要更改此设置,因为大部分功能都依赖于 Piction 返回的 JSON 数据。
  • use_scout:默认为 false。如果您选择使用 Laravel 的 Scout,则将其设置为 true。有关使用 Scout 和 Scout Record 类的更多详细信息,请参阅下文。
  • timeout:默认为 300,这是 Piction 调用在 Guzzle 超时之前将花费的秒数。

使用 Scout (您应该使用)

为什么使用 Scout?因为它是 棒极了! 按照以下 Scout 设置 操作。配置完成后,在 config/piction.php 中设置 'use_scout' => true

从那时起,您应将 Wearebraid\Piction\Models\Record 作为主要记录模型,切换到 Wearebraid\Piction\Models\Scout\Record

此模型扩展了普通记录模型,增加了 Searchable 函数以对记录进行索引以实现快速搜索。然后在控制器内部,您可以使用 Record::search('spiders')->paginate(20);

命令行脚本

  1. php artisan piction:collections 这是您将每天运行的主要脚本 将最新集合信息存储到数据库中,并添加任何新集合。这些记录还将跟踪集合的最后更新时间。从 Piction 中删除的集合将同时从数据库中删除以及该集合中的所有记录。此脚本还将
    1. 遍历每个集合,并请求每个集合的最新记录。
    2. 请求已删除的 UMO 并删除在 Piction 中不再存在的记录。
  2. php artisan piction:records collection_id 此命令将连接到 Piction 并检索自上次运行以来特定集合的 所有 记录。运行此脚本需要提供集合 ID。
  3. php artisan piction:deleted 由于 Piction 不支持 webhook,我们可以在每天获取最新的数据,但我们不知道什么被删除了。这就是此脚本的作用。它连接到 Piction,获取所有已删除 UMO 的列表,然后删除在数据库中找到的任何这些记录。