schulzefelix/laravel-stat-search-analytics

Laravel API Wrapper For STAT Search Analytics.

1.6.0 2020-04-12 19:49 UTC

This package is auto-updated.

Last update: 2024-09-13 06:03:35 UTC


README

Latest Version Software License Build Status Quality Score StyleCI Latest Version on Packagist Total Downloads

有关STAT Search Analytics的更多信息,请参阅https://getstat.com/

安装

此包可以通过Composer安装。

$ composer require schulzefelix/laravel-stat-search-analytics

在Laravel 5.5中,此包将自动注册服务提供者。在Laravel 5.4中,您必须安装此服务提供者。

// config/app.php
'providers' => [
    ...
    SchulzeFelix\Stat\StatServiceProvider::class,
    ...
];

在Laravel 5.5中,此包将自动注册外观。在Laravel 5.4中,您必须手动安装外观。

// config/app.php
'aliases' => [
    ...
    'Stat' => SchulzeFelix\Stat\StatFacade::class,
    ...
];

您可以使用此命令发布此包的配置文件

php artisan vendor:publish --provider="SchulzeFelix\Stat\StatServiceProvider"

使用方法

简介

此包的响应是Laravel Collections、每种数据对象的单个对象以及日期字段的Carbon实例的组合。

项目方法

列出所有项目

列表方法返回所有项目的集合。

$projects = Stat::projects()->list();

创建项目

要创建项目,只需传递项目的名称。响应将是一个StatProject实例。

$project = Stat::projects()->create('Cheese Cake Factory');

$project->toArray();

/*
[
    'id' => 615,
    'name' => 'Cheese Cake Factory',
    'total_sites' => 0,
    'created_at' => 2016-11-01,
    'updated_at' => 2016-11-01,
]
*/

更新项目

要更新项目的名称,只需传递项目ID和新名称。响应将是一个StatProject实例。

$project = Stat::projects()->update(615, 'Cheese Cake Bakery');

$project->toArray();

/*
[
    'id' => 615,
    'name' => 'Cheese Cake Bakery',
    'total_sites' => 5,
    'created_at' => 2016-11-01,
    'updated_at' => 2016-11-03,
]
*/

删除项目

要删除项目,只需传递项目ID。响应是项目ID。

$project = Stat::projects()->delete(615);

变更日志

有关最近更改的更多信息,请参阅CHANGELOG

测试

$ vendor/bin/phpunit

贡献

有关详细信息,请参阅CONTRIBUTINGCONDUCT

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件