README

此PHP模块允许您只需几行代码即可将AFS Analytics仪表板嵌入您的管理界面。

安装

composer require afsanalytics/dashboard

需求

PHP >= 7.0

入门指南

简介

请注意，显示AFS Analytics仪表板的页面不应该是公开的——除非您希望您的统计数据是公开的。

显示仪表板

在页面上包含仪表板是通过创建一个容器元素，然后调用渲染方法来完成的。

print '<div id=my_custom_id></div>';

$db = new \AFSAnalytics\Dashboard\Controller( YOUR_API_KEY );
$db->setParentSelector('#my_custom_id')
   ->render()
;

运行Ajax服务器

除了插入显示仪表板的代码外，您还需要运行负责调用AFS Analytics REST API的ajax服务器。

这只需两行代码即可完成

$db = new \AFSAnalytics\Dashboard\Controller( YOUR_API_KEY );
$db->runAJAXServer();

此代码可以插入在同一页上，也可以在单独的页面上。在两种情况下，它必须在所有输出之前放置。

向Ajax服务器传递数据

为了确保Ajax服务器的安全性，您可能希望向所有Ajax调用添加一些自定义数据。

您可以通过javascript来实现这一点

AFSA.hook.prepareAjaxData = function (data) {
				data.my_property = my_value;
			};

获取API密钥

您可以在https://dev.afsanalytics.com创建API密钥

请注意，需要一个有效的AFS Analytics账户，包括API访问权限的订阅。

感兴趣的函数

setParentSelector($selector)

在指定的选择器内嵌入仪表板。

render( $options = [] )

返回仪表板的HTML代码。

$db ->setParentSelector('#my_custom_id')
    ->render([
        'css' => string // custom css to be inserted - optional
        ])

disableECommerce()

禁用所有与电子商务相关的报告。

setLanguage( $lng )

设置仪表板语言。

当前支持的$lng值: 'en', 'fr'

变更日志

请参阅项目变更日志

贡献

欢迎贡献。

支持

请通过电子邮件dev@afsanalytics.com联系。

许可

此软件包在MIT许可下发布。有关详细信息，请参阅附带LICENSE文件。

afsanalytics / dashboard

维护者

详细信息